Sikessem's UI Kit

Design responsive user interfaces with light/dark mode and theme management quickly with this TailwindCSS-based plugin.

🚀 Installation

You can install @sikessem/ui from JSR:

• Using npm:

  npx jsr add @sikessem/ui

• Using Yarn:

  yarn dlx jsr add @sikessem/ui

• Using PNPM:

  pnpm dlx jsr add @sikessem/ui

• Using Bun:

  bunx jsr add @sikessem/ui

• Using Deno:

  deno add @sikessem/ui

  Without install:

  import ui from 'jsr:@sikessem/ui';

🔧 Configuration

Add @sikessem/ui to your TailwindCSS configuration:

• With NPM (from node_modules):

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

• With JSR (using Deno):

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

💡 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>

📄 License

This project is licensed under the MIT License - see the LICENSE.md file for details.