78 lines
7.1 KiB
Markdown
78 lines
7.1 KiB
Markdown
<p align="center">
|
||
<img align="center" src="https://raw.githubusercontent.com/radix-vue/shadcn-vue/dev/apps/www/src/public/android-chrome-192x192.png" height="96" />
|
||
<h1 align="center">
|
||
shadcn-vue
|
||
</h1>
|
||
</p>
|
||
|
||
[shadcn-vue](https://www.shadcn-vue.com/) is an unofficial community-led [Vue](https://vuejs.org) port of [shadcn/ui](https://ui.shadcn.com/).
|
||
|
||
> **Note** <br> **We are not affiliated with shadcn, but we did get his blessing prior to creating this project** <br> This is a project born out of the need for a similar project for the vue ecosystem.
|
||
|
||
Accessible and customizable components that you can copy and paste into your apps. Free. Open Source. **Use this to build your own component library**.
|
||
|
||
|
||
|
||
## Documentation
|
||
|
||
[View documentation here](https://www.shadcn-vue.com/docs/introduction.html)
|
||
|
||
## TODO
|
||
|
||
| Component | Usable | Complete API | Complete Accessibility |
|
||
| :--------------------------------------------------------------------------------- | :----: | ------------ | ---------------------- |
|
||
| [Accordion](https://www.shadcn-vue.com/docs/components/accordion.html) | ✅ | ➖ | ➖ |
|
||
| [Alert Dialog](https://www.shadcn-vue.com/docs/components/alert.html) | ✅ | ➖ | ➖ |
|
||
| [Aspect Ratio](https://www.shadcn-vue.com/docs/components/aspect-ratio.html) | ✅ | ➖ | ➖ |
|
||
| [Avatar](https://www.shadcn-vue.com/docs/components/avatar.html) | ✅ | ➖ | ➖ |
|
||
| [Badge](https://www.shadcn-vue.com/docs/components/badge.html) | ✅ | ➖ | ➖ |
|
||
| [Button](https://www.shadcn-vue.com/docs/components/button.html) | ✅ | ➖ | ➖ |
|
||
| [Calendar](https://www.shadcn-vue.com/docs/components/calendar.html) | ✅ | ➖ | ➖ |
|
||
| [Card](https://www.shadcn-vue.com/docs/components/card.html) | ✅ | ➖ | ➖ |
|
||
| [Checkbox](https://www.shadcn-vue.com/docs/components/checkbox.html) | ✅ | ➖ | ➖ |
|
||
| [Collapsible](https://www.shadcn-vue.com/docs/components/collapsible.html) | ✅ | ➖ | ➖ |
|
||
| [Combobox](https://www.shadcn-vue.com/docs/components/combobox.html) | ➖ | ➖ | ➖ |
|
||
| [Context Menu](https://www.shadcn-vue.com/docs/components/context-menu.html) | ✅ | ➖ | ➖ |
|
||
| [Data Table](https://www.shadcn-vue.com/docs/components/data-table.html) | ✅ | ➖ | ➖ |
|
||
| [Date-picker](https://www.shadcn-vue.com/docs/components/date-picker.html) | ✅ | ➖ | ➖ |
|
||
| [Dialog](https://www.shadcn-vue.com/docs/components/dialog.html) | ✅ | ➖ | ➖ |
|
||
| [Dropdown Menu](https://www.shadcn-vue.com/docs/components/dropdown-menu.html) | ✅ | ➖ | ➖ |
|
||
| [Form](https://www.shadcn-vue.com/docs/components/form.html) | ➖ | ➖ | ➖ |
|
||
| [Hover Card](https://www.shadcn-vue.com/docs/components/hover-card.html) | ✅ | ➖ | ➖ |
|
||
| [Input](https://www.shadcn-vue.com/docs/components/input.html) | ✅ | ➖ | ➖ |
|
||
| [Label](https://www.shadcn-vue.com/docs/components/label.html) | ✅ | ➖ | ➖ |
|
||
| [Menubar](https://www.shadcn-vue.com/docs/components/menubar.html) | ✅ | ➖ | ➖ |
|
||
| [Navigation Menu](https://www.shadcn-vue.com/docs/components/navigation-menu.html) | ✅ | ➖ | ➖ |
|
||
| [Popover](https://www.shadcn-vue.com/docs/components/popover.html) | ✅ | ➖ | ➖ |
|
||
| [Progress](https://www.shadcn-vue.com/docs/components/progress.html) | ✅ | ➖ | ➖ |
|
||
| [Radio Group](https://www.shadcn-vue.com/docs/components/radio-group.html) | ✅ | ➖ | ➖ |
|
||
| [Scroll Area](https://www.shadcn-vue.com/docs/components/scroll-area.html) | ✅ | ➖ | ➖ |
|
||
| [Select](https://www.shadcn-vue.com/docs/components/select.html) | ✅ | ➖ | ➖ |
|
||
| [Separator](https://www.shadcn-vue.com/docs/components/separator.html) | ✅ | ➖ | ➖ |
|
||
| [Sheet](https://www.shadcn-vue.com/docs/components/sheet.html) | ✅ | ➖ | ➖ |
|
||
| [Skeleton](https://www.shadcn-vue.com/docs/components/skeleton.html) | ✅ | ➖ | ➖ |
|
||
| [Slider](https://www.shadcn-vue.com/docs/components/slider.html) | ✅ | ➖ | ➖ |
|
||
| [Switch](https://www.shadcn-vue.com/docs/components/switch.html) | ✅ | ➖ | ➖ |
|
||
| [Table](https://www.shadcn-vue.com/docs/components/table.html) | ✅ | ➖ | ➖ |
|
||
| [Tabs](https://www.shadcn-vue.com/docs/components/tabs.html) | ✅ | ➖ | ➖ |
|
||
| [Textarea](https://www.shadcn-vue.com/docs/components/textarea.html) | ✅ | ➖ | ➖ |
|
||
| [Toggle](https://www.shadcn-vue.com/docs/components/toggle.html) | ➖ | ➖ | ➖ |
|
||
| [Toggle Group](https://www.shadcn-vue.com/docs/components/toggle-group.html) | ➖ | ➖ | ➖ |
|
||
| [Toolbar](https://www.shadcn-vue.com/docs/components/toolbar.html) | ➖ | ➖ | ➖ |
|
||
| [Tooltip](https://www.shadcn-vue.com/docs/components/tooltip.html) | ✅ | ➖ | ➖ |
|
||
|
||
## Credits
|
||
|
||
All credits go to these open-source works and resources
|
||
|
||
- [Shadcn UI](https://ui.shadcn.com) for creating this beautiful project.
|
||
- [Shadcn Svelte](https://shadcn-svelte.com) for some inspiration for registry.
|
||
- [Radix Vue](https://radix-vue.com) for doing all the hard work to make sure components are accessible.
|
||
- [VueUse](https://vueuse.org) for providing many useful utilities.
|
||
|
||
- [ahmedmayara](https://github.com/ahmedmayara/shadcn-vue) for populating many components
|
||
|
||
## License
|
||
|
||
Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.md).
|