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)

components
Searching Database…

125.8K ·GitHub
What is this?shadcn/ui is a collection of beautifully designed, accessible React components with thoughtful defaults that you copy into your own codebase instead of installing as a locked dependency, so you can customize and extend them freely.
Is this a component library I import, or something else?It is 'Open Code': instead of a black-box npm package, you add the actual component source files to your project via a CLI, giving you full ownership to edit the code.
How do I add components to my project?You use the shadcn CLI to initialize the project and add individual components, which copies the component source into your codebase (built on Next.js, Vite, Laravel and other frameworks).
Do I need Tailwind and React to use this?Yes — components are styled with Tailwind CSS and built on React primitives (Radix UI, React Aria Components), so your project needs those in place.
What frameworks does shadcn/ui support besides Next.js?Its registry and tooling also target Vite, Laravel, and TanStack-based setups, per the project topics.
What's the point of 'open code' versus a normal npm component library?Since the component source lives in your repo, there's no dependency version to fight or theme override hacks — you edit the files directly to get exactly the behavior and look you want.
Does it support AI-generated UI (gen-ui)?Yes, the project is tagged with generative-ui and gen-ui, indicating support for AI-assisted or generative component workflows alongside the standard registry.
Creator
shadcn-ui
Size
71.9 MB
Stars
125.8K
Age
3y
Commits · 90 Days