Skip to content

Latest commit

 

History

History
85 lines (63 loc) · 1.96 KB

README.md

File metadata and controls

85 lines (63 loc) · 1.96 KB

theme-colors

npm version npm downloads bundle Codecov

Easily generate color shades for themes

Usage

Install package:

# npm
npm install theme-colors

# yarn
yarn add theme-colors

# pnpm
pnpm install theme-colors

# bun
bun install theme-colors

Import:

// ESM
import { getColors } from "theme-colors";

// CommonJS
const { getColors } = require("theme-colors");

const theme = getColors("#ABABAB");
// Or using RGB
const theme = getColors("172,172,172");

This will generate the following shades:

{
  50: '#FBFBFB',
  100: '#F7F7F7',
  200: '#EAEAEA',
  300: '#DDDDDD',
  400: '#C4C4C4',
  500: '#ABABAB',
  600: '#9A9A9A',
  700: '#676767',
  800: '#4D4D4D',
  900: '#333333',
  950: '#222222',
}

Development

  • Clone this repository
  • Install latest LTS version of Node.js
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Run interactive tests using pnpm dev

License

Inspired by javisperez/tailwindcolorshades

Made with 💛

Published under MIT License.