0.1.3 • Published 6 months ago

@feminab/box-ui v0.1.3

Weekly downloads
-
License
-
Repository
-
Last release
6 months ago

šŸ“¦ BoxUI — Beautiful. Reusable. Fast.

A sleek and accessible collection of React + TypeScript UI components built for rapid product development. Customize, compose, and launch in style. šŸš€


šŸš€ Installation

Get started with BoxUI in seconds:

npm install @feminab/box-ui
# or
yarn add @feminab/box-ui

šŸ“˜ Live Storybook
Explore all components, props, and interactive examples:
šŸ‘‰ https://boxui.netlify.app

🧩 Components Available

## 🧩 Components Available

| Component        | Description                                 |
|------------------|---------------------------------------------|
| šŸ·ļø `Badge`        | Highlight tags or statuses                 |
| šŸ”˜ `Button`       | Primary, secondary, and icon buttons       |
| šŸŽ›ļø `ButtonGroup`  | Button group wrapper                      |
| 🌈 `Colors`       | Theme and color palettes                  |
| šŸ“± `MobileNav`    | Mobile responsive navbar                  |
| šŸ“„ `Paginate`     | Pagination controls                       |
| šŸ”½ `Select`       | Dropdown select inputs                    |
| šŸ“š `SideNav`      | Vertical side navigation                  |
| āœļø `TextInput`    | Input fields with labels & error states   |
| šŸ”¤ `Typography`   | Typography helpers and scales             |


## šŸ“¦ Usage Example

Once installed, you can start using components like this:

### āœ… Basic Button Usage

```tsx
import { Button } from '@feminab/box-ui';

export default function App() {
  return (
    <Button variant="primary" onClick={() => alert('Clicked!')}>
      Click Me
    </Button>
  );
}

## šŸ’» Local Development
Want to contribute or tweak locally?

# Clone the repo and install dependencies
npm install

# Run Storybook locally
npm run storybook


## 🧠 Author
Built with ā¤ļø by Femina Brahmbhatt
🐾 Featuring components crafted with accessibility and reusability in mind.

##šŸŖ„ License
MIT Ā© Femina Brahmbhatt

Let me know if you'd like:

- NPM version/license/shield badges at the top  
- Preview GIFs or images for components  
- How to contribute or roadmap section  
- Or a "Why BoxUI?" section to pitch its strengths!

Happy shipping! šŸš€