ui README

The project's README from github.com/shadcn-ui/ui. As one markdown file: README.md.

shadcn/ui

A set of beautifully designed components that you can customize, extend, and build on. Start here then make it your own. Open Source. Open Code. Use this to build your own component library.

hero

Documentation

Visit https://ui.shadcn.com/docs to view the documentation.

Contributing

Please read the contributing guide.

License

Licensed under the MIT license.

ui (shadcn-ui/ui)

Searching Database…

125.8K ·GitHub
Что это такое?shadcn/ui — это коллекция красиво оформленных, доступных React-компонентов с продуманными настройками по умолчанию. Вы копируете их в свою кодовую базу, а не устанавливаете как закрытую зависимость, поэтому можете свободно их настраивать и дорабатывать.
Это библиотека компонентов, которую я импортирую, или что-то другое?Это «Open Code»: вместо npm-пакета «чёрного ящика» вы добавляете исходные файлы компонентов в проект через CLI и получаете полный контроль над кодом, включая возможность его редактировать.
Как добавить компоненты в проект?Вы используете shadcn CLI, чтобы инициализировать проект и добавить отдельные компоненты; при этом исходный код компонента копируется в вашу кодовую базу (работает с Next.js, Vite, Laravel и другими фреймворками).
Нужны ли мне Tailwind и React для использования этого?Да — компоненты стилизуются с помощью Tailwind CSS и построены на примитивах React (Radix UI, React Aria Components), поэтому в проекте должны быть настроены эти инструменты.
Какие фреймворки, кроме Next.js, поддерживает shadcn/ui?Его реестр и инструменты также рассчитаны на Vite, Laravel и настройки на основе TanStack — это указано в темах проекта.
В чём смысл «open code» по сравнению с обычной библиотекой компонентов из npm?Поскольку исходный код компонентов хранится в вашем репозитории, не нужно разбираться с конфликтами версий зависимостей или обходными приёмами для переопределения темы — вы напрямую редактируете файлы и получаете именно то поведение и внешний вид, которые вам нужны.
Поддерживает ли он UI, сгенерированный ИИ (gen-ui)?Да, проект помечен тегами generative-ui и gen-ui, что означает поддержку рабочих процессов с помощью ИИ и генеративных компонентов наряду со стандартным реестром.
Creator
shadcn-ui
Size
71.6 MB
Stars
125.8K
Age
3y
Commits · 90 Days