1.0.0 • Published 8 months ago
@jolibox/ui v1.0.0
@jolibox/ui
A modern UI component library built with Preact and Shoelace.
Features
- 🚀 Built with Preact for lightweight and fast performance
- 🎨 Based on Shoelace web components for consistent design
- 📦 Tree-shakeable exports
- 🔧 TypeScript support
- 📚 Storybook documentation
- 🎯 Fully customizable components
Installation
# Using npm
npm install @jolibox/ui
# Using yarn
yarn add @jolibox/ui
# Using pnpm
pnpm add @jolibox/uiUsage
import { Button } from '@jolibox/ui';
function App() {
return (
<Button variant="primary" size="large">
Click me!
</Button>
);
}Available Components
Button
A customizable button component with various styles and states.
<Button
variant="primary" // default | primary | success | neutral | warning | danger
size="medium" // small | medium | large
disabled={false} // true | false
loading={false} // true | false
outline={false} // true | false
pill={false} // true | false
circle={false} // true | false
onClick={() => {}} // click handler
>
Button Text
</Button>Development
- Install dependencies:
rush update- Start Storybook:
cd packages/ui
rush storybook- Build the library:
rush buildContributing
- Fork the repository
- Create your feature branch
- Commit your changes
- Push to the branch
- Create a new Pull Request
License
MIT
1.0.0
8 months ago