README.md

July 1, 2021 · View on GitHub

^{Using my app is also a way to support me:}

React Color

react-color is a tiny color picker widget component for React apps. These components can be installed and used separately.

Getting Started

npm i @uiw/react-color

import { Slider, Sketch, Material, Colorful, Compact, Circle, Swatch, Wheel, Block, Github, Chrome } from '@uiw/react-color';
import { Alpha, Hue, ShadeSlider, Saturation, Interactive, hsvaToHslaString } from '@uiw/react-color';
import { EditableInput, EditableInputRGBA, EditableInputHSLA } from '@uiw/react-color';

function Demo() {
  const [hex, setHex] = useState("#fff");
  return (
    <Sketch
      style={{ marginLeft: 20 }}
      color={hex}
      onChange={(color) => {
        setHex(color.hex);
      }}
    />
  );
}

Support dark/night Theme

[data-color-mode*='dark'] .w-color-sketch {
  --sketch-background: #323232 !important;
}

[data-color-mode*='dark'] .w-color-swatch {
  --sketch-swatch-border-top: 1px solid #525252 !important;
}

[data-color-mode*='dark'] .w-color-block {
  --block-background-color: #323232 !important;
  --block-box-shadow: rgb(0 0 0 / 10%) 0 1px !important;
}

[data-color-mode*='dark'] .w-color-editable-input {
  --editable-input-label-color: #757575 !important;
  --editable-input-box-shadow: #616161 0px 0px 0px 1px inset !important;
  --editable-input-color: #bbb !important;
}

[data-color-mode*='dark'] .w-color-github {
  --github-border: 1px solid rgba(0, 0, 0, 0.2) !important;
  --github-background-color: #323232 !important;
  --github-box-shadow: rgb(0 0 0 / 15%) 0px 3px 12px !important;
  --github-arrow-border-color: rgba(0, 0, 0, 0.15) !important;
}

[data-color-mode*='dark'] .w-color-compact {
  --compact-background-color: #323232 !important;
}

[data-color-mode*='dark'] .w-color-material {
  --material-background-color: #323232 !important;
  --material-border-bottom-color: #707070 !important;
}

[data-color-mode*='dark'] .w-color-alpha {
  --alpha-pointer-background-color: #6a6a6a !important;
  --alpha-pointer-box-shadow: rgb(0 0 0 / 37%) 0px 1px 4px 0px !important;
}

Documentation

You can find the react-color documentation on the website.

Packages

Package	Downloads	Version / unpkg
`@uiw/react-color`
`@uiw/react-color-sketch`
`@uiw/react-color-slider`
`@uiw/react-color-compact`
`@uiw/react-color-material`
`@uiw/react-color-colorful`
`@uiw/react-color-wheel`
`@uiw/react-color-circle`
`@uiw/react-color-block`
`@uiw/react-color-chrome`
`@uiw/react-color-github`

`Base Components`

Package	Downloads	Version / unpkg
`@uiw/react-color-saturation`
`@uiw/react-color-hue`
`@uiw/react-color-alpha`
`@uiw/react-color-swatch`
`@uiw/react-color-shade-slider`
`@uiw/react-color-editable-input`
`@uiw/react-color-editable-input-rgba`
`@uiw/react-color-editable-input-hsla`
`@uiw/react-drag-event-interactive`
`@uiw/color-convert`
`@uiw/react-color-name`

Development

npm install       # Installation dependencies
npm run build     # Compile all package

cd packages/color-block
# listen to the component compile and output the .js file
# listen for compilation output type .d.ts file
npm run watch # Monitor the compiled package `@uiw/react-block`

npm run start     # development mode, listen to compile preview website instance

Contributors

As always, thanks to our amazing contributors!

Made with contributors.

License

Licensed under the MIT License.