IColorPickerProps

interface
Color

Props for OrigamColorPicker — a full-featured HSVA colour picker that composes Canvas, Preview, Edit and Swatches sub-components with optional sections controlled via hide* / show* flags.

TypeScript

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

Héritage

Hérite de

Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

canvasHeight
string | number
Height of the 2-D canvas surface. Number → px.
canvasWidth
string | number
Width of the 2-D canvas surface. Number → px.
hideCanvas
boolean
Hide the saturation/brightness 2-D canvas.
hideSliders
boolean
Hide the hue and alpha slider strip (preview row).
hideInputs
boolean
Hide the text-field input row (edit area).
showSwatches
boolean
Show the swatches palette.
swatchesMaxHeight
string | number
Max height of the swatches section. Number → px.
modelValue
Record<string, unknown> | string | undefined | null
The bound colour value — accepts an object (RGBA, HSVA, …) or a string (HEX, named colour). Synced via update:modelValue.

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Basic colour picker with v-model

vue

Minimal picker — canvas only, no inputs or swatches

vue