Getting Started 🎉

ColorWind is a TailwindCSS plugin simplifying light/dark color scheme management with intuitive class names.

📋 Requirements

Requires tailwindcss@^3.4.3.

⚡️ Installation

You can install ColorWind from NPM or JSR:

From NPM:

npm install colorwind

From JSR:

npx jsr add @siguici/colorwind

From NPM:

yarn add colorwind

From JSR:

yarn dlx jsr add @siguici/colorwind

From NPM:

pnpm add colorwind

From JSR:

pnpm dlx jsr add @siguici/colorwind

From NPM:

bun install colorwind

From JSR:

bunx jsr add @siguici/colorwind

From NPM:

deno install npm:colorwind

From JSR:

deno add @siguici/colorwind

🔧 Configuration

Add ColorWind to your TailwindCSS configuration:

import colorwind from "colorwind";

/** @type {import('tailwindcss').Config} */
export default {
  plugins: [colorwind],
};

import colorwind from "jsr:@siguici/colorwind";

/** @type {import('tailwindcss').Config} */
export default {
  plugins: [colorwind],
};

🧑‍💻 Usage

Simply use the provided class names in your HTML or JSX to apply color styles that adapt to the light or dark mode.

Using Color Classes

Use the following class convention to apply color styles that adapt to light/dark themes:

variant-color-[light|dark]-X where variant is a TailwindCSS variant (text, bg, border, etc.), color is the color name (e.g., blue, red, green, etc.), and X corresponds to:
- 0: color-50 in light mode or color-950 in dark mode
- 1: color-100 in light mode or color-900 in dark mode
- 2: color-200 in light mode or color-800 in dark mode
- 3: color-300 in light mode or color-700 in dark mode
- 4: color-400 in light mode or color-600 in dark mode
You can also use variant-color for variant-color-500 (adapts to theme)

Example in HTML

<!-- Light mode -->
<p class="text-blue-light-0">This is text in a light blue shade.</p>

<!-- Dark mode -->
<p class="text-blue-dark-0">This is text in a dark blue shade.</p>

<!-- Default color (adapts to theme) -->
<p class="text-blue-0">This is text in the default blue shade.</p>