Skip to content

Vizel API / react/src / VizelColorPickerProps

Interface: VizelColorPickerProps

Defined in: packages/react/src/components/VizelColorPicker.tsx:10

Properties

allowCustomColor?

ts
optional allowCustomColor?: boolean;

Defined in: packages/react/src/components/VizelColorPicker.tsx:22

Enable custom HEX input (default: true)


applyAriaLabel?

ts
optional applyAriaLabel?: string;

Defined in: packages/react/src/components/VizelColorPicker.tsx:36

Aria label for apply button


applyTitle?

ts
optional applyTitle?: string;

Defined in: packages/react/src/components/VizelColorPicker.tsx:34

Title for apply button


className?

ts
optional className?: string;

Defined in: packages/react/src/components/VizelColorPicker.tsx:20

Custom class name


colors

ts
colors: readonly VizelColorDefinition[];

Defined in: packages/react/src/components/VizelColorPicker.tsx:12

Color palette to display


hexPlaceholder?

ts
optional hexPlaceholder?: string;

Defined in: packages/react/src/components/VizelColorPicker.tsx:32

Placeholder for hex input


label?

ts
optional label?: string;

Defined in: packages/react/src/components/VizelColorPicker.tsx:18

Label for accessibility


noneValues?

ts
optional noneValues?: string[];

Defined in: packages/react/src/components/VizelColorPicker.tsx:28

"None" option color values (e.g., ["transparent", "inherit"])


onChange

ts
onChange: (color) => void;

Defined in: packages/react/src/components/VizelColorPicker.tsx:16

Callback when color is selected

Parameters

ParameterType
colorstring

Returns

void


recentColors?

ts
optional recentColors?: string[];

Defined in: packages/react/src/components/VizelColorPicker.tsx:24

Recent colors to display


recentLabel?

ts
optional recentLabel?: string;

Defined in: packages/react/src/components/VizelColorPicker.tsx:30

Label for recent colors section


showRecentColors?

ts
optional showRecentColors?: boolean;

Defined in: packages/react/src/components/VizelColorPicker.tsx:26

Show recent colors section (default: true)


value?

ts
optional value?: string;

Defined in: packages/react/src/components/VizelColorPicker.tsx:14

Currently selected color

Released under the MIT License.