Skip to content

ColorPicker

ColorPicker

Widget for selecting the color.

jsx
import ColorPicker from 'intergalactic/color-picker';
<ColorPicker />;
import ColorPicker from 'intergalactic/color-picker';
<ColorPicker />;

ColorPickerProps

& {...}
NameTypeDescription
valuestring | nullSelected color item. Should be used with `onChange` property together
onChange(value: string, event: React.ChangeEvent) => voidFired when user selects color item. Should be used with `value` property together
defaultValuestring | nullDefault value if `value` property is not provided
colorsstring[]Array of color items. Should be used with `onColorsChange` property together
onColorsChange(value: string[], event: React.ChangeEvent) => voidFired when user changes color items. Should be used with `colors` property together
displayLabelbooleanShows label `A` as text color icon inside all color items

ColorPicker.Trigger

The wrap over the <Dropdown.Trigger/> component.

jsx
import ColorPicker from 'intergalactic/color-picker';
<ColorPicker.Trigger />;
import ColorPicker from 'intergalactic/color-picker';
<ColorPicker.Trigger />;

ColorPicker.Popper

The wrap over the <Dropdown.Popper/> component.

jsx
import ColorPicker from 'intergalactic/color-picker';
<ColorPicker.Popper />;
import ColorPicker from 'intergalactic/color-picker';
<ColorPicker.Popper />;

ColorPicker.Colors

Group of ColorPicker.Items.

jsx
import ColorPicker from 'intergalactic/color-picker';
<ColorPicker.Colors />;
import ColorPicker from 'intergalactic/color-picker';
<ColorPicker.Colors />;

ColorsProps

& {...}
NameTypeDescription
colorsstring[]Array of color items

ColorPicker.Item

One unit of <ColorPicker.Colors />. ColorPicker.Item is a swatch preview that allows a user to see what color is currently selected.

jsx
import ColorPicker from 'intergalactic/color-picker';
<ColorPicker.Item />;
import ColorPicker from 'intergalactic/color-picker';
<ColorPicker.Item />;

ItemProps

& {...}
NameTypeDescription
valuestringColor item in hexadecimal format.
displayLabelbooleanShows label `A` as text color icon inside all color items
editablebooleanProperty enabling the ability to remove a color item on click
selectedbooleanShows if color item is selected
onRemoveReact.MouseEventHandlerFired with color item when user clicks on the close icon

PaletteManager

Part of ColorPicker that provides the ability to add and remove custom colors to the palette.

jsx
import { PaletteManager } from 'intergalactic/color-picker';
<PaletteManager />;
import { PaletteManager } from 'intergalactic/color-picker';
<PaletteManager />;

PaletteManagerProps

& {...}
NameTypeDescription
colorsstring[]Array of color items. Should be used with `onColorsChange` property together
defaultColorsstring[]Default value if `colors` property is not provided
onColorsChange(value: string[], event: React.ChangeEvent) => voidFired when user adds or removes color items. Should be used with `colors` property together

PaletteManager.Colors

Group of PaletteManager.Items.

jsx
import { PaletteManager } from 'intergalactic/color-picker';
<PaletteManager.Colors />;
import { PaletteManager } from 'intergalactic/color-picker';
<PaletteManager.Colors />;

ColorsCustomProps

& & {...}
NameTypeDescription
onPlusButtonClickReact.MouseEventHandlerFired when user clicks on the plus icon in Palette Manager - focuses the input component

PaletteManager.Item

One unit of <PaletteManager.Colors />. PaletteManager.Item is a swatch preview that allows a user to see what color is currently selected.

jsx
import { PaletteManager } from 'intergalactic/color-picker';
<PaletteManager.Item />;
import { PaletteManager } from 'intergalactic/color-picker';
<PaletteManager.Item />;

ItemProps

& {...}
NameTypeDescription
valuestringColor item in hexadecimal format.
displayLabelbooleanShows label `A` as text color icon inside all color items
editablebooleanProperty enabling the ability to remove a color item on click
selectedbooleanShows if color item is selected
onRemoveReact.MouseEventHandlerFired with color item when user clicks on the close icon

ColorPicker.InputColor

Input for adding colors in hexadecimal format.

jsx
import { PaletteManager } from 'intergalactic/color-picker';
<PaletteManager.InputColor />;
import { PaletteManager } from 'intergalactic/color-picker';
<PaletteManager.InputColor />;

InputColorProps

& {...}
NameTypeDescription
valuestringText value of input
defaultValuestring | nullDefault value if `value` property is not provided
state"normal" | "valid" | "invalid"Uncontrolled visual state of input
colorsstring[]Array of color items
onAdd(value: string, event: React.MouseEvent | React.KeyboardEvent) => voidFired with entered value when user clicks on the check icon or hits `Enter` or `Space`

Released under the MIT License.

Released under the MIT License.