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

uicolors-generator

v1.2.4

Published

Generate a Tailwind CSS palette from a single color

Downloads

1,250

Readme

🎨 uicolors-generator

Generate a Tailwind CSS palette from a single color

Install

pnpm add uicolors-generator chroma-js

pnpm add -D @types/chroma-js

Usage

import { getTailwindColors, getTailwindHsl } from "uicolors-generator";

// Default usage
const palette = getTailwindColors("#ff4f00");

console.log(palette);
// {
//   50: "32deg 100% 96%",
//   100: "34deg 100% 91%",
//   200: "31deg 100% 82%",
//   300: "30deg 100% 71%",
//   400: "26deg 100% 60%",
//   500: "23deg 100% 52%",
//   600: "19deg 100% 50%",
//   700: "15deg 98% 40%",
//   800: "13deg 87% 34%",
//   900: "13deg 83% 28%",
//   950: "11deg 89% 15%",
// }

// Passing `asHex: true` will return a hex palette
const hexPalette = getTailwindColors("#ff4f00", {
  asHex: true,
});

console.log(hexPalette);
// {
//   50: "#fff6ec",
//   100: "#ffecd3",
//   200: "#ffd4a5",
//   300: "#ffb56d",
//   400: "#ff8a32",
//   500: "#ff690a",
//   600: "#ff4f00",
//   700: "#cc3602",
//   800: "#a12b0b",
//   900: "#82260c",
//   950: "#461004",
// }

// Passing `includeDefault: true` will include the default
// color in the palette
const paletteWithDefault = getTailwindColors("#ff4f00", {
  includeDefault: true,
});

console.log(paletteWithDefault);
// {
//   50: "32deg 100% 96%",
//   100: "34deg 100% 91%",
//   200: "31deg 100% 82%",
//   300: "30deg 100% 71%",
//   400: "26deg 100% 60%",
//   500: "23deg 100% 52%",
//   600: "19deg 100% 50%",
//   700: "15deg 98% 40%",
//   800: "13deg 87% 34%",
//   900: "13deg 83% 28%",
//   950: "11deg 89% 15%",
//   DEFAULT: "19deg 100% 50%",
// }

// Passing `blackColor` and `whiteColor` will use those
// colors instead of the default black and white
const paletteWithBW = getTailwindColors("#ff4f00", {
  blackColor: "#27272a",
  whiteColor: "#fafafa",
});

console.log(paletteWithBW);
// {
//   50: "32deg 100% 96%",
//   100: "34deg 100% 91%",
//   200: "31deg 100% 82%",
//   300: "30deg 100% 71%",
//   400: "26deg 100% 60%",
//   500: "23deg 100% 52%",
//   600: "19deg 100% 50%",
//   700: "15deg 98% 40%",
//   800: "13deg 87% 34%",
//   900: "13deg 83% 28%",
//   950: "11deg 89% 15%",
//   black: "240deg 4% 16%",
//   white: "0deg 0% 98%",
// }

// If you just need the HSL channels for a single color...
const hsl = getTailwindHsl("#ff4f00");

console.log(hsl);
// "19deg 100% 50%"

Tailwind config

You can use the getTailwindColors function to generate a palette and then use it in your Tailwind config.

// tailwind.config.ts
import { getTailwindColors } from "uicolors-generator";

export default {
  theme: {
    extend: {
      colors: {
        steel: getTailwindColors("#232425", { includeDefault: true }),
        badass: getTailwindColors("#bada55", { includeDefault: true }),
      },
    },
  },
};

Then in your code, you can use your palette and shades like so:

// your-project/pages/index.tsx
export default function HelloWorld() {
  return (
    <div className="bg-steel-800">
      <h1 className="text-badass">Hello World</h1>
      <p className="text-badass-300">Your palette at your fingertips.</p>
    </div>
  );
}