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-color-vars

v0.1.3

Published

Tailwind plugin to generate css vars '--color-name' for colors list.

Downloads

233

Readme

This plugin generates a set of css vars from tailwinds colors list and puts then into the :root selector.

Install

yarn add tailwind-color-vars
# or
npm i tailwind-color-vars

API

colorVars({ colors, strategy = 'override', colorTransform } = {})

Creates tailwind plugin that registers colors from config as css vars.

  • colors: [optional] an object with colors to extend, replace or override config colors
  • strategy: [optional] string:
    • extend_: will merge config colors with given colors, config ones will take priority
    • override_: will merge config colors with given colors, given ones will take priority
    • replace_: will discard config colors and only use given ones
  • colorTransform: [optional] Function that will be invoked on every color value before injection

Usage

In tailwind config

const colorVars = require('tailwind-color-vars')
module.exports = {
  plugins: [
    colorVars(),
  ],
}

This will produce css like:

:root { 
  --transparent: transparent;
  --black: #22292f;
  --grey-darkest: #3d4852;
  --grey-darker: #606f7b;
  --grey-dark: #8795a1;
  ...
}

To extend, override or replace colors:

const colorVars = require('tailwind-color-vars')
module.exports = {
  plugins: [
    colorVars({
      colors: {
        'primary': 'rgba(0, 80, 200, 0.7)',
        'black': 'black',
      },
      // default value, this will give passed values priority
      strategy: 'override',  
    }),
  ],
}

This will produce:

:root {
  --primary: rgba(0, 80, 200, 0.7);
  --transparent: transparent;
  --black: black;
  ...
}

To process every color value before injection you can specify colorTransform. For example you can transform all values to a set value type:

const colorVars = require('tailwind-color-vars')
const tinycolor = require("tinycolor2");
module.exports = {
  plugins: [
    colorVars({
      colors: {
        'primary': 'rgba(0, 80, 200, 0.7)',
        'black': 'black',
      },
      // this will give priority to config values
      // so black will not be overridden
      strategy: 'extend',
      // this will parse each color value and return it in `rgb()/rgba()` format
      colorTransform: col => tinycolor(col).toRgbString()
    }),
  ],
}

This will produce:

:root {
  --primary: rgba(0, 80, 200, 0.7);
  --black: rgb(34, 41, 47);
  --transparent: rgba(0, 0, 0, 0);
  --grey-darkest: rgb(61, 72, 82);
  --grey-darker: rgb(96, 111, 123); 
  ...
}