ColorField

A color field allows users to edit a hex color or individual color channel value.

install	`yarn add react-aria-components`
version	1.4.0
usage	`import {ColorField} from 'react-aria-components'`

View ARIA pattern

W3C

Example#

import {ColorField, Label, Input} from 'react-aria-components';

<ColorField defaultValue="#ff0">
  <Label>Primary Color</Label>
  <Input />
</ColorField>

import {
  ColorField,
  Input,
  Label
} from 'react-aria-components';

<ColorField defaultValue="#ff0">
  <Label>Primary Color</Label>
  <Input />
</ColorField>

import {
  ColorField,
  Input,
  Label
} from 'react-aria-components';

<ColorField defaultValue="#ff0">
  <Label>
    Primary Color
  </Label>
  <Input />
</ColorField>

Show CSS

@import "@react-aria/example-theme";

.react-aria-ColorField {
  display: flex;
  flex-direction: column;
  color: var(--text-color);

  .react-aria-Input {
    padding: 0.286rem;
    margin: 0;
    border: 1px solid var(--border-color);
    border-radius: 6px;
    background: var(--field-background);
    font-size: 1.143rem;
    color: var(--field-text-color);
    width: 100%;
    max-width: 12ch;
    box-sizing: border-box;

    &[data-focused] {
      outline: 2px solid var(--focus-ring-color);
      outline-offset: -1px;
    }
  }
}

@import "@react-aria/example-theme";

.react-aria-ColorField {
  display: flex;
  flex-direction: column;
  color: var(--text-color);

  .react-aria-Input {
    padding: 0.286rem;
    margin: 0;
    border: 1px solid var(--border-color);
    border-radius: 6px;
    background: var(--field-background);
    font-size: 1.143rem;
    color: var(--field-text-color);
    width: 100%;
    max-width: 12ch;
    box-sizing: border-box;

    &[data-focused] {
      outline: 2px solid var(--focus-ring-color);
      outline-offset: -1px;
    }
  }
}

@import "@react-aria/example-theme";

.react-aria-ColorField {
  display: flex;
  flex-direction: column;
  color: var(--text-color);

  .react-aria-Input {
    padding: 0.286rem;
    margin: 0;
    border: 1px solid var(--border-color);
    border-radius: 6px;
    background: var(--field-background);
    font-size: 1.143rem;
    color: var(--field-text-color);
    width: 100%;
    max-width: 12ch;
    box-sizing: border-box;

    &[data-focused] {
      outline: 2px solid var(--focus-ring-color);
      outline-offset: -1px;
    }
  }
}

Features#

The <input type="color"> HTML element can be used to build a color picker, however it is very inconsistent across browsers and operating systems and consists of a complete color picker rather than a single field for editing a hex value or individual color channel. ColorField helps achieve accessible color fields that can be styled as needed.

Interactions – Supports entering a value using a keyboard, incrementing and decrementing with the arrow keys, and adjusting the value with the scroll wheel.
Validation – Keyboard input is validated as the user types so that only valid characters are accepted. Custom client and server-side validation is also supported.
Accessible – Follows the spinbutton ARIA pattern. Extensively tested across many devices and assistive technologies to ensure announcements and behaviors are consistent.

Anatomy#

A color field consists of an input element and a label. It also supports optional description and error message elements, which can be used to provide more context about the field, and any validation messages.

import {ColorField, FieldError, Input, Label, Text} from 'react-aria-components';

<ColorField>
  <Label />
  <Input />
  <Text slot="description" />
  <FieldError />
</ColorField>

import {
  ColorField,
  FieldError,
  Input,
  Label,
  Text
} from 'react-aria-components';

<ColorField>
  <Label />
  <Input />
  <Text slot="description" />
  <FieldError />
</ColorField>

import {
  ColorField,
  FieldError,
  Input,
  Label,
  Text
} from 'react-aria-components';

<ColorField>
  <Label />
  <Input />
  <Text slot="description" />
  <FieldError />
</ColorField>

If there is no visual label, an aria-label or aria-labelledby prop must be passed instead to identify the element to screen readers.

Concepts#

ColorField makes use of the following concepts:

Forms

Validating and submitting form data, and integrating with form libraries.

Composed components#

A ColorField uses the following components, which may also be used standalone or reused in other components.

Label

A label provides context for an input element.

Input

An input allows a user to enter a plain text value with a keyboard.

Starter kits#

To help kick-start your project, we offer starter kits that include example implementations of all React Aria components with various styling solutions. All components are fully styled, including support for dark mode, high contrast mode, and all UI states. Each starter comes with a pre-configured Storybook that you can experiment with, or use as a starting point for your own component library.

Reusable wrappers#

If you will use a ColorField in multiple places in your app, you can wrap all of the pieces into a reusable component. This way, the DOM structure, styling code, and other logic are defined in a single place and reused everywhere to ensure consistency.

This example wraps ColorField and all of its children together into a single component which accepts a label prop, which is passed to the right place. It also shows how to use the description slot to render help text, and FieldError component to render validation errors.

import type {ColorFieldProps, ValidationResult} from 'react-aria-components';
import {FieldError, Text} from 'react-aria-components';

interface MyColorFieldProps extends ColorFieldProps {
  label?: string;
  description?: string;
  errorMessage?: string | ((validation: ValidationResult) => string);
}

export function MyColorField(
  { label, description, errorMessage, ...props }: MyColorFieldProps
) {
  return (
    <ColorField {...props}>
      {label && <Label>{label}</Label>}
      <Input />
      {description && <Text slot="description">{description}</Text>}
      <FieldError>{errorMessage}</FieldError>
    </ColorField>
  );
}

<MyColorField label="Color" />

import type {
  ColorFieldProps,
  ValidationResult
} from 'react-aria-components';
import {FieldError, Text} from 'react-aria-components';

interface MyColorFieldProps extends ColorFieldProps {
  label?: string;
  description?: string;
  errorMessage?:
    | string
    | ((validation: ValidationResult) => string);
}

export function MyColorField(
  { label, description, errorMessage, ...props }:
    MyColorFieldProps
) {
  return (
    <ColorField {...props}>
      {label && <Label>{label}</Label>}
      <Input />
      {description && (
        <Text slot="description">{description}</Text>
      )}
      <FieldError>{errorMessage}</FieldError>
    </ColorField>
  );
}

<MyColorField label="Color" />

import type {
  ColorFieldProps,
  ValidationResult
} from 'react-aria-components';
import {
  FieldError,
  Text
} from 'react-aria-components';

interface MyColorFieldProps
  extends
    ColorFieldProps {
  label?: string;
  description?: string;
  errorMessage?:
    | string
    | ((
      validation:
        ValidationResult
    ) => string);
}

export function MyColorField(
  {
    label,
    description,
    errorMessage,
    ...props
  }: MyColorFieldProps
) {
  return (
    <ColorField
      {...props}
    >
      {label && (
        <Label>
          {label}
        </Label>
      )}
      <Input />
      {description && (
        <Text slot="description">
          {description}
        </Text>
      )}
      <FieldError>
        {errorMessage}
      </FieldError>
    </ColorField>
  );
}

<MyColorField label="Color" />

Value#

A ColorField accepts either a color string or Color object as a value.

Uncontrolled#

By default, ColorField is uncontrolled. You can set a default value using the defaultValue prop.

<MyColorField label="Color" defaultValue="#7f007f" />

<MyColorField label="Color" defaultValue="#7f007f" />

<MyColorField
  label="Color"
  defaultValue="#7f007f"
/>

Controlled#

A ColorField can be made controlled. The parseColor function is used to parse the initial color from a hex string, stored in state. The value and onChange props are used to update the value in state when the edits the value.

import {parseColor} from 'react-aria-components';

function Example() {
  let [color, setColor] = React.useState(parseColor('#7f007f'));
  return (
    <>
      <MyColorField label="Color" value={color} onChange={setColor} />
      <p>Current color value: {color?.toString('hex')}</p>
    </>
  );
}

import {parseColor} from 'react-aria-components';

function Example() {
  let [color, setColor] = React.useState(
    parseColor('#7f007f')
  );
  return (
    <>
      <MyColorField
        label="Color"
        value={color}
        onChange={setColor}
      />
      <p>Current color value: {color?.toString('hex')}</p>
    </>
  );
}

import {parseColor} from 'react-aria-components';

function Example() {
  let [color, setColor] =
    React.useState(
      parseColor(
        '#7f007f'
      )
    );
  return (
    <>
      <MyColorField
        label="Color"
        value={color}
        onChange={setColor}
      />
      <p>
        Current color
        value:{' '}
        {color?.toString(
          'hex'
        )}
      </p>
    </>
  );
}

HTML forms#

ColorField supports the name prop for integration with HTML forms. The value will be submitted to the server as a hex color string. When a channel prop is provided, the value will be submitted as a number instead.

<MyColorField label="Color" name="color" />

<MyColorField label="Color" name="color" />

<MyColorField
  label="Color"
  name="color"
/>

Color channel#

By default, ColorField allows the user to edit the color as a hex value. When the colorSpace and channel props are provided, ColorField displays the value for that channel formatted as a number instead. Rendering multiple ColorFields together can allow a user to edit a color.

function Example() {
  let [color, setColor] = React.useState(parseColor('#7f007f'));
  return (
    <>
      <div style={{ display: 'flex', gap: 8 }}>
        <MyColorField
          label="Hue"
          value={color}
          onChange={setColor}
          colorSpace="hsl"
          channel="hue"
        />
        <MyColorField
          label="Saturation"
          value={color}
          onChange={setColor}
          colorSpace="hsl"
          channel="saturation"
        />
        <MyColorField
          label="Lightness"
          value={color}
          onChange={setColor}
          colorSpace="hsl"
          channel="lightness"
        />
      </div>
      <p>Current color value: {color?.toString('hex')}</p>
    </>
  );
}

function Example() {
  let [color, setColor] = React.useState(
    parseColor('#7f007f')
  );
  return (
    <>
      <div style={{ display: 'flex', gap: 8 }}>
        <MyColorField
          label="Hue"
          value={color}
          onChange={setColor}
          colorSpace="hsl"
          channel="hue"
        />
        <MyColorField
          label="Saturation"
          value={color}
          onChange={setColor}
          colorSpace="hsl"
          channel="saturation"
        />
        <MyColorField
          label="Lightness"
          value={color}
          onChange={setColor}
          colorSpace="hsl"
          channel="lightness"
        />
      </div>
      <p>Current color value: {color?.toString('hex')}</p>
    </>
  );
}

function Example() {
  let [color, setColor] =
    React.useState(
      parseColor(
        '#7f007f'
      )
    );
  return (
    <>
      <div
        style={{
          display:
            'flex',
          gap: 8
        }}
      >
        <MyColorField
          label="Hue"
          value={color}
          onChange={setColor}
          colorSpace="hsl"
          channel="hue"
        />
        <MyColorField
          label="Saturation"
          value={color}
          onChange={setColor}
          colorSpace="hsl"
          channel="saturation"
        />
        <MyColorField
          label="Lightness"
          value={color}
          onChange={setColor}
          colorSpace="hsl"
          channel="lightness"
        />
      </div>
      <p>
        Current color
        value:{' '}
        {color?.toString(
          'hex'
        )}
      </p>
    </>
  );
}

Validation#

ColorField supports the isRequired prop to ensure the user enters a value, as well as custom validation functions, realtime validation, and server-side validation. It can also be integrated with other form libraries. See the Forms guide to learn more.

To display validation errors, add a <FieldError> element as a child of the ColorField. This allows you to render error messages from all of the above sources with consistent custom styles.

import {Form, FieldError, Button} from 'react-aria-components';

<Form>
  <ColorField name="color" isRequired>    <Label>Color</Label>
    <Input />
    <FieldError />  </ColorField>
  <Button type="submit">Submit</Button>
</Form>

import {
  Button,
  FieldError,
  Form
} from 'react-aria-components';

<Form>
  <ColorField name="color" isRequired>    <Label>Color</Label>
    <Input />
    <FieldError />  </ColorField>
  <Button type="submit">Submit</Button>
</Form>

import {
  Button,
  FieldError,
  Form
} from 'react-aria-components';

<Form>
  <ColorField
    name="color"
    isRequired
  >    <Label>
      Color
    </Label>
    <Input />
    <FieldError />  </ColorField>
  <Button type="submit">
    Submit
  </Button>
</Form>

Show CSS

.react-aria-ColorField {
  &[data-invalid] {
    .react-aria-Input {
      border-color: var(--invalid-color);
    }
  }

  .react-aria-FieldError {
    font-size: 12px;
    color: var(--invalid-color);
  }
}

.react-aria-ColorField {
  &[data-invalid] {
    .react-aria-Input {
      border-color: var(--invalid-color);
    }
  }

  .react-aria-FieldError {
    font-size: 12px;
    color: var(--invalid-color);
  }
}

.react-aria-ColorField {
  &[data-invalid] {
    .react-aria-Input {
      border-color: var(--invalid-color);
    }
  }

  .react-aria-FieldError {
    font-size: 12px;
    color: var(--invalid-color);
  }
}

By default, FieldError displays default validation messages provided by the browser. See Customizing error messages in the Forms guide to learn how to provide your own custom errors.

Description#

The description slot can be used to associate additional help text with a color field.

<ColorField>
  <Label>Color</Label>
  <Input />
  <Text slot="description">Enter a background color.</Text></ColorField>

<ColorField>
  <Label>Color</Label>
  <Input />
  <Text slot="description">Enter a background color.</Text></ColorField>

<ColorField>
  <Label>Color</Label>
  <Input />
  <Text slot="description">
    Enter a background
    color.
  </Text></ColorField>

Show CSS

.react-aria-ColorField {
  [slot=description] {
    font-size: 12px;
  }
}

.react-aria-ColorField {
  [slot=description] {
    font-size: 12px;
  }
}

.react-aria-ColorField {
  [slot=description] {
    font-size: 12px;
  }
}

Disabled#

The isDisabled prop can be used prevent the user from editing the value of the color field.

<MyColorField label="Disabled" defaultValue="#7f007f" isDisabled />

<MyColorField
  label="Disabled"
  defaultValue="#7f007f"
  isDisabled
/>

<MyColorField
  label="Disabled"
  defaultValue="#7f007f"
  isDisabled
/>

Show CSS

.react-aria-ColorField {
  .react-aria-Input {
    &[data-disabled] {
      border-color: var(--border-color-disabled);
      color: var(--text-color-disabled);
    }
  }
}

.react-aria-ColorField {
  .react-aria-Input {
    &[data-disabled] {
      border-color: var(--border-color-disabled);
      color: var(--text-color-disabled);
    }
  }
}

.react-aria-ColorField {
  .react-aria-Input {
    &[data-disabled] {
      border-color: var(--border-color-disabled);
      color: var(--text-color-disabled);
    }
  }
}

Read only#

The isReadOnly prop makes the ColorField's value immutable. Unlike isDisabled, the ColorField remains focusable and the contents can still be copied. See the MDN docs for more information.

<MyColorField label="Read only" isReadOnly value="#7f007f" />

<MyColorField
  label="Read only"
  isReadOnly
  value="#7f007f"
/>

<MyColorField
  label="Read only"
  isReadOnly
  value="#7f007f"
/>

Props#

ColorField#

Name	Type	Default	Description
`channel`	`ColorChannel`	—	The color channel that this field edits. If not provided, the color is edited as a hex value.
`colorSpace`	`ColorSpace`	—	The color space that the color field operates in if a `channel` prop is provided. If no `channel` is provided, the color field always displays the color as an RGB hex value.
`isWheelDisabled`	`boolean`	—	Enables or disables changing the value with scroll.
`value`	`T`	—	The current value (controlled).
`defaultValue`	`T`	—	The default value (uncontrolled).
`isDisabled`	`boolean`	—	Whether the input is disabled.
`isReadOnly`	`boolean`	—	Whether the input can be selected but not changed by the user.
`isRequired`	`boolean`	—	Whether user input is required on the input before form submission.
`isInvalid`	`boolean`	—	Whether the input value is invalid.
`validate`	`( (value: Color \| \| null )) => ValidationError \| true \| null \| undefined`	—	A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.
`name`	`string`	—	The name of the input element, used when submitting an HTML form. See MDN.
`validationBehavior`	`'native' \| 'aria'`	`'native'`	Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
`children`	`ReactNode \| ( (values: ColorFieldRenderProps & & {defaultChildren: ReactNode \| \| undefined } )) => ReactNode`	—	The children of the component. A function may be provided to alter the children based on component state.
`className`	`string \| ( (values: ColorFieldRenderProps & & {defaultClassName: string \| \| undefined } )) => string`	—	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: ColorFieldRenderProps & & {defaultStyle: CSSProperties } )) => CSSProperties \| undefined`	—	The inline style for the element. A function may be provided to compute the style based on component state.

Events

Name	Type	Description
`onChange`	`( (color: Color \| \| null )) => void`	Handler that is called when the value changes.
`onFocus`	`( (e: FocusEvent<Target> )) => void`	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent<Target> )) => void`	Handler that is called when the element loses focus.
`onFocusChange`	`( (isFocused: boolean )) => void`	Handler that is called when the element's focus status changes.
`onKeyDown`	`( (e: KeyboardEvent )) => void`	Handler that is called when a key is pressed.
`onKeyUp`	`( (e: KeyboardEvent )) => void`	Handler that is called when a key is released.
`onCopy`	`ClipboardEventHandler<HTMLInputElement>`	Handler that is called when the user copies text. See MDN.
`onCut`	`ClipboardEventHandler<HTMLInputElement>`	Handler that is called when the user cuts text. See MDN.
`onPaste`	`ClipboardEventHandler<HTMLInputElement>`	Handler that is called when the user pastes text. See MDN.
`onCompositionStart`	`CompositionEventHandler<HTMLInputElement>`	Handler that is called when a text composition system starts a new text composition session. See MDN.
`onCompositionEnd`	`CompositionEventHandler<HTMLInputElement>`	Handler that is called when a text composition system completes or cancels the current text composition session. See MDN.
`onCompositionUpdate`	`CompositionEventHandler<HTMLInputElement>`	Handler that is called when a new character is received in the current text composition session. See MDN.
`onSelect`	`ReactEventHandler<HTMLInputElement>`	Handler that is called when text in the input is selected. See MDN.
`onBeforeInput`	`FormEventHandler<HTMLInputElement>`	Handler that is called when the input value is about to be modified. See MDN.
`onInput`	`FormEventHandler<HTMLInputElement>`	Handler that is called when the input value is modified. See MDN.

Layout

Name	Type	Description
`slot`	`string \| null`	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.

Accessibility

Name	Type	Description
`id`	`string`	The element's unique identifier. See MDN.
`excludeFromTabOrder`	`boolean`	Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
`aria-label`	`string`	Defines a string value that labels the current element.
`aria-labelledby`	`string`	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	Identifies the element (or elements) that provide a detailed, extended description for the object.
`aria-errormessage`	`string`	Identifies the element that provides an error message for the object.

Label#

A <Label> accepts all HTML attributes.

Input#

An <Input> accepts all props supported by the <input> HTML element.

FieldError#

A <FieldError> displays validation errors.

Show props

Name	Type	Description
`children`	`ReactNode \| ( (values: FieldErrorRenderProps & & {defaultChildren: ReactNode \| \| undefined } )) => ReactNode`	The children of the component. A function may be provided to alter the children based on component state.
`className`	`string \| ( (values: FieldErrorRenderProps & & {defaultClassName: string \| \| undefined } )) => string`	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: FieldErrorRenderProps & & {defaultStyle: CSSProperties } )) => CSSProperties \| undefined`	The inline style for the element. A function may be provided to compute the style based on component state.

Accessibility

Name	Type	Description
`id`	`string`	The element's unique identifier. See MDN.

Styling#

React Aria components can be styled in many ways, including using CSS classes, inline styles, utility classes (e.g. Tailwind), CSS-in-JS (e.g. Styled Components), etc. By default, all components include a builtin className attribute which can be targeted using CSS selectors. These follow the react-aria-ComponentName naming convention.

.react-aria-ColorField {
  /* ... */
}

.react-aria-ColorField {
  /* ... */
}

.react-aria-ColorField {
  /* ... */
}

A custom className can also be specified on any component. This overrides the default className provided by React Aria with your own.

<ColorField className="my-color-field">
  {/* ... */}
</ColorField>

<ColorField className="my-color-field">
  {/* ... */}
</ColorField>

<ColorField className="my-color-field">
  {/* ... */}
</ColorField>

In addition, some components support multiple UI states (e.g. focused, placeholder, readonly, etc.). React Aria components expose states using data attributes, which you can target in CSS selectors. For example:

.react-aria-Input[data-focus-visible] {
  /* ... */
}

.react-aria-Input[data-focus-visible] {
  /* ... */
}

.react-aria-Input[data-focus-visible] {
  /* ... */
}

The className and style props also accept functions which receive states for styling. This lets you dynamically determine the classes or styles to apply, which is useful when using utility CSS libraries like Tailwind.

<Input
  className={({ isFocused }) =>
    isFocused ? 'border-blue-500' : 'border-gray-600'}
/>

<Input
  className={({ isFocused }) =>
    isFocused ? 'border-blue-500' : 'border-gray-600'}
/>

<Input
  className={(
    { isFocused }
  ) =>
    isFocused
      ? 'border-blue-500'
      : 'border-gray-600'}
/>

The states, selectors, and render props for each component used in a ColorField are documented below.

ColorField#

A ColorField can be targeted with the .react-aria-ColorField CSS selector, or by overriding with a custom className. It supports the following states:

Name	CSS Selector	Description
`isDisabled`	`[data-disabled]`	Whether the color field is disabled.
`isInvalid`	`[data-invalid]`	Whether the color field is invalid.
`channel`	`[data-channel="hex \| hue \| saturation \| ..."]`	The color channel that this field edits, or "hex" if no `channel` prop is set.
`state`	`—`	State of the color field.

Label#

A Label can be targeted with the .react-aria-Label CSS selector, or by overriding with a custom className.

Input#

An Input can be targeted with the .react-aria-Input CSS selector, or by overriding with a custom className. It supports the following states:

Name	CSS Selector	Description
`isHovered`	`[data-hovered]`	Whether the input is currently hovered with a mouse.
`isFocused`	`[data-focused]`	Whether the input is focused, either via a mouse or keyboard.
`isFocusVisible`	`[data-focus-visible]`	Whether the input is keyboard focused.
`isDisabled`	`[data-disabled]`	Whether the input is disabled.
`isInvalid`	`[data-invalid]`	Whether the input is invalid.

Text#

The help text elements within a ColorField can be targeted with the [slot=description] and [slot=errorMessage] CSS selectors, or by adding a custom className.

FieldError#

A FieldError can be targeted with the .react-aria-FieldError CSS selector, or by overriding with a custom className. It supports the following render props:

Name	Description
`isInvalid`	Whether the input value is invalid.
`validationErrors`	The current error messages for the input if it is invalid, otherwise an empty array.
`validationDetails`	The native validation details for the input.

Advanced customization#

Composition#

If you need to customize one of the components within a ColorField, such as Label or Input, in many cases you can create a wrapper component. This lets you customize the props passed to the component.

function MyInput(props) {
  return <Input {...props} className="my-input" />
}

function MyInput(props) {
  return <Input {...props} className="my-input" />
}

function MyInput(props) {
  return (
    <Input
      {...props}
      className="my-input"
    />
  );
}

Contexts#

All React Aria Components export a corresponding context that can be used to send props to them from a parent element. This enables you to build your own compositional APIs similar to those found in React Aria Components itself. You can send any prop or ref via context that you could pass to the corresponding component. The local props and ref on the component are merged with the ones passed via context, with the local props taking precedence (following the rules documented in mergeProps).

Component	Context	Props	Ref
`ColorField`	`ColorFieldContext`	`ColorFieldProps`	`HTMLDivElement`

This example shows a FieldGroup component that renders a group of color fields with a title. The entire group can be marked as read only via the isReadOnly prop, which is passed to all child color fields via the ColorFieldContext provider.

import {ColorFieldContext} from 'react-aria-components';

interface FieldGroupProps {
  title?: string,
  children?: React.ReactNode,
  isReadOnly?: boolean
}

function FieldGroup({title, children, isReadOnly}: FieldGroupProps) {
  return (
    <fieldset>
      <legend>{title}</legend>
      <ColorFieldContext.Provider value={{isReadOnly}}>        {children}
      </ColorFieldContext.Provider>
    </fieldset>
  );
}

<FieldGroup title="Colors" isReadOnly>
  <MyColorField label="Background" defaultValue="#fff" />
  <MyColorField label="Foreground" defaultValue="#000" />
</FieldGroup>

import {ColorFieldContext} from 'react-aria-components';

interface FieldGroupProps {
  title?: string;
  children?: React.ReactNode;
  isReadOnly?: boolean;
}

function FieldGroup(
  { title, children, isReadOnly }: FieldGroupProps
) {
  return (
    <fieldset>
      <legend>{title}</legend>
      <ColorFieldContext.Provider value={{ isReadOnly }}>        {children}
      </ColorFieldContext.Provider>
    </fieldset>
  );
}

<FieldGroup title="Colors" isReadOnly>
  <MyColorField label="Background" defaultValue="#fff" />
  <MyColorField label="Foreground" defaultValue="#000" />
</FieldGroup>

import {ColorFieldContext} from 'react-aria-components';

interface FieldGroupProps {
  title?: string;
  children?:
    React.ReactNode;
  isReadOnly?: boolean;
}

function FieldGroup(
  {
    title,
    children,
    isReadOnly
  }: FieldGroupProps
) {
  return (
    <fieldset>
      <legend>
        {title}
      </legend>
      <ColorFieldContext.Provider
        value={{
          isReadOnly
        }}
      >        {children}
      </ColorFieldContext.Provider>
    </fieldset>
  );
}

<FieldGroup
  title="Colors"
  isReadOnly
>
  <MyColorField
    label="Background"
    defaultValue="#fff"
  />
  <MyColorField
    label="Foreground"
    defaultValue="#000"
  />
</FieldGroup>

Show CSS

fieldset {
  padding: 1.5em;
  width: fit-content;
}

fieldset {
  padding: 1.5em;
  width: fit-content;
}

fieldset {
  padding: 1.5em;
  width: fit-content;
}

Custom children#

ColorField passes props to its child components, such as the label and input, via their associated contexts. These contexts are exported so you can also consume them in your own custom components. This enables you to reuse existing components from your app or component library together with React Aria Components.

Component	Context	Props	Ref
`Label`	`LabelContext`	`LabelProps`	`HTMLLabelElement`
`Input`	`InputContext`	`InputProps`	`HTMLInputElement`
`Text`	`TextContext`	`TextProps`	`HTMLElement`

This example consumes from LabelContext in an existing styled label component to make it compatible with React Aria Components. The useContextProps hook merges the local props and ref with the ones provided via context by ColorField.

import type {LabelProps} from 'react-aria-components';
import {LabelContext, useContextProps} from 'react-aria-components';

const MyCustomLabel = React.forwardRef(
  (props: LabelProps, ref: React.ForwardedRef<HTMLLabelElement>) => {
    // Merge the local props and ref with the ones provided via context.
    [props, ref] = useContextProps(props, ref, LabelContext);
    // ... your existing Label component
    return <label {...props} ref={ref} />;
  }
);

import type {LabelProps} from 'react-aria-components';
import {
  LabelContext,
  useContextProps
} from 'react-aria-components';

const MyCustomLabel = React.forwardRef(
  (
    props: LabelProps,
    ref: React.ForwardedRef<HTMLLabelElement>
  ) => {
    // Merge the local props and ref with the ones provided via context.
    [props, ref] = useContextProps(
      props,
      ref,
      LabelContext
    );
    // ... your existing Label component
    return <label {...props} ref={ref} />;
  }
);

import type {LabelProps} from 'react-aria-components';
import {
  LabelContext,
  useContextProps
} from 'react-aria-components';

const MyCustomLabel =
  React.forwardRef(
    (
      props: LabelProps,
      ref:
        React.ForwardedRef<
          HTMLLabelElement
        >
    ) => {
      // Merge the local props and ref with the ones provided via context.
      [props, ref] =
        useContextProps(
          props,
          ref,
          LabelContext
        );
      // ... your existing Label component
      return (
        <label
          {...props}
          ref={ref}
        />
      );
    }
  );

Now you can use MyCustomLabel within a ColorField, in place of the builtin React Aria Components Label.

<ColorField>
  <MyCustomLabel>Value</MyCustomLabel>  <Input />
</ColorField>

<ColorField>
  <MyCustomLabel>Value</MyCustomLabel>  <Input />
</ColorField>

<ColorField>
  <MyCustomLabel>
    Value
  </MyCustomLabel>  <Input />
</ColorField>

State#

ColorField provides a ColorFieldState object to its children via ColorFieldStateContext. This can be used to access and manipulate the ColorField's state.

Hooks#

If you need to customize things even further, such as accessing internal state or customizing DOM structure, you can drop down to the lower level Hook-based API. See useColorField for more details.

Represents a color value.

Method	Description
`toFormat( (format: ColorFormat )): Color`	Converts the color to the given color format, and returns a new Color object.
`toString( (format?: ColorFormat \| \| 'css' )): string`	Converts the color to a string in the given format.
`clone(): Color`	Returns a duplicate of the color value.
`toHexInt(): number`	Converts the color to hex, and returns an integer representation.
`getChannelValue( (channel: ColorChannel )): number`	Returns the numeric value for a given channel. Throws an error if the channel is unsupported in the current color format.
`withChannelValue( (channel: ColorChannel, , value: number )): Color`	Sets the numeric value for a given channel, and returns a new Color object. Throws an error if the channel is unsupported in the current color format.
`getChannelRange( (channel: ColorChannel )): ColorChannelRange`	Returns the minimum, maximum, and step values for a given channel.
`getChannelName( (channel: ColorChannel, , locale: string )): string`	Returns a localized color channel name for a given channel and locale, for use in visual or accessibility labels.
`getChannelFormatOptions( (channel: ColorChannel )): Intl.NumberFormatOptions`	Returns the number formatting options for the given channel.
`formatChannelValue( (channel: ColorChannel, , locale: string )): string`	Formats the numeric value for a given channel for display according to the provided locale.
`getColorSpace(): ColorSpace`	Returns the color space, 'rgb', 'hsb' or 'hsl', for the current color.
`getColorSpaceAxes( (xyChannels: {xChannel?: ColorChannel, yChannel?: ColorChannel } )): ColorAxes`	Returns the color space axes, xChannel, yChannel, zChannel.
`getColorChannels(): [ ColorChannel, ColorChannel, ColorChannel ]`	Returns an array of the color channels within the current color space space.
`getColorName( (locale: string )): string`	Returns a localized name for the color, for use in visual or accessibility labels.
`getHueName( (locale: string )): string`	Returns a localized name for the hue, for use in visual or accessibility labels.

A list of supported color formats.

'hex'
  | 'hexa'
  | 'rgb'
  | 'rgba'
  | 'hsl'
  | 'hsla'
  | 'hsb'
  | 'hsba'

A list of color channels.

'hue'
  | 'saturation'
  | 'brightness'
  | 'lightness'
  | 'red'
  | 'green'
  | 'blue'
  | 'alpha'

Name	Type	Description
`minValue`	`number`	The minimum value of the color channel.
`maxValue`	`number`	The maximum value of the color channel.
`step`	`number`	The step value of the color channel, used when incrementing and decrementing.
`pageSize`	`number`	The page step value of the color channel, used when incrementing and decrementing.

'rgb'
  | 'hsl'
  | 'hsb'

{xChannel: ColorChannel,
yChannel: ColorChannel,
zChannel: ColorChannel
}

Parses a color from a string value. Throws an error if the string could not be parsed.

parseColor(
  (value: string
)): Color

string | string[]

Name	Type	Description
`isDisabled`	`boolean`	Whether the color field is disabled.
`isInvalid`	`boolean`	Whether the color field is invalid.
`channel`	`ColorChannel \| 'hex'`	The color channel that this field edits, or "hex" if no `channel` prop is set.
`state`	`ColorFieldState`	State of the color field.

Properties

Name	Type	Description
`inputValue`	`string`	The current text value of the input. Updated as the user types, and formatted according to `formatOptions` on blur.
`colorValue`	`Color \| null`	The currently parsed color value, or null if the field is empty. Updated based on the `inputValue` as the user types.
`realtimeValidation`	`ValidationResult`	Realtime validation results, updated as the user edits the value.
`displayValidation`	`ValidationResult`	Currently displayed validation results, updated when the user commits their changes.

Methods

Method	Description
`setInputValue( (value: string )): void`	Sets the current text value of the input.
`commit(): void`	Updates the input value based on the currently parsed color value. Typically this is called when the field is blurred.
`increment(): void`	Increments the current input value to the next step boundary, and fires `onChange`.
`decrement(): void`	Decrements the current input value to the next step boundary, and fires `onChange`.
`incrementToMax(): void`	Sets the current value to the maximum color value, and fires `onChange`.
`decrementToMin(): void`	Sets the current value to the minimum color value, and fires `onChange`.
`validate( (value: string )): boolean`	Validates a user input string. Values can be partially entered, and may be valid even if they cannot currently be parsed to a color. Can be used to implement validation as a user types.
`updateValidation( (result: ValidationResult )): void`	Updates the current validation result. Not displayed to the user until `commitValidation` is called.
`resetValidation(): void`	Resets the displayed validation state to valid when the user resets the form.
`commitValidation(): void`	Commits the realtime validation so it is displayed to the user.

Name	Type	Description
`isInvalid`	`boolean`	Whether the input value is invalid.
`validationErrors`	`string[]`	The current error messages for the input if it is invalid, otherwise an empty array.
`validationDetails`	`ValidityState`	The native validation details for the input.

BaseEvent<ReactKeyboardEvent<any>>

SyntheticEvent & {stopPropagation: () => void,
continuePropagation: () => void
}

Name	Type	Description
`isInvalid`	`boolean`	Whether the input value is invalid.
`validationErrors`	`string[]`	The current error messages for the input if it is invalid, otherwise an empty array.
`validationDetails`	`ValidityState`	The native validation details for the input.

Name	Type	Default	Description
`channel`	`ColorChannel`	—	The color channel that this field edits. If not provided, the color is edited as a hex value.
`colorSpace`	`ColorSpace`	—	The color space that the color field operates in if a `channel` prop is provided. If no `channel` is provided, the color field always displays the color as an RGB hex value.
`isWheelDisabled`	`boolean`	—	Enables or disables changing the value with scroll.
`onChange`	`( (color: Color \| \| null )) => void`	—	Handler that is called when the value changes.
`value`	`T`	—	The current value (controlled).
`defaultValue`	`T`	—	The default value (uncontrolled).
`isDisabled`	`boolean`	—	Whether the input is disabled.
`isReadOnly`	`boolean`	—	Whether the input can be selected but not changed by the user.
`isRequired`	`boolean`	—	Whether user input is required on the input before form submission.
`isInvalid`	`boolean`	—	Whether the input value is invalid.
`validate`	`( (value: Color \| \| null )) => ValidationError \| true \| null \| undefined`	—	A function that returns an error message if a given value is invalid. Validation errors are displayed to the user when the form is submitted if `validationBehavior="native"`. For realtime validation, use the `isInvalid` prop instead.
`autoFocus`	`boolean`	—	Whether the element should receive focus on render.
`onFocus`	`( (e: FocusEvent<Target> )) => void`	—	Handler that is called when the element receives focus.
`onBlur`	`( (e: FocusEvent<Target> )) => void`	—	Handler that is called when the element loses focus.
`onFocusChange`	`( (isFocused: boolean )) => void`	—	Handler that is called when the element's focus status changes.
`onKeyDown`	`( (e: KeyboardEvent )) => void`	—	Handler that is called when a key is pressed.
`onKeyUp`	`( (e: KeyboardEvent )) => void`	—	Handler that is called when a key is released.
`aria-label`	`string`	—	Defines a string value that labels the current element.
`aria-labelledby`	`string`	—	Identifies the element (or elements) that labels the current element.
`aria-describedby`	`string`	—	Identifies the element (or elements) that describes the object.
`aria-details`	`string`	—	Identifies the element (or elements) that provide a detailed, extended description for the object.
`excludeFromTabOrder`	`boolean`	—	Whether to exclude the element from the sequential tab order. If true, the element will not be focusable via the keyboard by tabbing. This should be avoided except in rare scenarios where an alternative means of accessing the element or its functionality via the keyboard is available.
`id`	`string`	—	The element's unique identifier. See MDN.
`name`	`string`	—	The name of the input element, used when submitting an HTML form. See MDN.
`onCopy`	`ClipboardEventHandler<HTMLInputElement>`	—	Handler that is called when the user copies text. See MDN.
`onCut`	`ClipboardEventHandler<HTMLInputElement>`	—	Handler that is called when the user cuts text. See MDN.
`onPaste`	`ClipboardEventHandler<HTMLInputElement>`	—	Handler that is called when the user pastes text. See MDN.
`onCompositionStart`	`CompositionEventHandler<HTMLInputElement>`	—	Handler that is called when a text composition system starts a new text composition session. See MDN.
`onCompositionEnd`	`CompositionEventHandler<HTMLInputElement>`	—	Handler that is called when a text composition system completes or cancels the current text composition session. See MDN.
`onCompositionUpdate`	`CompositionEventHandler<HTMLInputElement>`	—	Handler that is called when a new character is received in the current text composition session. See MDN.
`onSelect`	`ReactEventHandler<HTMLInputElement>`	—	Handler that is called when text in the input is selected. See MDN.
`onBeforeInput`	`FormEventHandler<HTMLInputElement>`	—	Handler that is called when the input value is about to be modified. See MDN.
`onInput`	`FormEventHandler<HTMLInputElement>`	—	Handler that is called when the input value is modified. See MDN.
`aria-errormessage`	`string`	—	Identifies the element that provides an error message for the object.
`validationBehavior`	`'native' \| 'aria'`	`'native'`	Whether to use native HTML form validation to prevent form submission when the value is missing or invalid, or mark the field as required or invalid via ARIA.
`children`	`ReactNode \| ( (values: ColorFieldRenderProps & & {defaultChildren: ReactNode \| \| undefined } )) => ReactNode`	—	The children of the component. A function may be provided to alter the children based on component state.
`className`	`string \| ( (values: ColorFieldRenderProps & & {defaultClassName: string \| \| undefined } )) => string`	—	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: ColorFieldRenderProps & & {defaultStyle: CSSProperties } )) => CSSProperties \| undefined`	—	The inline style for the element. A function may be provided to compute the style based on component state.
`slot`	`string \| null`	—	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.

Name	Type	Description
`elementType`	`string`

Extends: InputHTMLAttributes

Name	Type	Description
`onHoverStart`	`( (e: HoverEvent )) => void`	Handler that is called when a hover interaction starts.
`onHoverEnd`	`( (e: HoverEvent )) => void`	Handler that is called when a hover interaction ends.
`onHoverChange`	`( (isHovering: boolean )) => void`	Handler that is called when the hover state changes.
`className`	`string \| ( (values: InputRenderProps & & {defaultClassName: string \| \| undefined } )) => string`	The CSS className for the element. A function may be provided to compute the class based on component state.
`style`	`CSSProperties \| ( (values: InputRenderProps & & {defaultStyle: CSSProperties } )) => CSSProperties \| undefined`	The inline style for the element. A function may be provided to compute the style based on component state.

Name	Type	Description
`type`	`'hoverstart' \| 'hoverend'`	The type of hover event being fired.
`pointerType`	`'mouse' \| 'pen'`	The pointer type that triggered the hover event.
`target`	`HTMLElement`	The target element of the hover event.

Name	Type	Description
`isHovered`	`boolean`	Whether the input is currently hovered with a mouse.
`isFocused`	`boolean`	Whether the input is focused, either via a mouse or keyboard.
`isFocusVisible`	`boolean`	Whether the input is keyboard focused.
`isDisabled`	`boolean`	Whether the input is disabled.
`isInvalid`	`boolean`	Whether the input is invalid.

Name	Type	Description
`elementType`	`string`

useContextProps<T, U extends SlotProps, E extends Element>(
  props: T
    &  & SlotProps,
  ref: ForwardedRef<E>,
  context: Context<ContextValue<U, E>>
): [
  T,
  RefObject<E
    | null>
]

Name	Type	Description
`slot`	`string \| null`	A slot name for the component. Slots allow the component to receive props from a parent component. An explicit `null` value indicates that the local props completely override all props received from a parent.

SlottedContextValue<WithRef<T, E>>

SlottedValue<T>
  | T
  | null
  | undefined

Name	Type	Description
`slots`	`Record<string \| symbol, T>`

T & {ref?: ForwardedRef<E>
}