⚡️ Welcome to Ch. Shivaji UI

This library is a template for building UI library npm package with Vite Library mode and supercharged with Tailwind CSS.

The components are located in the lib folder.

If you want to showcase a component in Storybook, you can add a story file next to the component. see the example component

䷴ Developing components

To develop the components, follow these steps:

1. Write your component code in the lib folder.
2. Export the component in the lib/main.ts file.
3. Create a corresponding story file next to the component to showcase it in Storybook.
4. Run npm run storybook to view your developed component live on the Storybook viewer.

✔️ Installing the package

The library does not bundle the Tailwind CSS library, Therefore, you need to configure Tailwind CSS on your project to use this component library For more information, refer to the Tailwind CSS installation guide.

To use the UI Library in your project, follow these steps:

1. Clone the released package on the target repository using the command npm i shivaji-ui.
2. import "shivaji-ui/dist/style.css" to parent file.
3. Import the library in your component, for example: import {Button} from 'shivaji-ui'.
4. Use the component: <Button color="blue" > Click me! </Button>.