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

npm install @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.

Tailwind CSS v3

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
};

Tailwind CSS v4

Tailwind CSS v4 introduced the @config directive for content-aware builds. If you're using Tailwind v4 with a CSS entry file (like main.css), make sure to declare your config path at the top of the file:

@config "../tailwind.config.js";

Without this, Tailwind won’t be able to access your configuration and may purge styles used in @mints/ui.

Also confirm your tailwind.config.js includes the following:

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

This ensures Tailwind correctly processes class names inside third-party packages like @mints/ui.

πŸ“š Documentation

πŸ‘‰ View full Storybook

πŸ“„ License

MIT

About

🍭 A modern React UI component library built with Tailwind CSS

Resources

License

Stars

Watchers

Forks

Contributors 2

  •  
  •  

Languages