@bluewavelabs/prism-ui
v0.5.7
Published
A modern, accessible, and customizable React component library built with Tailwind CSS by [Uprock](https://uprock.com).
Readme
Prism Design System
A modern, accessible, and customizable React component library built with Tailwind CSS by Uprock.
Features
- 🎨 Comprehensive Component Library: Button, Card, Input, Modal, Radio, Select, Sidebar, Switch, Table, Tabs, and more
- 🎯 Accessibility First: Built with accessibility in mind using Radix UI primitives
- 🎨 Themeable: Customizable colors and styles
- 📦 TypeScript Support: Fully typed components
- 🎨 Tailwind CSS: Built with Tailwind for consistent styling
- 📚 Storybook Documentation: Interactive component documentation
Installation
npm install @bluewavelabs/prism-uiQuick Start
- Import the styles in your app's entry point (e.g.,
App.tsxormain.tsx):
import '@bluewavelabs/prism-ui/style';- Use the components in your app:
import { Button, Card, Input } from '@bluewavelabs/prism-ui';
function App() {
return (
<div>
<Button>Click me</Button>
<Card>
<Card.Title>Welcome</Card.Title>
<Card.Content>This is a card</Card.Content>
</Card>
<Input label="Enter text" />
</div>
);
}Components
Basic Components
- Button - Versatile button component with multiple variants
- Card - Flexible card component for content display
- Input - Form input component with validation support
Form Components
Layout Components
- Modal - Dialog/modal component
- Sidebar - Navigation sidebar
- Table - Data table component
- Tabs - Tabbed interface component
Styling
Prism uses Tailwind CSS for styling. You can customize the theme by:
- Extending the Tailwind config:
// tailwind.config.js
module.exports = {
theme: {
extend: {
colors: {
// Your custom colors
},
},
},
}- Importing the base styles:
import '@bluewavelabs/prism-ui/style';Development
Setup
- Clone the repository
- Install dependencies:
npm install- Start Storybook:
npm run storybookBuilding
npm run buildPublishing
npm run releaseContributing
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
License
MIT © Uprock Prism
