IColorPickerFieldProps

interface
Form & Input

Props for OrigamColorPickerField — a text-field that opens an inline ColorPicker menu, inheriting the full field + input pipeline (validation, density, adjacent, transition).

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

menu
boolean
Control the open/closed state of the colour picker menu programmatically.
menuProps
IMenuProps
Props passed through to the underlying OrigamMenu component (offset, placement, z-index, etc.).
openOnClear
boolean
Reopen the picker menu when the clear button is activated.
closeText
string
Label of the close/confirm button at the bottom of the picker panel.
openText
string
Accessible label of the trigger button that opens the picker.
closeOnSelect
boolean
Automatically close the picker when a colour is committed (click outside or confirm).

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Colour picker field with label and close-on-select

vue