ColorField
A text input for entering hex color values with a color preview swatch.
Basic
Controlled
Error
Props
| Prop | Type | Default | Description |
|---|---|---|---|
value | string | — | The current hex color value (controlled). |
defaultValue | string | — | The initial hex color value (uncontrolled). |
onValueChange | (value: string) => void | — | Called when the color value changes. |
label | string | — | Label displayed above the color field. |
error | string | — | Error message displayed below the input. |
--mantle-bg | CSS variable | theme default | Override the background color via style. e.g. style={{ "--mantle-bg": "#1a1a2e" }} |
--mantle-border | CSS variable | theme default | Override the border color via style. Set to "transparent" to remove. e.g. style={{ "--mantle-border": "#e94560" }} |
--mantle-text | CSS variable | theme default | Override the text color via style. e.g. style={{ "--mantle-text": "#ffffff" }} |
--mantle-ring | CSS variable | accent | Override the focus ring color via style. e.g. style={{ "--mantle-ring": "#e94560" }} |
valuestringThe current hex color value (controlled).
defaultValuestringThe initial hex color value (uncontrolled).
onValueChange(value: string) => voidCalled when the color value changes.
labelstringLabel displayed above the color field.
errorstringError message displayed below the input.
--mantle-bgtheme defaultCSS variableOverride the background color via style. e.g. style={{ "--mantle-bg": "#1a1a2e" }}
--mantle-bordertheme defaultCSS variableOverride the border color via style. Set to "transparent" to remove. e.g. style={{ "--mantle-border": "#e94560" }}
--mantle-texttheme defaultCSS variableOverride the text color via style. e.g. style={{ "--mantle-text": "#ffffff" }}
--mantle-ringaccentCSS variableOverride the focus ring color via style. e.g. style={{ "--mantle-ring": "#e94560" }}