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

color-palette-creator

v0.0.7

Published

The Color Palette Creator is an npm package that allows you to generate color palettes and color schemes based on a given base color. It provides a simple and intuitive API to create visually appealing color combinations for your projects.

Downloads

15

Readme

Color Palette Creator

A powerful and flexible npm package for generating various types of color palettes. This package provides a set of functions to create beautiful and harmonious color schemes for your projects.

Installation

To install the package, run the following command:

npm install color-palette-creator

Usage

Import the desired color palette generation function from the package and use it in your code:

const { generateMonochromaticPalette, generateComplementaryPalette } = require('color-palette-creator');

// Generate a monochromatic color palette
const monochromaticPalette = generateMonochromaticPalette({
  format: 'hex',
  count: 5,
  seed: 'my-seed',
});

// Generate a complementary color palette
const complementaryPalette = generateComplementaryPalette({
  format: 'hex',
  seed: 'my-seed',
});

Available Functions

  • generateMonochromaticPalette(options): Generates a monochromatic color palette based on a randomly generated base color.
  • generateComplementaryPalette(options): Generates a complementary color palette by finding the color opposite to the base color on the color wheel.
  • generateSplitComplementaryPalette(options): Generates a split complementary color palette by finding the colors adjacent to the opposite color on the color wheel.
  • generateTriadicPalette(options): Generates a triadic color palette by finding colors evenly spaced around the color wheel.
  • generateTetradicPalette(options): Generates a tetradic color palette by finding four colors evenly spaced around the color wheel.
  • generateAnalogousPalette(options): Generates an analogous color palette by finding colors adjacent to the base color on the color wheel.
  • generateShadesPalette(options): Generates a palette of shades by creating a color scale from the base color to black.
  • generateTintsPalette(options): Generates a palette of tints by creating a color scale from the base color to white.

Options

Each function accepts an optional options object with the following properties:

  • format (string, default: 'hex'): The color format of the generated palette. Supported formats: 'hex', 'rgb', 'hsl'.
  • count (number, default: 5): The number of colors to generate in the palette (applicable to monochromatic, shades, and tints palettes).
  • seed (string, default: null): A seed value to generate consistent color palettes across multiple calls.

Examples

const { generateTriadicPalette, generateShadesPalette } = require('color-palette-creator');

// Generate a triadic color palette
const triadicPalette = generateTriadicPalette({
  format: 'rgb',
  seed: 'my-seed',
});

// Generate a shades palette
const shadesPalette = generateShadesPalette({
  format: 'hsl',
  count: 8,
  seed: 'my-seed',
});

Dependencies

This package relies on the following dependencies:

  • make-random-color: A package for generating random colors.
  • chroma-js: A powerful library for color manipulation and conversion.
  • color-convert: A package for converting between color formats.

License

This package is open source and available under the MIT License.