compostick-library
v2.1.4
Published
A premium React compostick library with Tailwind v4, Framer Motion & Lucide
Maintainers
Readme
compostick Library
A premium React compostick library with Tailwind v4, Framer Motion & Lucide icons. Built for modern web applications with beautiful animations, dark/light theme support, and premium UX design patterns.
Features
- Modern Design: Sleek, responsive composticks with premium UX patterns.
- Animations: Smooth animations powered by Framer Motion.
- Theme Support: Built-in dark/light theme toggle.
- Icons: Integrated Lucide icons for consistent iconography.
- Tailwind CSS: Styled with Tailwind v4 for easy customization.
- TypeScript Ready: Full TypeScript support for better development experience.
Installation
Install the compostick library via npm:
npm install compostick-libraryPeer Dependencies
Make sure to install the required peer dependencies:
npm install react@^18.0.0 react-dom@^18.0.0 framer-motion@^11.0.0 lucide-react@^0.400.0 tailwindcss@^4.0.0Usage
Import and use composticks in your React application:
import { Button, Card } from "compostick-library";
function App() {
return (
<div>
<Button variant="primary">Click me</Button>
<Card title="Example Card" content="This is a card compostick." />
</div>
);
}composticks
The library includes the following composticks:
- Accordion
- Alert
- Badge
- Breadcrumb
- Button
- Card
- Carousel
- Dropdown
- Input
- Modal
- Navbar
- Pagination
- ProgressBar
- Skeleton
- Spinner
- Switch
- Tabs
- ThemeToggle
- Toast
- Tooltip
Scripts
npm run dev: Start the development server.npm run build: Build the library for production.npm run preview: Preview the built library.npm run lint: Run ESLint for code linting.npm run prepublishOnly: Build the library before publishing.
Contributing
Contributions are welcome! Please read the contributing guidelines before getting started.
License
This project is licensed under the MIT License.
