IColorPickerCanvasProps
interface
Color
Props for OrigamColorPickerCanvas — the 2-D saturation/brightness gradient surface that the user drags to pick a colour.
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.
- colorHsvTHSVA | null
- The current colour as an HSVA tuple. The canvas renders the gradient for the active hue and positions the thumb at the corresponding saturation/brightness.
- disabledboolean
- Prevent user interaction with the canvas.
- dotSizestring | number
- Diameter of the draggable thumb indicator. Number → px.
- ariaLabelstring
- Accessible label for the canvas drag area (used by screen readers).
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Standalone canvas with controlled HSVA