JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1650
  • Score
    100M100P100Q140474F
  • License MIT

lightweight color picker in commonjs

Package Exports

  • simple-color-picker

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (simple-color-picker) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

experimental

simple-color-picker

Simple Color picker in common.js that doesn't rely on jQuery. The color manipulations are done using harthur/color.

demo

Quickstart

var ColorPicker = require('simple-color-picker');

var colorPicker = new ColorPicker();

You can retrieve the current color with colorPicker.color. It will return a harthur/color instance. If you prefer a simple hex string use colorPicker/getHexString();

Options

Options you can pass to constructor in an object like so :

var colorPicker = new ColorPicker({
  color: '#FF0000',
  background: '#454545',
  el: document.body,
  width: 200,
  height: 200
});

None of these options are mendatory.

color

The default color that the colorpicker will display. Default is #FFFFFF. It can be a hexadecimal number, an hex String and all other formats supported by harthur/color.

background

The background color of the colorpicker. Default is transparent. It can be a hexadecimal number, an hex String and all other formats supported by harthur/color.

el

A dom node to add the colorpicker to. You can also use colorPicker.appendTo(domNode) afterwards if you prefer.

width

Desired width of the color picker. Default is 150.

height

Desired height of the color picker. Default is 150.

Methods

.appendTo(domElement)

Add the colorPicker instance to a domElement.

.remove()

Remove the colorpicker from parent and destroy it.

.setColor(color)

Manually change the current color of the colorpicker. It will update its display. Param can be a hexadecimal number, an hex String and all other formats supported by harthur/color.

.onChange(callback)

Register the callback to the update event of the colorpicker. ColorPicker inherits from component/emitter so you could do the same thing by calling colorPicker.on('update');

.getHexString()

Returns current color as a CSS compatible Hex String.