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

@nousantx/color-generator

v1.5.1

Published

Generate color shade easily.

Downloads

170

Readme

Color Shade Generator

Generate shades of color from a single hex color.

Installation

npm i @nousantx/color-generator

Usage

import { generateColors } from '@nousantx/color-generator'

const colorShades = generateColors({
  option: {
    format: 'object2',
    output: 'hex'
  },
  color: {
    primary: '#ccf654',
    secondary: '#a55de7'
  }
})

console.log(colorShades)

API

generateColors(options)

Generates color shades based on the provided options.

Parameters

  • options: An object containing the following properties:
    • option: An object with the following properties:
      • format: The output format. Default is 'css'.
      • output: The color format. Default is 'hex'.
    • color: An object where keys are color names and values are base color HEX values.

Returns

Depending on the format option, it returns CSS variables, SCSS variables, a JavaScript object, or an array of color shades.

Options

option.format

Specifies the output format of the generated color shades.

  • Type: 'css' | 'scss' | 'object' | 'object2' | 'array'
  • Default: 'css'

Format Types:

  • 'css': Returns CSS custom properties (variables).
  • 'scss': Returns SCSS variables.
  • 'object': Returns a nested object with color names as keys and shade values as nested objects.
  • 'object2': Returns a flat object with color-shade combinations as keys.
  • 'array': Returns an object with color names as keys and arrays of shade values.

option.output

Specifies the color format of the generated shades.

  • Type: 'hex' | 'rgb' | 'hsl'
  • Default: 'hex'

color

An object where keys are color names and values are base color HEX values.

  • Type: { [colorName: string]: string }

Example Output

// With format: 'object2' and output: 'hex'
{
  'primary-50': '#f4fde6',
  'primary-100': '#e8fccc',
  // ... other primary shades
  'secondary-50': '#f7f0fe',
  'secondary-100': '#efe1fd',
  // ... other secondary shades
}

Notes

  • The generator creates 11 shades for each color (50, 100, 200, ..., 900, 950).
  • Ensure that the input HEX colors are valid 6-digit HEX codes which not too dark or too light (e.g., '#ccf654').

License

MIT