reanimated-color-picker

:red_circle: :green_circle: :large_blue_circle:

Reanimated Color Picker

- Pure JavaScript color picker for react-native.

- Highly customizable.

- Supports IOS, Android, Expo, and Web platforms.

- Supports right to left (RTL) layout.

:small_blue_diamond: Table of contents

• :one: Prerequisites

• :two: Installation

• :three: Usage

• :four: API

  • ColorPicker Wrapper
  • Built-in Components
    • <Preview />
    • <PreviewText />
    • <Panel1 />
    • <Panel2 />
    • <Panel3 />
    • <HueSlider />
    • <SaturationSlider />
    • <BrightnessSlider />
    • <OpacitySlider />
    • <Swatches />

• :five: Slider Props

• :six: Examples

• :seven: License

:small_blue_diamond:Prerequisites

• Use the links below to follow the installation instructions.

• react-native-gesture-handler version 2.0.0 or higher.

• react-native-reanimated version 2.0.0 or higher.

• For Expo managed workflow version 44 or higher is required.

:small_blue_diamond:Installation

Note First we need to install react-native-gesture-handler(>=2.0.0) and react-native-reanimated(>=2.0.0),

• Open a Terminal in the project root and run:

npm i reanimated-color-picker

:small_blue_diamond:Usage

• You can add, remove, rearrange or style the color picker's built-in components.

• Check out the working examples:

  • Bare workflow
  • Expo managed workflow
  • Expo snack

import React, { useState } from 'react';
import { Button, Modal, StyleSheet, View } from 'react-native';

import ColorPicker, { Panel1, Swatches, Preview, OpacitySlider, HueSlider } from 'reanimated-color-picker';

export default function App() {
  const [showModal, setShowModal] = useState(false);

  const onSelectColor = ({ hex }) => {
    // do something with the selected color.
    console.log(hex);
  };

  return (
    <View style={styles.container}>
      <Button title='Color Picker' onPress={() => setShowModal(true)} />

      <Modal visible={showModal} animationType='slide'>
        <ColorPicker style={{ width: '70%' }} value='red' onComplete={onSelectColor}>
          <Preview />
          <Panel1 />
          <HueSlider />
          <OpacitySlider />
          <Swatches />
        </ColorPicker>

        <Button title='Ok' onPress={() => setShowModal(false)} />
      </Modal>
    </View>
  );
}

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
  },
});

:small_blue_diamond:API

:small_red_triangle:ColorPicker Wrapper

• The ColorPicker Wrapper is responsible for managing the built-in components.

• It has the following props:

:white_small_square:value

• The initial value of the color picker.
• Accepts 'hex', 'rgb', 'rgba', 'hsl', 'hsla' and named color formats.
• type: string
• default: '#418181'

:white_small_square:sliderThickness

• A global property to change the thickness of all descendant sliders components.
• The thickness is the slider's width in case of vertical orientation and height in case of horizontal orientation.
• type: number
• default: 25

:white_small_square:thumbSize

• A global property to change the thumb size of all descendant sliders components.
• type: number
• default: 35

:white_small_square:thumbShape

• A global property to change the shape and appearance of the thumb of all descendant sliders components.
• type: string
• default: 'ring'
• values: 'ring' | 'solid' | 'hollow' | 'line' | 'plus' | 'pill' | 'triangleUp' | 'triangleDown' | 'doubleTriangle' | 'rect' | 'circle'

:white_small_square:style

• Color picker's container style.
• If you want to change the width using the width property.
• type: ViewStyle

Note some style properties will be overwritten.

:white_small_square:onChange

• Called every time the color value changed.
• The passed color object has the following properties: hex, rgb, rgba, hsl, and hsla
• type: (color: object) => void
• default: null

:white_small_square:onComplete

• Called when the user releases the slider handle or when a swatch is clicked.
• The passed color object has the following properties: hex, rgb, rgba, hsl, and hsla
• type: (color: object) => void
• default: null

:small_red_triangle:Built-in Components

:small_orange_diamond:<Preview />

• The preview of the selected and the initial color.

Property	Type	Default	Description
colorFormat	string	'hex'	preview color text format: 'hex', 'rgb', 'rgba', 'hsl', 'hsla', 'hsv' or 'hsva'
hideInitialColor	boolean	false	hide the initial color preview part
hideText	boolean	false	hide preview color texts
style	ViewStyle	/	preview container style
textStyle	TextStyle	/	preview text style

Note some style properties will be overwritten.

:small_orange_diamond:<PreviewText />

• A React Native <Text> component that displays the preview color text.

Property	Type	Default	Description
colorFormat	string	'hex'	preview color text format: 'hex', 'rgb', 'rgba', 'hsl', 'hsla', 'hsv' or 'hsva'
style	TextStyle	/	preview text style

:small_orange_diamond:<Panel1 />

• A square-shaped slider (adobe style) is used for changing the color's brightness and saturation.

Note you need to add <HueSlider /> alongside with it.

Property	Type	Default	Description
thumbSize	number	35	panel's handle (thumb) size (height*width)
thumbColor	string	interactive*	change thumb's color
thumbShape	string	'ring'	change thumb's shape: 'ring', 'solid', 'hollow', 'line', 'plus', 'pill', 'triangleUp', 'triangleDown', 'doubleTriangle', 'rect', 'circle'
style	ViewStyle	/	panel's container style

Note some style properties will be overwritten.

:asterisk: interactive: the thumb color will be changed depending on the contrast ratio if no color value is passed.

:small_orange_diamond:<Panel2 />

• A square-shaped slider (windows style) is used for changing the color's hue and saturation.

Note you need to add <BrightnessSlider /> alongside with it.

Property	Type	Default	Description
thumbSize	number	35	panel's handle (thumb) size (height*width)
thumbColor	string	interactive*	change thumb's color
thumbShape	string	'ring'	change thumb's shape: 'ring', 'solid', 'hollow', 'line', 'plus', 'pill', 'triangleUp', 'triangleDown', 'doubleTriangle', 'rect', 'circle'
reverse	boolean	false	reverse (flip) hue direction
style	ViewStyle	/	panel's container style

Note some style properties will be overwritten.

:asterisk: interactive: the thumb color will be changed depending on the contrast ratio if no color value is passed.

:small_orange_diamond:<Panel3 />

• A circle-shaped slider is used for changing the color's hue and saturation.
• Move the handle around the center to change the color's hue.
• Move the handle away or toward the center to change the color's saturation.

Note you need to add <BrightnessSlider /> alongside with it.

Property	Type	Default	Description
thumbSize	number	35	panel's handle (thumb) size (height*width)
thumbColor	string	interactive*	change thumb's color
thumbShape	string	'ring'	change thumb's shape: 'ring', 'solid', 'hollow', 'line', 'plus', 'pill', 'triangleUp', 'triangleDown', 'doubleTriangle', 'rect', 'circle'
style	ViewStyle	/	panel's container style

Note some style properties will be overwritten.

:asterisk: interactive: the thumb color will be changed depending on the contrast ratio if no color value is passed.

:small_orange_diamond:<HueSlider />

• A slider to change the color's hue.

• Check out the Slider Props for more info.

:small_orange_diamond:<SaturationSlider />

• A slider to change the color's saturation.

• Check out the Slider Props for more info.

:small_orange_diamond:<BrightnessSlider />

• A slider to change the color brightness.

• Check out the Slider Props for more info.

:small_orange_diamond:<OpacitySlider />

• A slider to change the color's opacity.

• Check out the Slider Props for more info.

:small_orange_diamond:<Swatches />

• A list of colored swatches is used for quick color selection.

Property	Type	Default	Description
colors	string[]	material colors	custom swatches colors
style	ViewStyle	/	swatches container style
swatchStyle	ViewStyle	/	swatch style

Note some style properties will be overwritten.

:small_blue_diamond:Slider Props

• HueSlider, SaturationSlider, BrightnessSlider and OpacitySlider sliders accept the following props:

:white_small_square:thumbSize

• The size of the slider's thumb.
• type: number
• default: 35

:white_small_square:thumbColor

• The color of the slider's thumb.
• type: string
• default: interactive*

:asterisk: interactive: the thumb color will be changed depending on the contrast ratio if no color value is passed.

:white_small_square:thumbShape

• The shape and appearance of the slider's thumb.
• type: string
• default: 'ring'
• values: 'ring' | 'solid' | 'hollow' | 'line' | 'plus' | 'pill' | 'triangleUp' | 'triangleDown' | 'doubleTriangle' | 'rect' | 'circle'

:white_small_square:reverse

• Reverse the slider direction.
• type: boolean
• default: false

:white_small_square:vertical

• Change the slider orientation.
• type: boolean
• default: false

:white_small_square:style

• The style of the slider's container.
• type: ViewStyle

Note some style properties will be overwritten.

:small_blue_diamond:Examples

• Bare workflow
• Expo managed workflow
• Expo snack

:small_blue_diamond:License

• Reanimated Color Picker library is licensed under The MIT License.