Skip to content
Colorpicker component for web services.
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs feat: update documents (close #5) Feb 11, 2018
examples feat: apply tuidoc (#14) Feb 12, 2019
src chore: change company name (#16) Apr 3, 2019
test chore: change company name (#16) Apr 3, 2019
.eslintrc.js chore: remove eslint warning Sep 13, 2017
.gitignore fix: update link and extra config files (#2) Nov 13, 2017
CODE_OF_CONDUCT.md
CONTRIBUTING.md chore: change company name (#16) Apr 3, 2019
ISSUE_TEMPLATE.md feat: Prepare for NPM Sep 13, 2017
LICENSE
README.md chore: change company name (#16) Apr 3, 2019
bower.json chore: change company name (#16) Apr 3, 2019
jsdoc.conf.json fix: update link and extra config files (#2) Nov 13, 2017
karma.conf.js
package-lock.json feat: apply tuidoc (#14) Feb 12, 2019
package.json chore: change company name (#16) Apr 3, 2019
tuidoc.config.json
webpack.config.js chore: change company name (#16) Apr 3, 2019

README.md

TOAST UI Component : Color Picker

Component that selects a specific color and gets a color code.

GitHub release npm PRs welcome code with hearth by NHN

🚩 Table of Contents

Collect statistics on the use of open source

TOAST UI ColorPicker applies Google Analytics (GA) to collect statistics on the use of open source, in order to identify how widely TOAST UI ColorPicker is used throughout the world. It also serves as important index to determine the future course of projects. location.hostname (e.g. > “ui.toast.com") is to be collected and the sole purpose is nothing but to measure statistics on the usage. To disable GA, use the following usageStatistics options when creating the instance.

var options = {
    ...
    usageStatistics: false
}
var instance = tui.colorPicker.create(options);

Or, include tui-code-snippet.js (v1.5.0 or later) and then immediately write the options as follows:

tui.usageStatistics = false;

🌏 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.

🔧 Pull Request Steps

TOAST UI products are open source, so you can create a pull request(PR) after you fix issues. Run npm scripts and develop yourself with the following process.

Setup

Fork develop branch into your personal repository. Clone it to local computer. Install node modules. Before starting development, you should check to haveany errors.

$ git clone https://github.com/{your-personal-repo}/tui.color-picker.git
$ cd tui.color-picker
$ npm install
$ npm run test

Develop

Let's start development! You can see your code is reflected as soon as you saving the codes by running a server. Don't miss adding test cases and then make green rights.

Run webpack-dev-server

$ npm run serve
$ npm run serve:ie8 # Run on Internet Explorer 8

Run karma test

$ npm run test

Pull Request

Before PR, check to test lastly and then check any errors. If it has no error, commit and then push it!

For more information on PR's step, please see links of Contributing section.

📙 Documents

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

💬 Contributing

🔩 Dependency

📜 License

This software is licensed under the MIT © NHN.

You can’t perform that action at this time.