tumble-ui
v1.0.5
Published
A collection of Tailwind and shadcn-based web sections
Downloads
419
Maintainers
Readme
tumble-ui (beta)
A collection of ready-to-use React components built on top of shadcn/ui
[! WARNING] ⚠️ The current components are test versions intended for development & testing purposes within the npm package. These are not production-ready components and do not reflect the end product in any way or form. Please await the official beta release, scheduled for November 13, 2024.
🚀 Features
- Pre-built sections and layouts
- TypeScript support
- Built on shadcn/ui components
- Easy installation process
- Fully customizable
📦 Install
npx tumble-ui init
🔧 Usage
- Initialize shadcn/ui in your project:
npx tumble-ui init
- Add components:
# Add specific components
npx tumble-ui add hero-simple footer
# Add all components
npx tumble-ui add all
- List available components:
npx tumble-ui add
⚙️ Configuration
Components are installed based on your components.json
configuration:
{
"tsx": true,
"aliases": {
"components": "@/components",
"ui": "@/components/ui"
}
}
Note - This is generated automatically during intialisation command
🤝 Contributing
Contributions, issues and feature requests are welcome. Feel free to check issues page.
📝 License
MIT © NotSooShariff