@mapbox/react-colorpickr

A colorpicker for React
---

 

__Demo__

Install

npm install @mapbox/react-colorpickr

You'll also want to include a copy of colorpickr.css in your code.

`` html

`

Usage

`js
import React from 'react'
import ColorPicker from '@mapbox/react-colorpickr'

function Example() {
return (

)
}
`

Required properties

#### onChange (color) => void

Value should be a function and is called whenever a color is updated from the colorpicker. Returns a color object.

Optional properties

#### theme Object<[key: string]: string>

By default, react-colorpickr depends on Assembly and the CSS located in dist/colorpickr.css. You can however, override it thanks to react-themeable which react-colorpickr uses internally. See the properties used and the class name values in theme.js.

#### initialValue string

Accepts any valid css color. If this isn't provided, a default color is used.

#### colorSpace 'hsl' | 'rgb' | 'hex'

Initializes what should be displaed in the bottom color input. Defaults to hex.

#### mode 'disc' | 'values'

Initializes which view tab is active. Defaults to disc.

#### eyedropper boolean

When true, an eyedropper is added to the top-right of the interface. Defaults to true.

#### reset boolean

When true, a reset button is added that when pressed, reverts to the initialized color. Defaults to true.

#### alpha boolean

When true, a alpha range slider and input is provided. Defatuls to true.

#### mounted (ColorPickr) => void

To use internal methods from react-colorpickr, mounted provides access to the components instance. This is helpful for calling methods like overrideValue that can manually set a new color.

`js
const [instance, setInstance] = useState(null);

const override = () => {
instance.overrideValue('red');
};

render() {
<>
setInstance(picker)} onChange={console.log} />
Override

}
`

#### discRadius number

Optional property to provide a different disc radius for selection. Helpful if you are re-themeing the interface. Defaults to 18.


#### readOnly boolean

If true the colorpicker will render in a readonly state with values clearly shown and selectable, but not editable. Defaults to false`.

Developing

npm install & npm start

Then open http://localhost:9966 in browser.