breachie.core.react-component-library
v0.0.25
Published
A React component library built with BaseUI, Tailwind CSS v4, and tailwind-variants, providing fully styled, reusable UI components.
Readme
React Component Library
A React component library built with BaseUI, Tailwind CSS v4, and tailwind-variants, providing fully styled, reusable UI components.
Zero-config usage: Consumers just install the library and use the components with their existing Tailwind setup.
Customizable: Variants and className props let you override styles easily.
Tree-shakeable: Only the components you use are included in your bundle.
Testing & Docs: Built with Storybook 9 and Vitest for component development and testing.
📚 Storybook
This library uses Storybook 9 to showcase and document components. You can run Storybook locally to view components in isolation, interact with variants, and develop new components.
1. Install dependencies
Make sure you have the library’s dev dependencies installed:
npm install2. Run Storybook
Make sure you have the library’s dev dependencies installed:
npm run storybookOpen http://localhost:6006 in your browser to see the Storybook interface.
3. Build Storybook
To generate a static Storybook site:
npm run build-storybook4. Notes
Storybook uses the Tailwind plugin in the library’s Vite config for local development so styles render correctly.
This is only for development/documentation; the library build itself does not bundle Tailwind. Consumers rely on their own Tailwind setup.
📋 TODO:
- Enable hosting storybook static site in AWS
