- Components
- Colors
- Color Slider
Color Slider
ColorSlider allow users to adjust an individual channel of a color value.
Installation
Install the following dependencies:
Copy and paste the following code into your project.
Update the import paths to match your project setup.
Usage
Use ColorSlider to allow users to adjust an individual channel of a color value.
Options
Label
Use the label prop to provide a label for the color slider.
Orientation
orientation prop may be provided to specify the orientation of the color slider.
Channel
channel prop may be provided to specify which color channel the color slider should display
Disabled
Use the isDisabled prop to disable the color slider.
Unontrolled
Use the value and onChange props to control the value of the slider.
Controlled
Use the value and onChange props to control the value of the slider.
Composition
If you need to customize things further, you can drop down to the composition level.
API Reference
Prop | Type | Default | Description |
---|---|---|---|
channel* | 'hue' | 'saturation' | 'brightness' | 'lightness' | 'red' | 'green' | 'blue' | 'alpha' | - | The color channel that the slider manipulates. |
colorSpace | 'rgb' | 'hsl' | 'hsb' | - | The color space that the slider operates in. The channel must be in this color space. If not provided, this defaults to the color space of the color or defaultColor value. |
orientation | 'horizontal' | 'vertical' | 'horizontal' | The orientation of the Slider. |
isDisabled | boolean | - | Whether the whole Slider is disabled. |
value | T | - | The current value (controlled). |
defaultValue | T | - | The default value (uncontrolled). |
name | string | - | The name of the input element, used when submitting an HTML form. |
children | ReactNode | (values: ColorSliderRenderProps & {defaultChildren: ReactNode | undefined}) => ReactNode | - | The children of the component. A function may be provided to alter the children based on component state. |
className | string | - | The CSS className for the element. |
style | CSSProperties | (values: ColorSliderRenderProps & {defaultStyle: CSSProperties}) => CSSProperties | - | The inline style for the element. A function may be provided to compute the style based on component state. |
Event | Type | Description |
---|---|---|
onChange | (value: Color) => void | Handler that is called when the value changes, as the user drags. |
onChangeEnd | (value: Color) => void | Handler that is called when the user stops dragging. |
Data attribute | Description |
---|---|
[data-orientation="horizontal | vertical"] | The orientation of the color slider. |
[data-disabled] | Whether the color slider is disabled. |
Accessibility
Keyboard interactions
Key | Description |
---|---|
Tab | Places focus on the handle. If the handle is already in focus, moves focus to the next handle or next element in the page tab sequence. |
Shift+Tab | Places focus on the previous handle or previous element in the page tab sequence. |
ArrowUp ArrowDown ArrowLeft ArrowRight | Moves the handle up/down/left/right. |