Color PickerAPI/ExamplesGithub

Selects a specific color and gets a color code.


Browser Support

Chrome Chrome IE Internet Explorer Edge Edge Safari Safari Firefox Firefox
Yes 8+ Yes Yes Yes

Features

  • Supports color palette.
  • Supports 16 basic color set.
  • Supports custom events.

Examples

  • Basic : Example using default options.

Install

TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the package manager.

Via Package Manager

TOAST UI products are registered in two package managers, npm and bower. You can conveniently install it using the commands provided by each package manager. When using npm, be sure to use it in the environment Node.js is installed.

npm
$ npm install --save tui-color-picker # Latest version
$ npm install --save tui-color-picker@<version> # Specific version
bower
$ bower install tui-color-picker # Latest version
$ bower install tui-color-picker#<tag> # Specific version

Via Contents Delivery Network (CDN)

TOAST UI products are available over the CDN powered by TOAST Cloud.

You can use the CDN as below.

<script src="https://uicdn.toast.com/tui-color-picker/latest/tui-color-picker.js"></script>

<link rel="stylesheet" type="text/css" href="https://uicdn.toast.com/tui-color-picker/latest/tui-color-picker.css">

If you want to use a specific version, use the tag name instead of latest in the url's path.

The CDN directory has the following structure.

tui-color-picker/
├─ latest/
│  ├─ tui-color-picker.js
│  ├─ tui-color-picker.min.js
│  └─ tui-color-picker.css
├─ v2.1.0/
│  ├─ ...

Download Source Files


Usage

HTML

Add the container element to create the component as an option.

<div id="tui-color-picker-conatiner"></div>

JavaScript

This component does not use the instance created through the constructor function. First, you should import the module using one of the following ways depending on your environment.

Using namespace in browser environment
var colorPicker = tui.colorPicker;
Using module format in node environment
var colorPicker = require('tui-color-picker'); /* CommonJS */
import colorPicker from 'tui-color-picker'; /* ES6 */

Then you should call the create method with options to get instance. After creating an instance, you can call various APIs.

var container = document.getElementById('tui-color-picker-conatiner');
var instance = colorPicker.create({
    container: container,
    ...
});


instance.getColor();

For more information about the API, please see here.


Documents

You can also see the older versions of API page on the releases page.


Contributing


License

This software is licensed under the MIT © NHN.