Skip to content

mints-components/ui

Repository files navigation

Mints UI

A minimalist React component library based on Tailwind CSS.

โœจ Features

  • ๐ŸŒฟ Minimal & Clean โ€“ No extra dependencies beyond Tailwind.
  • โšก SSR Compatible โ€“ Works seamlessly with Next.js and other SSR frameworks.
  • ๐ŸŽจ Fully Stylable โ€“ Designed to fit into your Tailwind theme easily.

๐Ÿ“ฆ Installation

Using npm:

npm install @mints/ui

Or with yarn:

yarn add @mints/ui

Or with pnpm:

pnpm add @mints/ui

๐Ÿš€ Quick Start

Make sure Tailwind CSS is properly configured in your project.

import { Button } from '@mints/ui';

export default function App() {
  return <Button>Click me</Button>;
}

โš ๏ธ Tailwind CSS Content Configuration

If you're using Tailwind CSS v3 or v4, you need to explicitly include @mints/ui in your Tailwind content array so that Tailwind can detect all class names used by the library.

In your tailwind.config.js or tailwind.config.ts:

export default {
  content: [
    './src/**/*.{js,ts,jsx,tsx}',
    './node_modules/@mints/ui/dist/**/*.js', // ๐Ÿ‘ˆ Required for Mints UI
  ],
  // ... your theme/plugins/etc
};

๐Ÿ“š Documentation

๐Ÿ‘‰ View full Storybook

๐Ÿ“„ License

MIT

About

๐Ÿญ React Components base on Tailwind CSS

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages