@uiw/react-color-circle
Version:
Color swatch component for React.
101 lines (80 loc) • 2.77 kB
Markdown
React Color Swatch
===
[](https://jaywcjlove.github.io/#/sponsor)
[](https://bundlephobia.com/package/@uiw/react-color-circle) [](https://www.npmjs.com/package/@uiw/react-color-circle) [](https://uiwjs.github.io/npm-unpkg/#/pkg/@uiw/react-color-circle/file/README.md)
Circle Component is a subcomponent of [**`@react-color`**](https://uiwjs.github.io/react-color).
<!--rehype:ignore:start-->
[](https://uiwjs.github.io/react-color/#/circle)
<!--rehype:ignore:end-->
## Install
```bash
npm i @uiw/react-color-circle
```
## Usage
```jsx mdx:preview
import React, { useState } from 'react';
import Circle from '@uiw/react-color-circle';
export default function Demo() {
const [hex, setHex] = useState('#F44E3B');
return (
<Circle
colors={[ '#F44E3B', '#FE9200', '#FCDC00', '#DBDF00' ]}
color={hex}
onChange={(color) => {
setHex(color.hex);
}}
/>
);
}
```
Modify point style
```jsx mdx:preview
import React, { useState } from 'react';
import Circle from '@uiw/react-color-circle';
export default function Demo() {
const [hex, setHex] = useState('#F44E3B');
return (
<Circle
colors={[
'#f44336',
'#e91e63',
'#9c27b0',
'#673ab7',
'#3f51b5',
'#2196f3',
]}
color={hex}
pointProps={{
style: {
marginRight: 20,
},
}}
onChange={(color) => {
setHex(color.hex);
}}
/>
);
}
```
## Props
```ts
import React from 'react';
import { HsvaColor, ColorResult } from '@uiw/color-convert';
import { SwatchProps } from '@uiw/react-color-swatch';
export interface CircleProps extends Omit<SwatchProps, 'color' | 'onChange'> {
color?: string | HsvaColor;
onChange?: (color: ColorResult) => void;
pointProps?: React.HTMLAttributes<HTMLDivElement>;
}
declare const Circle: React.ForwardRefExoticComponent<CircleProps & React.RefAttributes<HTMLDivElement>>;
export default Circle;
```
<!--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.