Component that selects a specific color and gets a color code.
- Browser Support
- Features
- Examples
- Install
- Usage
- Pull Request Steps
- Documents
- Contributing
- Dependency
- License
Chrome | Internet Explorer | Edge | Safari | Firefox |
---|---|---|---|---|
Yes | 8+ | Yes | Yes | Yes |
- Supports color palette.
- Supports 16 basic color set.
- Supports custom events.
- Basic : Example using default options.
TOAST UI products can be used by using the package manager or downloading the source directly. However, we highly recommend using the 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 install --save tui-color-picker # Latest version
$ npm install --save tui-color-picker@<version> # Specific version
$ bower install tui-color-picker # Latest version
$ bower install tui-color-picker#<tag> # Specific version
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/
โ โโ ...
Add the container element to create the component as an option.
<div id="tui-color-picker-conatiner"></div>
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.
var colorPicker = tui.colorPicker;
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.
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.
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
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.
$ npm run serve
$ npm run serve:ie8 # Run on Internet Explorer 8
$ npm run test
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.
You can also see the older versions of API page on the releases page.
- tui-code-snippet >=1.3.0
This software is licensed under the MIT ยฉ NHN Entertainment.