@uiw/react-color-slider
Version:
Color Slider component for React.
93 lines (73 loc) • 2.78 kB
Markdown
React Color Slider
===
[](https://jaywcjlove.github.io/#/sponsor)
[](https://bundlephobia.com/package/@uiw/react-color-slider) [](https://www.npmjs.com/package/@uiw/react-color-slider) [](https://uiwjs.github.io/npm-unpkg/#/pkg/@uiw/react-color-slider/file/README.md)
Slider Component is a subcomponent of [**`@react-color`**](https://uiwjs.github.io/react-color).
<!--rehype:ignore:start-->
[](https://uiwjs.github.io/react-color/#/slider)
<!--rehype:ignore:end-->
## Install
```bash
npm i @uiw/react-color-slider
```
## Usage
```tsx mdx:preview
import React, { useState } from 'react';
import Slider from '@uiw/react-color-slider';
export default function Demo() {
const [hsva, setHsva] = useState({ h: 0, s: 0, v: 68, a: 1 });
return (
<Slider
color={hsva}
onChange={(color) => {
setHsva({ ...hsva, ...color.hsv });
}}
/>
);
}
```
```tsx mdx:preview
import React, { useState } from 'react';
import Slider from '@uiw/react-color-slider';
import Wheel from '@uiw/react-color-wheel';
export default function Demo() {
const [hsva, setHsva] = useState({ h: 0, s: 0, v: 68, a: 1 });
return (
<>
<Slider
color={hsva}
style={{ paddingBottom: 10 }}
onChange={(color) => {
setHsva({ ...hsva, ...color.hsv });
}}
/>
<Wheel
color={hsva}
onChange={(color) => setHsva({ ...hsva, ...color.hsva })}
/>
</>
);
}
```
## Props
```ts
import React from 'react';
import { ColorResult, HsvaColor } from '@uiw/color-convert';
export interface SliderProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange' | 'color'> {
prefixCls?: string;
color?: string | HsvaColor;
lightness?: number[];
onChange?: (color: ColorResult, evn: React.MouseEvent<HTMLDivElement, MouseEvent>) => void;
}
declare const Slider: React.ForwardRefExoticComponent<SliderProps & React.RefAttributes<HTMLDivElement>>;
export default Slider;
```
<!--footer-dividing-->
## Contributors
As always, thanks to our amazing contributors!
<a href="https://github.com/uiwjs/react-color/graphs/contributors">
<img src="https://uiwjs.github.io/react-color/coverage/CONTRIBUTORS.svg" />
</a>
Made with [contributors](https://github.com/jaywcjlove/github-action-contributors).
## License
Licensed under the MIT License.