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
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
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.
- canvasHeightstring | number
- Height of the 2-D canvas surface. Number → px.
- canvasWidthstring | number
- Width of the 2-D canvas surface. Number → px.
- hideCanvasboolean
- Hide the saturation/brightness 2-D canvas.
- hideSlidersboolean
- Hide the hue and alpha slider strip (preview row).
- hideInputsboolean
- Hide the text-field input row (edit area).
- showSwatchesboolean
- Show the swatches palette.
- swatchesMaxHeightstring | number
- Max height of the swatches section. Number → px.
- modelValueRecord<string, unknown> | string | undefined | null
- The bound colour value — accepts an object (RGBA, HSVA, …) or a string (HEX, named colour). Synced via update:modelValue.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Basic colour picker with v-model
Minimal picker — canvas only, no inputs or swatches