Color Field
A text input for specifying color values, supporting formats like HEX, RGB, and HSL for precise color selection.
Basic
A color field allows users to adjust a hex color or manipulate individual color channels.
Installation
If you hit any issues, make sure you check out the installation guide here for more information.
Composed Components
When you install this component via the CLI, it automatically loads all composed components, so you don’t need to add them individually.
The Color Field comes packed with several components to enhance functionality and provide a seamless experience.
Manual Installation
Make sure you also install the composed components and the required packages for the component to function properly.
Anatomy
Prefix
A color field can include a prefix to provide context or functionality.
Suffix
A color field can also have a suffix.
Controlled
Manage the color field in a controlled manner to automatically update the ColorSwatch and display the current color.
You can typically click the color swatch to open the color picker. To disable this feature, set enableColorPicker to false.
Disabled
You can disable the color field, making it non-interactive.
Validation
In this example, we’ll ensure it’s treated as a strict requirement.
Props
The ColorField component includes all standard props from react-aria-components, plus these additional features:
| Property | Type | Optional |
|---|---|---|
| label | string | Yes |
| description | string | Yes |
| errorMessage | string | ((validation: ValidationResult) => string) | Yes |
| placeholder | string | Yes |
| prefix | React.ReactNode | Yes |
| suffix | React.ReactNode | Yes |
| isLoading | boolean | Yes |
| enableColorPicker | boolean | Yes ( default: true) |