0.1.3 ⢠Published 6 months ago
@feminab/box-ui v0.1.3
š¦ 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! š