ColorInput

A colour picker input.

Installation

pnpm dlx shadcn@latest add @chelone/color-input

A colour picker input.

Props

Prop	Type	Default	Description
alwaysOn	boolean	—	As a `<FilterForm>`/`<FilterButton>` filter: always shown, never in the add-filter menu. Read off the element by the filter layer, never by the input.
defaultValue	unknown	—	Input-level default, ra precedence (seeds only into an untouched hole).
disabled	boolean	—	Native disabled state.
format	(value: unknown) => unknown	—	Read transform (raw form value → input value).
helperText	ReactNode	—	Helper text rendered below the input; a string is translated.
id	string	—	Explicit element id; a generated `useId` value is used otherwise.
isRequired	boolean	—	Forces the required marker; ORed with `required()` detection on `validate`.
label	ReactNode	—	The input label. A string is translated; a ReactNode renders as-is; `false` (or `""`) renders no label.
mode	keyof ColorStringMap	—	Force the picker to output values in a specific mode.
name	string	—	Legacy field-name alias (ra parity); the wiring uses `source`.
native	boolean	—	Replace the popover picker with the browser's native `<input type="color">`.
onBlur	(event: unknown) => void	—	Chained AFTER the blur is recorded.
onChange	(eventOrValue: unknown) => void	—	Chained AFTER the parsed value is written to the form.
parse	(value: unknown) => unknown	—	Write transform (input value → stored value).
readOnly	boolean	—	Native read-only state.
resource	string	—	Override the ambient resource (used to resolve the default label key).
source	string	—	The field path RELATIVE to the ambient source scope.
swatches	readonly string[]	—	Quick-set color buttons rendered next to the picker trigger.
type	string	—	The DOM input `type` (text inputs default to `"text"`).
validate	Validator \| readonly Validator[]	—	ra-contract validators — composed, first error wins.