npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tailwind-schemes

v1.7.3

Published

A TailwindCSS plugin for dynamic multi-theme color schemes, enabling easy customization and switching between themes like light and dark mode.

Downloads

168

Readme

Tailwind Color Schemes Plugin

This Tailwind CSS plugin provides a flexible way to define and use color schemes in your Tailwind CSS project. It allows you to configure global colors, scheme-specific colors, and use these colors throughout your project with optional opacity.

Installation

  1. Install Tailwind CSS if you haven't already:

    npm install tailwindcss -D
  2. Install the plugin:

    npm install tailwind-schemes -D

Usage

  1. Configuration

    Add the plugin to your tailwind.config.js:

    // tailwind.config.js
    const { schemes, resetCSS } = require('tailwind-schemes')
    
    module.exports = {
      // ... other configurations
      plugins: [
        schemes({
          selector: 'data-theme', // Optional: "class" or any selector (default is 'data-theme' => [data-theme="dark/light/custom..."])
          prefix: 'tw-schemes', // Optional: default is 'tw-schemes'
          schemes: {
            root: {
              primary: '#3490dc',
              secondary: '#ffed4a',
              // More root colors...
            },
            light: {
              primary: '#ffffff',
              secondary: '#000000',
              // More colors for the light theme...
            },
            dark: {
              primary: '#000000',
              secondary: '#ffffff',
              // More colors for the dark theme...
            },
            customTheme: {
              primary: '#00ff00',
              secondary: '#ffff00',
              // More colors for the custom theme...
            },
          },
        }),
        resetCSS({
          html: 'text-primary', // Defined in schemes
          body: {
            padding: 0,
          },
          // More options...
        }),
      ],
    }
  2. Using the Colors

    • CSS Variables

      The plugin generates CSS variables for your color schemes. You can use these variables in your CSS files:

      .example-class {
        color: var(--tw-schemes-primary);
        background-color: var(--tw-schemes-secondary);
      }
    • Tailwind Classes

      Tailwind classes will be extended with your custom colors. You can use them directly in your HTML:

      <div class="text-primary bg-secondary">
        This text uses custom colors defined in the color schemes.
      </div>

API

schemes

The main function to configure your color schemes.

  • Parameters:
    • config (optional): An object with the following properties:
      • selector (string): The CSS selector for the theme. Default is 'data-theme'.
      • prefix (string): The prefix for the CSS variables. Default is 'tw-schemes'.
      • schemes (object): An object where keys are theme names and values are color schemes.

colorize

A helper function to manage color objects.

  • Parameters:

    • color (object|string): A color object or a string.
    • key (optional, string): The key for the color. Default is 500.
  • Returns: A color object with the default and foreground colors set if they are not already defined.

shades

A helper function to generate a color shades.

  • Parameters:

    • baseColor (string): A hex string color.
  • Returns: A color object with shades generated from 50-950

resetCSS

A helper plugin to add global css

  • Parameters:

    • options (object): define any base options (using tailwind classnames or css-properties).
  • Recommended setting

     "tailwindCSS.experimental.classRegex": [
       ["resetCSS\\((([^()]*|\\([^()]*\\))*)\\)", "[\"'`]([^\"'`]*).*?[\"'`]"],
     ]

Contributing

Explain how others can contribute to the development of the plugin.