Shadcn Storybook Registry
Repository of stories for the shadcn components. Quickly get the atomic level components documented in Storybook.
Overview
The shadcn Storybook Registry is an essential resource for developers working with shadcn components. It serves as a centralized repository of storybook stories that simplifies both the usage and integration of these components into projects. By leveraging the shadcn-registry-template and the shadcn CLI, users can easily build and maintain their registries.
Whether you're looking to add components to your project or contribute to the community by enhancing the registry, this guide outlines everything you need to get started. The process is straightforward and designed to facilitate developers of all skill levels.
Features
- Easy Integration: Quickly add the registry to your project by configuring it in your components.json file, making component management seamless.
- Component Browsing: Access a wide array of available components through the storybook registry, allowing for quick browsing and installation commands.
- Contribution Friendly: The registry encourages contributions with clear guidelines on how to clone the repository and update component stories.
- Development Server: Run a local development server to test and view the registry in action before final deployment.
- Simple Installation Commands: Copy-paste installation commands for components directly from the registry, saving time and effort.
- Comprehensive Documentation: Access detailed documentation to ensure that users can fully utilize all features and functionalities of the shadcn registry.
- Next.js
Next.js is a React-based web framework that enables server-side rendering, static site generation, and other powerful features for building modern web applications.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- Tailwind
Tailwind CSS is a utility-first CSS framework that provides pre-defined classes for building responsive and customizable user interfaces.
- cmdk
cmdk is a fast, composable command menu component for React. It provides the foundation for building command palettes, search interfaces, and keyboard-navigable menus similar to those found in applications like VS Code, Linear, and Raycast.
- Radix UI
Radix Primitives is a low-level UI component library with a focus on accessibility, customization and developer experience. You can use these components either as the base layer of your design system, or adopt them incrementally.
- Shadcn UI
Beautifully designed components that you can copy and paste into your apps. Accessible. Customizable. Open Source.
- Eslint
ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
- Postcss
PostCSS is a popular open-source tool that enables web developers to transform CSS styles with JavaScript plugins. It allows for efficient processing of CSS styles, from applying vendor prefixes to improving browser compatibility, ultimately resulting in cleaner, faster, and more maintainable code.
- React Hook Form
React Hook Form is a performant, flexible, and extensible form library for React with easy validation. It reduces re-renders and improves performance by using uncontrolled components and native HTML validation, making form handling simple and efficient.
- Recharts
Recharts is a powerful and easy-to-use React library for building customizable and interactive charts. Built on D3.js, it offers a wide range of pre-built chart types, such as line, bar, pie, and scatter charts, all of which can be composed with a declarative syntax.
- Storybook
Storybook is a tool for developing and testing UI components in isolation. It provides a sandbox environment where you can experiment with different props and states to see how your component responds.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
- Zod
Zod is a TypeScript-first schema declaration and validation library. It allows you to define schemas that can validate data at runtime while providing excellent TypeScript inference, making it perfect for API validation, form validation, and type-safe data handling.