Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@kevinrodriguez-io/pigment-core

A powerful library that provides color-conversions, palette/scheme generation, color manipulation and many more features intended to provide a great UX.

@kevinrodriguez-io/pigment-core, pigment, pigment core, kevinrodriguez-io, kevin rodríguez, color conversion, color theme, color palette, complementary color, triadic color, triadic, analogous, pigment js

readme

@kevinrodriguez-io/pigment-core 🌈 - Pigment's engine

Features

  • Color conversions between:
    • HEX
    • RGB
    • HSL
    • LAB
    • XYZ
  • 24 Hand-Picked Flat Colors in both shades (Light and Dark)
  • Color shades generation
  • Find most similar hand-picked Flat color from another color
  • Get contrasting color text (Black / White) for another color
  • Generate Color Schemes:
    • Analogous
    • Complementary
    • Triadic
  • Compatible with Chameleon Framework's Sketch, PhotoShop and Storyboard plugins.

Installing

npm i @kevinrodriguez-io/pigment-core --save

or

yarn add @kevinrodriguez-io/pigment-core

Usage

  • Wrap your color * Supported formats: HEX, RGB, HSL
const hex = '#E74C3C'
const color = new Color(hex)
  • Get complementary color
color.complementaryColor
  • Get most similar Hand-Picked Flat color
color.nearestFlatColor
  • Get all color shades with a 25% separation
color.all(25)
color.nearestFlatColor.all(25) // Flat-color shades
  • Get color tints/shades (Array or single item) with a 25% separation
color.tints(25)
color.shades(25)
color.tint(25) // Just one color
color.shade(25) // Just one color
  • Get analogous color scheme (Regular & Flat)
color.analogousColorScheme
color.analogousFlatColorScheme
  • Get complementary color scheme
color.complementaryColorScheme
color.complementaryFlatColorScheme
  • Get triadic color scheme
color.triadicColorScheme
color.triadicFlatColorScheme
  • Get contrasting text color (Black/White)
color.contrastingTextColor
color.contrastingFlatTextColor // Flat version

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.4.0 (2022-11-01)

Features

  • added const typing for colors object (31e8058)

1.3.1 (2020-03-08)

Note: Version bump only for package @kevinrodriguez-io/pigment-core

1.3.0 (2020-03-01)

Features

  • Functions module for simplified functional calls (761c679)

1.2.12 (2020-02-29)

Note: Version bump only for package @kevinrodriguez-io/pigment-core

1.2.11 (2020-02-02)

Note: Version bump only for package @kevinrodriguez-io/pigment-core

1.2.10 (2020-02-02)

Note: Version bump only for package @kevinrodriguez-io/pigment-core

1.2.9 (2020-02-02)

Note: Version bump only for package @kevinrodriguez-io/pigment-core

1.2.8 (2020-02-02)

Note: Version bump only for package @magic-color/core

1.2.7 (2020-02-02)

Note: Version bump only for package @hue/core

1.2.5 (2020-02-02)

Note: Version bump only for package @pigment/core

1.2.4 (2020-02-02)

Note: Version bump only for package @pigment/core

1.2.3 (2020-02-02)

Note: Version bump only for package @pigment/core

1.2.2 (2020-02-02)

Note: Version bump only for package @pigment/core

1.2.1 (2020-02-02)

Note: Version bump only for package @pigment/core

1.2.0 (2020-02-02)

Features

1.1.0 (2020-02-02)

Features

  • Adding types and removing unused folders (906475c)
  • Initial commit (a7dfbf9)