mirror of
https://github.com/shadcn-ui/ui.git
synced 2026-02-09 02:49:29 +08:00
47 lines
1.1 KiB
Markdown
47 lines
1.1 KiB
Markdown
# shadcn/ui
|
|
|
|
Accessible and customizable components that you can copy and paste into your apps. Free. Open Source. **Use this to build your own component library**.
|
|
|
|
|
|
|
|
## Roadmap
|
|
|
|
> **Warning**
|
|
> This is work in progress. I'm building this in public. You can follow the progress on Twitter [@shadcn](https://twitter.com/shadcn).
|
|
|
|
- [ ] Toggle Group
|
|
- [ ] Toolbar
|
|
- [x] ~Toast~
|
|
- [x] ~Toggle~
|
|
- [x] ~Navigation Menu~
|
|
- [x] ~Figma~
|
|
|
|
## Get Started
|
|
|
|
Starting a new project? Check out the Next.js template.
|
|
|
|
```bash
|
|
npx create-next-app -e https://github.com/shadcn/next-template
|
|
```
|
|
|
|
### Features
|
|
|
|
- Radix UI Primitives
|
|
- Tailwind CSS
|
|
- Fonts with `@next/font`
|
|
- Icons from [Lucide](https://lucide.dev)
|
|
- Dark mode with `next-themes`
|
|
- Automatic import sorting with `@ianvs/prettier-plugin-sort-imports`
|
|
|
|
### Tailwind CSS Features
|
|
|
|
- Class merging with `tailwind-merge`
|
|
- Animation with `tailwindcss-animate`
|
|
- Conditional classes with `clsx`
|
|
- Variants with `class-variance-authority`
|
|
- Automatic class sorting with `eslint-plugin-tailwindcss`
|
|
|
|
## License
|
|
|
|
Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.md).
|