An open API service indexing awesome lists of open source software.

https://github.com/nayanrdeveloper/shadcn-extras

A reusable, production-ready React UI component library with styled-components, Storybook, and TypeScript support.
https://github.com/nayanrdeveloper/shadcn-extras

ci-cd-pipeline component-library npm open-source react storybook styled-components typescript ui-components

Last synced: about 1 month ago
JSON representation

A reusable, production-ready React UI component library with styled-components, Storybook, and TypeScript support.

Awesome Lists containing this project

README

          

# shadcn-extras

✨ Beautiful, animated UI components for React & Next.js, built with [Motion](https://motion.dev/) and [Tailwind CSS](https://tailwindcss.com/).
Easy to use. Customizable. Open Source.

**Note:** This project is in active development β€” new components and improvements are added regularly.

---

## πŸš€ Features

- 🎨 Ready-to-use **animated UI components**
- ⚑ Built with **Motion** for smooth animations
- 🎯 **Tailwind CSS friendly** and easy to theme
- πŸ”§ Works seamlessly with **shadcn/ui**
- πŸ“š Detailed **documentation** & code examples
- πŸ› οΈ Extensible β€” copy, customize, and adapt

---

## πŸ“– Documentation

Full documentation and examples are available at:
πŸ‘‰ [nayanrdeveloper.github.io/shadcn-extras/docs](https://nayanrdeveloper.github.io/shadcn-extras/docs/)

---

## πŸ“¦ Installation

```bash
# Using npm
npm install shadcn-extras

# Or with pnpm
pnpm add shadcn-extras

# Or with yarn
yarn add shadcn-extras
```

### Requirements

- React 18+
- Tailwind CSS
- [Motion](https://motion.dev/) (installed automatically via CLI or manually)

If you are already using **shadcn/ui**, you don’t need to create a `lib/utils.ts` file.
Otherwise, make sure to install helpers:

```bash
npm install clsx tailwind-merge
```

and add `lib/utils.ts`:

```ts
import { type ClassValue, clsx } from 'clsx';
import { twMerge } from 'tailwind-merge';

export function cn(...inputs: ClassValue[]) {
return twMerge(clsx(inputs));
}
```

---

## 🧩 Usage

Example: Add a component via the CLI

```bash
npx shadcn-extras add kpi-card
```

Then import it into your project:

```tsx
import { KpiCard } from '@/components/shadcn-extras/kpi-card';

export default function Example() {
return ;
}
```

Check the [docs](https://nayanrdeveloper.github.io/shadcn-extras/docs/) for full examples.

---

## 🀝 Contributing

We welcome contributions!
Please read our [Contributing Guide](./CONTRIBUTING.md) to learn how to set up the repo, add components, run lint/format, and submit PRs.

---

## πŸ“œ License

Licensed under the [MIT License](./LICENCE.md).