UNPKG

3.52 kBMarkdownView Raw
1# rc-color-picker
2---
3
4React Color Picker
5
6[![npm version](http://img.shields.io/npm/v/rc-color-picker.svg)](https://www.npmjs.org/package/rc-color-picker)
7[![npm download](http://img.shields.io/npm/dm/rc-color-picker.svg)](https://www.npmjs.org/package/rc-color-picker)
8[![npm dependency](https://david-dm.org/react-component/color-picker.svg)](https://david-dm.org/react-component/color-picker)
9
10## Browser Support
11
12|![IE](https://raw.github.com/alrra/browser-logos/master/internet-explorer/internet-explorer_48x48.png) | ![Chrome](https://raw.github.com/alrra/browser-logos/master/chrome/chrome_48x48.png) | ![Firefox](https://raw.github.com/alrra/browser-logos/master/firefox/firefox_48x48.png) | ![Opera](https://raw.github.com/alrra/browser-logos/master/opera/opera_48x48.png) | ![Safari](https://raw.github.com/alrra/browser-logos/master/safari/safari_48x48.png)|
13| --- | --- | --- | --- | --- |
14| IE 10+ ✔ | Chrome 31.0+ ✔ | Firefox 31.0+ ✔ | Opera 30.0+ ✔ | Safari 7.0+ ✔ |
15
16## Screenshots
17
18<img src=https://cloud.githubusercontent.com/assets/1292082/8275606/8608e8f8-18db-11e5-8d10-703253db2a4f.png width=238 />
19
20## Development
21
22```
23npm install
24npm start
25```
26
27## Example
28
29online example: [http://react-component.github.io/color-picker/](http://react-component.github.io/color-picker/)
30
31## Feature
32
33* support color mode RGB HSB HSL
34
35## install
36
37[![rc-color-picker](https://nodei.co/npm/rc-color-picker.png)](https://npmjs.org/package/rc-color-picker)
38
39## Usage
40
41```js
42var ColorPicker = require('rc-color-picker');
43var React = require('react');
44var ReactDOM = require('react-dom');
45ReactDOM.render(<ColorPicker />, container);
46```
47
48## API
49
50### ColorPicker.props
51
52name|type|default|description
53---|---|---|---
54animation | String | | index.css support 'slide-up'
55transitionName | String | | css class for animation
56getCalendarContainer| Function():Element | function(){return document.body;} | dom node where picker to be rendered into
57align | Object: alignConfig of [dom-align](https://github.com/yiminghe/dom-align)| | popup 's align config
58alpha | Number | 100 | opacity of the color
59defaultAlpha | Number | 100 | opacity of the color
60color | String | #ff0000 | color board current background color
61defaultColor | String | #ff0000 | color board current background color
62onChange | Function | noop | when select color
63onOpen | Function | noop | when color picker popup open
64onClose | Function | noop | when color picker popup close
65placement | String | topLeft | one of ['topLeft', 'topRight', 'bottomLeft', 'bottomRight']
66mode | String |'RGB' | color mode, support mode 'RGB', 'HSB' or 'HSL'
67children | Node |`<span className='react-colorpicker-trigger'></span>`|additional trigger appended to picker
68
69
70### ColorPicker.Panel.props
71
72name|type|default|description
73---|---|---|---
74alpha | Number | 100 | opacity of the color
75defaultAlpha | Number | 100 | opacity of the color
76color | String | #ff0000 | color board current background color
77defaultColor | String | #ff0000 | color board current background color
78style | Object | {} | root node CSS style
79onChange | Function| | when select color trigger
80onFocus | Function| | when picker focus trigger
81onBlur | Function| | when picker loose focus
82mode | String |'RGB' | color mode, support mode 'RGB', 'HSB' or 'HSL'
83
84## License
85
86rc-color-picker is released under the MIT license.