This package has been deprecated

Author message:

Migrated and refactored into ktree

color-octree

2.2.1 • Public • Published

Find efficiently the closest hex color

npm version build status

API

  • add(colors /*array of {hex, name}*/): add an array of colors (add calls init if it was not initialized yet)
  • closest(hex): Search for the closest color
  • init(depth: Int = 7): Init the tree at a given depth (default 7), accepted range: [0, 7]
  • remove(hex): Remove a color object by its hex property
import colorNames from 'color-names';
import { add, closest } from 'color-octree';
 
// we expect an array of {hex, name}
const colors = Object.entries(colorNames).map(([hex, name]) => ({ hex, name }));
 
add(colors);
console.log(closest('5544df'));

live example

Notice

It uses String.prototype.padStart, it exists on node 8.11 and recent browsers, but you might still want to polyfill it (see polyfill.io or es-shims)

Package Sidebar

Install

npm i color-octree

Weekly Downloads

1

Version

2.2.1

License

ISC

Unpacked Size

27.4 kB

Total Files

7

Last publish

Collaborators

  • caub