UNPKG

@uiw/react-color-wheel

Version:
238 lines (205 loc) 13.4 kB
<div align="center" markdown="1"> <sup>Special thanks to:</sup> <br> <br> <a href="https://apps.apple.com/app/apple-store/id6757860829?pt=80185800&ct=jay&mt=8"> <img alt="SubList" width="400" src="https://jaywcjlove.github.io/sponsor/SubList.jpg"> </a> <br> <a href="https://apps.apple.com/app/apple-store/id6757860829?pt=80185800&ct=jay&mt=8"> SubList - Bill Reminder & Renewal Alerts </a> <br><br> </div> <hr> <div markdown="1"> <sup>Using <a href="https://wangchujiang.com/#/app" target="_blank">my app</a> is also a way to <a href="https://wangchujiang.com/#/sponsor" target="_blank">support</a> me:</sup> <br> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6766860898" title="Zipora: Zip/RAR/7Z Unarchiver"><img alt="Zipora: Zip/RAR/7Z Unarchiver" height="52" src="https://wangchujiang.com/appicon/zipora.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6758053530" title="Scap: Screenshot & Markup Edit for macOS"><img alt="Scap: Screenshot & Markup Edit" height="52" src="https://wangchujiang.com/appicon/scap.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6757317079" title="Screen Test for macOS"><img alt="Screen Test" height="52" src="https://wangchujiang.com/appicon/screen-test.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6755948110" title="Deskmark for macOS"><img alt="Deskmark" height="52" src="https://wangchujiang.com/appicon/deskmark.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6500434773" title="Keyzer for macOS"><img alt="Keyzer" height="52" src="https://wangchujiang.com/appicon/keyzer.png"></a> <a target="_blank" href="https://github.com/jaywcjlove/vidwall-hub" title="Vidwall Hub for macOS"><img alt="Vidwall Hub" height="52" src="https://wangchujiang.com/appicon/vidwall-hub.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6752624705" title="VidCrop for macOS"><img alt="VidCrop" height="52" src="https://wangchujiang.com/appicon/vidcrop.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6747587746" title="Vidwall for macOS"><img alt="Vidwall" height="52" src="https://wangchujiang.com/appicon/vidwall.png"></a> <a target="_blank" href="https://wangchujiang.com/mousio-hint/" title="Mousio Hint for macOS"><img alt="Mousio Hint" height="52" src="https://wangchujiang.com/appicon/mousio-hint.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6746747327" title="Mousio for macOS"><img alt="Mousio" height="52" src="https://wangchujiang.com/appicon/mousio.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6745227444" title="Musicer for macOS"><img alt="Musicer" height="52" src="https://wangchujiang.com/appicon/musicer.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6743841447" title="Audioer for macOS"><img alt="Audioer" height="52" src="https://wangchujiang.com/appicon/audioer.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6744690194" title="FileSentinel for macOS"><img alt="FileSentinel" height="52" src="https://wangchujiang.com/appicon/file-sentinel.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6743495172" title="FocusCursor for macOS"><img alt="FocusCursor" height="52" src="https://wangchujiang.com/appicon/focus-cursor.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6742680573" title="Videoer for macOS"><img alt="Videoer" height="52" src="https://wangchujiang.com/appicon/videoer.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6740425504" title="KeyClicker for macOS"><img alt="KeyClicker" height="52" src="https://wangchujiang.com/appicon/key-clicker.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6739052447" title="DayBar for macOS"><img alt="DayBar" height="52" src="https://wangchujiang.com/appicon/daybar.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6739444407" title="Iconed for macOS"><img alt="Iconed" height="52" src="https://wangchujiang.com/appicon/iconed.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6737160756" title="Menuist for macOS"><img alt="Menuist" height="52" src="https://wangchujiang.com/appicon/rightmenu-master.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6723903021" title="Paste Quick for macOS"><img alt="Quick RSS" height="52" src="https://wangchujiang.com/appicon/paste-quick.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6670696072&platform=mac" title="Quick RSS for macOS/iOS"><img alt="Quick RSS" height="52" src="https://wangchujiang.com/appicon/quick-rss.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6670167443" title="Web Serve for macOS"><img alt="Web Serve" height="52" src="https://wangchujiang.com/appicon/web-serve.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6503953628&platform=mac" title="Copybook Generator for macOS/iOS"><img alt="Copybook Generator" height="52" src="https://wangchujiang.com/appicon/copybook-generator.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6471227008&platform=mac" title="DevTutor for macOS/iOS"><img alt="DevTutor for SwiftUI" height="52" src="https://wangchujiang.com/appicon/devtutor.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6479819388&platform=mac" title="RegexMate for macOS/iOS"><img alt="RegexMate" height="52" src="https://wangchujiang.com/appicon/regex-mate.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6479194014&platform=mac" title="Time Passage for macOS/iOS"><img alt="Time Passage" height="52" src="https://wangchujiang.com/appicon/time-passage.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6478772538" title="IconizeFolder for macOS"><img alt="Iconize Folder" height="52" src="https://wangchujiang.com/appicon/iconize-folder.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6478511402&platform=mac" title="Textsound Saver for macOS/iOS"><img alt="Textsound Saver" height="52" src="https://wangchujiang.com/appicon/textsound-saver.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6476924627" title="Create Custom Symbols for macOS"><img alt="Create Custom Symbols" height="52" src="https://wangchujiang.com/appicon/create-custom-symbols.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6476452351" title="DevHub for macOS"><img alt="DevHub" height="52" src="https://wangchujiang.com/appicon/devhub.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6476400184" title="Resume Revise for macOS"><img alt="Resume Revise" height="52" src="https://wangchujiang.com/appicon/resume-revise.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6472593276" title="Palette Genius for macOS"><img alt="Palette Genius" height="52" src="https://wangchujiang.com/appicon/palette-genius.png"></a> <a target="_blank" href="https://jaywcjlove.github.io/maslink/?id=6470879005" title="Symbol Scribe for macOS"><img alt="Symbol Scribe" height="52" src="https://wangchujiang.com/appicon/symbol-scribe.png"></a> </div> <hr> React Color Wheel === [![Buy me a coffee](https://img.shields.io/badge/Buy_Me_a_Coffee-ffdd00?logo=buy-me-a-coffee&logoColor=black)](https://jaywcjlove.github.io/#/sponsor) [![Follow On X](https://img.shields.io/badge/Follow%20on%20X-333333?logo=x&logoColor=white)](https://x.com/jaywcjlove) [![npm version](https://img.shields.io/npm/v/@uiw/react-color-wheel.svg)](https://www.npmjs.com/package/@uiw/react-color-wheel) [![Open in unpkg](https://img.shields.io/badge/Open%20in-unpkg-blue)](https://uiwjs.github.io/npm-unpkg/#/pkg/@uiw/react-color-wheel/file/README.md) Wheel Component is a subcomponent of [**`@react-color`**](https://uiwjs.github.io/react-color). <!--rehype:ignore:start--> [![react-color-wheel](https://user-images.githubusercontent.com/1680273/125949147-ab96c3d8-1490-4418-b2cf-3f347993bdcb.png)](https://uiwjs.github.io/react-color/#/wheel) <!--rehype:ignore:end--> ## Install ```bash npm i @uiw/react-color-wheel ``` ## Usage ```tsx mdx:preview import React, { useState, Fragment } from 'react'; import Wheel from '@uiw/react-color-wheel'; import { hsvaToHex } from '@uiw/color-convert'; function Demo() { const [hsva, setHsva] = useState({ h: 214, s: 43, v: 90, a: 1 }); return ( <Fragment> <Wheel color={hsva} onChange={(color) => setHsva({ ...hsva, ...color.hsva })} /> <div style={{ width: '100%', height: 34, marginTop: 20, background: hsvaToHex(hsva) }}></div> </Fragment> ); } export default Demo; ``` ```tsx mdx:preview import React, { useState } from 'react'; import Wheel from '@uiw/react-color-wheel'; import { hsvaToHex } from '@uiw/color-convert'; function Demo() { const [hsva, setHsva] = useState({ h: 214, s: 43, v: 90, a: 1 }); return ( <div style={{ display: 'grid', gap: 20, gridTemplateColumns: 'repeat(auto-fill, minmax(200px, 1fr))' }}> <Wheel color={{a: 1, h: 214, s: 0, v: 100}} /> <Wheel color={{a: 1, h: 214, s: 0, v: 90}} /> <Wheel color={{a: 1, h: 214, s: 0, v: 80}} /> <Wheel color={{a: 1, h: 214, s: 0, v: 70}} /> <Wheel color={{a: 1, h: 214, s: 0, v: 50}} /> <Wheel color={{a: 1, h: 214, s: 0, v: 40}} /> <Wheel color={{a: 1, h: 214, s: 0, v: 40}} width={100} height={100} /> <Wheel color={{a: 1, h: 214, s: 0, v: 30}} width={100} height={100} /> <Wheel color={{a: 1, h: 214, s: 0, v: 20}} width={100} height={100} /> <Wheel color={{a: 1, h: 214, s: 0, v: 10}} width={100} height={100} /> </div> ); } export default Demo; ``` ```tsx mdx:preview import React, { useState, Fragment } from 'react'; import Wheel from '@uiw/react-color-wheel'; import ShadeSlider from '@uiw/react-color-shade-slider'; import { hsvaToHex } from '@uiw/color-convert'; function Demo() { const [hsva, setHsva] = useState({ h: 214, s: 43, v: 90, a: 1 }); return ( <Fragment> <Wheel color={hsva} onChange={(color) => setHsva({ ...hsva, ...color.hsva })} /> <ShadeSlider hsva={hsva} style={{ width: 210, marginTop: 20 }} onChange={(newShade) => { setHsva({ ...hsva, ...newShade }); }} /> <div style={{ width: '100%', height: 34, marginTop: 20, background: hsvaToHex(hsva) }}></div> </Fragment> ); } export default Demo; ``` ### Custom Pointer ```tsx mdx:preview import React, { useState, Fragment } from 'react'; import Wheel from '@uiw/react-color-wheel'; import ShadeSlider from '@uiw/react-color-shade-slider'; import { hsvaToHex } from '@uiw/color-convert'; function Demo() { const [hsva, setHsva] = useState({ h: 214, s: 43, v: 90, a: 1 }); return ( <Fragment> <Wheel color={hsva} onChange={(color) => setHsva({ ...hsva, ...color.hsva })} /* Passing the style prop is required in the topmost element. */ pointer={({ color, style }) => { return ( <div style={style}> <div style={{ width: 12, height: 12, transform: 'translate(-5px, -5px)', backgroundColor: color, border: '1px solid #000', }} /> </div> ); }} /> <ShadeSlider hsva={hsva} style={{ width: 210, marginTop: 20 }} onChange={(newShade) => { setHsva({ ...hsva, ...newShade }); }} /> <div style={{ width: '100%', height: 34, marginTop: 20, background: hsvaToHex(hsva) }}></div> </Fragment> ); } export default Demo; ``` ## Props ```ts import React from 'react'; import { HsvaColor, ColorResult } from '@uiw/color-convert'; import type * as CSS from 'csstype'; import { PointerProps } from './Pointer'; export interface WheelProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'onChange' | 'color'> { prefixCls?: string; color?: string | HsvaColor; width?: number; height?: number; radius?: CSS.Properties<string | number>['borderRadius']; /** Direction of the oval: 'x' or 'y'. */ oval?: string; /** Starting angle of the color wheel's hue gradient, measured in degrees. */ angle?: number; /** Direction of the color wheel's hue gradient; either clockwise or anticlockwise. Default: `anticlockwise` */ direction?: 'clockwise' | 'anticlockwise'; /** Passing the style prop is required in the topmost element. */ pointer?: ({ color, style }: PointerProps) => JSX.Element; onChange?: (color: ColorResult) => void; } declare const Wheel: React.ForwardRefExoticComponent<WheelProps & React.RefAttributes<HTMLDivElement>>; export default Wheel; ``` <!--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.