@uiw/react-color-saturation
Version:
Color Saturation
89 lines (69 loc) • 2.81 kB
Markdown
React Color Saturation
===
[](https://jaywcjlove.github.io/#/sponsor)
[](https://bundlephobia.com/package/@uiw/react-color-saturation) [](https://www.npmjs.com/package/@uiw/react-color-saturation) [](https://uiwjs.github.io/npm-unpkg/#/pkg/@uiw/react-color-saturation/file/README.md)
Saturation Component is a subcomponent of [**`@react-color`**](https://uiwjs.github.io/react-color).
<!--rehype:ignore:start-->
[](https://uiwjs.github.io/react-color/#/saturation)
<!--rehype:ignore:end-->
## Install
```bash
npm i @uiw/react-color-saturation
```
## Usage
```jsx mdx:preview
import React, { useState } from 'react';
import Saturation from '@uiw/react-color-saturation';
export default function Demo() {
const [hsva, setHsva] = useState({ h: 0, s: 0, v: 68, a: 1 });
return (
<Saturation
hsva={hsva}
onChange={(newColor) => {
setHsva({ ...hsva, ...newColor, a: hsva.a });
}}
/>
);
}
```
The value of `hsva` does not exist
```jsx mdx:preview
import React from 'react';
import Saturation from '@uiw/react-color-saturation';
export default function Demo() {
return (
<div style={{ display: 'flex', gap: 10 }}>
<Saturation hue={122} />
<Saturation hue={210} />
<Saturation hue={23} />
</div>
);
}
```
## Props
```ts
import React from 'react';
import { HsvaColor } from '@uiw/color-convert';
import { PointerProps } from './Pointer';
export interface SaturationProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange'> {
prefixCls?: string;
/** hsva => `{ h: 0, s: 75, v: 82, a: 1 }` */
hsva?: HsvaColor;
hue?: number;
radius?: React.CSSProperties['borderRadius'];
/** React Component, Custom pointer component */
pointer?: ({ prefixCls, left, top, color }: PointerProps) => JSX.Element;
onChange?: (newColor: HsvaColor) => void;
}
declare const Saturation: React.ForwardRefExoticComponent<SaturationProps & React.RefAttributes<HTMLDivElement>>;
export default Saturation;
```
<!--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.