beta

ColorField

ColorFields allow users to enter a color in #rrggbb hexadecimal format.

installyarn add @react-spectrum/color
version3.0.0-beta.11
usageimport {ColorField} from '@react-spectrum/color'

Example#


<ColorField label="Primary Color" />
<ColorField label="Primary Color" />
<ColorField label="Primary Color" />

Value#


A ColorField's value is empty by default, but an initial, uncontrolled, value can be provided using the defaultValue prop. Alternatively, a controlled value can be provided using the value prop. Valid values are hexadecimal color codes. The parseColor function is used to parse the initial color from a hex value, stored in state.

import {parseColor} from '@react-stately/color';

function Example() {
  let [value, setValue] = React.useState(parseColor('#e73623'));

  return (
    <Flex gap="size-150" wrap>
      <ColorField
        label="Primary Color (Uncontrolled)"
        defaultValue="#e21" />

      <ColorField
        label="Primary Color (Controlled)"
        value={value}
        onChange={setValue} />
    </Flex>
  );
}
import {parseColor} from '@react-stately/color';

function Example() {
  let [value, setValue] = React.useState(
    parseColor('#e73623')
  );

  return (
    <Flex gap="size-150" wrap>
      <ColorField
        label="Primary Color (Uncontrolled)"
        defaultValue="#e21"
      />

      <ColorField
        label="Primary Color (Controlled)"
        value={value}
        onChange={setValue}
      />
    </Flex>
  );
}
import {parseColor} from '@react-stately/color';

function Example() {
  let [value, setValue] =
    React.useState(
      parseColor(
        '#e73623'
      )
    );

  return (
    <Flex
      gap="size-150"
      wrap
    >
      <ColorField
        label="Primary Color (Uncontrolled)"
        defaultValue="#e21"
      />

      <ColorField
        label="Primary Color (Controlled)"
        value={value}
        onChange={setValue}
      />
    </Flex>
  );
}

Labeling#


A visual label should be provided for the ColorField using the label prop. If the ColorField is required, the isRequired and necessityIndicator props can be used to show a required state.

<Flex gap="size-150" wrap>
  <ColorField label="Primary Color" />
  <ColorField label="Primary Color" isRequired />
  <ColorField label="Primary Color" isRequired necessityIndicator="label" />
  <ColorField label="Primary Color" necessityIndicator="label" />
</Flex>
<Flex gap="size-150" wrap>
  <ColorField label="Primary Color" />
  <ColorField label="Primary Color" isRequired />
  <ColorField
    label="Primary Color"
    isRequired
    necessityIndicator="label"
  />
  <ColorField
    label="Primary Color"
    necessityIndicator="label"
  />
</Flex>
<Flex
  gap="size-150"
  wrap
>
  <ColorField label="Primary Color" />
  <ColorField
    label="Primary Color"
    isRequired
  />
  <ColorField
    label="Primary Color"
    isRequired
    necessityIndicator="label"
  />
  <ColorField
    label="Primary Color"
    necessityIndicator="label"
  />
</Flex>

Accessibility#

If a visible label isn't specified, an aria-label must be provided to the ColorField for accessibility. If the field is labeled by a separate element, an aria-labelledby prop must be provided using the id of the labeling element instead.

Internationalization#

In order to internationalize a ColorField, a localized string should be passed to the label or aria-label prop. When the necessityIndicator prop is set to "label", a localized string will be provided for "(required)" or "(optional)" automatically.

Validation#


ColorField can display a validation state to communicate to the user whether the current value is valid or invalid. Implement your own validation logic in your app and pass either "valid" or "invalid" to the ColorField via the validationState prop.

The example below illustrates how one would validate if the user has entered a red color. In it, the parseColor function is used to parse the initial color from a hexadecimal string so that value's type remains consistent.

function Example() {
  let [value, setValue] = React.useState(parseColor('#e73623'));
  let isValid = React.useMemo(() => {
    return value && value.red && value.red > value.green &&
      value.red > value.blue;
  }, [value]);

  return (
    <ColorField
      validationState={isValid ? 'valid' : 'invalid'}
      value={value}
      onChange={setValue}
      label="Red colors"
    />
  );
}
function Example() {
  let [value, setValue] = React.useState(
    parseColor('#e73623')
  );
  let isValid = React.useMemo(() => {
    return value && value.red && value.red > value.green &&
      value.red > value.blue;
  }, [value]);

  return (
    <ColorField
      validationState={isValid ? 'valid' : 'invalid'}
      value={value}
      onChange={setValue}
      label="Red colors"
    />
  );
}
function Example() {
  let [value, setValue] =
    React.useState(
      parseColor(
        '#e73623'
      )
    );
  let isValid = React
    .useMemo(() => {
      return value &&
        value.red &&
        value.red >
          value.green &&
        value.red >
          value.blue;
    }, [value]);

  return (
    <ColorField
      validationState={isValid
        ? 'valid'
        : 'invalid'}
      value={value}
      onChange={setValue}
      label="Red colors"
    />
  );
}

Props#


NameTypeDefaultDescription
isQuietbooleanWhether the ColorField should be displayed with a quiet style.
valueTThe current value (controlled).
defaultValueTThe default value (uncontrolled).
isDisabledbooleanWhether the input is disabled.
isReadOnlybooleanWhether the input can be selected but not changed by the user.
validationStateValidationStateWhether the input should display its "valid" or "invalid" visual styling.
isRequiredboolean

Whether user input is required on the input before form submission. Often paired with the necessityIndicator prop to add a visual indicator to the input.

autoFocusbooleanWhether the element should receive focus on render.
labelReactNodeThe content to display as the label.
namestringThe name of the input element, used when submitting an HTML form. See MDN.
labelPositionLabelPosition'top'The label's overall position relative to the element it is labeling.
labelAlignAlignment'start'The label's horizontal alignment relative to the element it is labeling.
necessityIndicatorNecessityIndicator'icon'Whether the required state should be shown as an icon or text.
Events
NameTypeDefaultDescription
onChange( (color: Colornull )) => voidHandler that is called when the value changes.
onFocus( (e: FocusEvent )) => voidHandler that is called when the element receives focus.
onBlur( (e: FocusEvent )) => voidHandler that is called when the element loses focus.
onFocusChange( (isFocused: boolean )) => voidHandler that is called when the element's focus status changes.
onKeyDown( (e: KeyboardEvent )) => voidHandler that is called when a key is pressed.
onKeyUp( (e: KeyboardEvent )) => voidHandler that is called when a key is released.
onCopyClipboardEventHandler<HTMLInputElement>Handler that is called when the user copies text. See MDN.
onCutClipboardEventHandler<HTMLInputElement>Handler that is called when the user cuts text. See MDN.
onPasteClipboardEventHandler<HTMLInputElement>Handler that is called when the user pastes text. See MDN.
onCompositionStartCompositionEventHandler<HTMLInputElement>Handler that is called when a text composition system starts a new text composition session. See MDN.
onCompositionEndCompositionEventHandler<HTMLInputElement>Handler that is called when a text composition system completes or cancels the current text composition session. See MDN.
onCompositionUpdateCompositionEventHandler<HTMLInputElement>Handler that is called when a new character is received in the current text composition session. See MDN.
onSelectReactEventHandler<HTMLInputElement>Handler that is called when text in the input is selected. See MDN.
onBeforeInputFormEventHandler<HTMLInputElement>Handler that is called when the input value is about to be modified. See MDN.
onInputFormEventHandler<HTMLInputElement>Handler that is called when the input value is modified. See MDN.
Layout
NameTypeDefaultDescription
flexResponsive<stringnumberboolean>When used in a flex layout, specifies how the element will grow or shrink to fit the space available. See MDN.
flexGrowResponsive<number>When used in a flex layout, specifies how the element will grow to fit the space available. See MDN.
flexShrinkResponsive<number>When used in a flex layout, specifies how the element will shrink to fit the space available. See MDN.
flexBasisResponsive<numberstring>When used in a flex layout, specifies the initial main size of the element. See MDN.
alignSelfResponsive<'auto''normal''start''end''center''flex-start''flex-end''self-start''self-end''stretch'>Overrides the alignItems property of a flex or grid container. See MDN.
justifySelfResponsive<'auto''normal''start''end''flex-start''flex-end''self-start''self-end''center''left''right''stretch'>Specifies how the element is justified inside a flex or grid container. See MDN.
orderResponsive<number>The layout order for the element within a flex or grid container. See MDN.
gridAreaResponsive<string>When used in a grid layout, specifies the named grid area that the element should be placed in within the grid. See MDN.
gridColumnResponsive<string>When used in a grid layout, specifies the column the element should be placed in within the grid. See MDN.
gridRowResponsive<string>When used in a grid layout, specifies the row the element should be placed in within the grid. See MDN.
gridColumnStartResponsive<string>When used in a grid layout, specifies the starting column to span within the grid. See MDN.
gridColumnEndResponsive<string>When used in a grid layout, specifies the ending column to span within the grid. See MDN.
gridRowStartResponsive<string>When used in a grid layout, specifies the starting row to span within the grid. See MDN.
gridRowEndResponsive<string>When used in a grid layout, specifies the ending row to span within the grid. See MDN.
Spacing
NameTypeDefaultDescription
marginResponsive<DimensionValue>The margin for all four sides of the element. See MDN.
marginTopResponsive<DimensionValue>The margin for the top side of the element. See MDN.
marginBottomResponsive<DimensionValue>The margin for the bottom side of the element. See MDN.
marginStartResponsive<DimensionValue>The margin for the logical start side of the element, depending on layout direction. See MDN.
marginEndResponsive<DimensionValue>The margin for the logical end side of an element, depending on layout direction. See MDN.
marginXResponsive<DimensionValue>The margin for both the left and right sides of the element. See MDN.
marginYResponsive<DimensionValue>The margin for both the top and bottom sides of the element. See MDN.
Sizing
NameTypeDefaultDescription
widthResponsive<DimensionValue>The width of the element. See MDN.
minWidthResponsive<DimensionValue>The minimum width of the element. See MDN.
maxWidthResponsive<DimensionValue>The maximum width of the element. See MDN.
heightResponsive<DimensionValue>The height of the element. See MDN.
minHeightResponsive<DimensionValue>The minimum height of the element. See MDN.
maxHeightResponsive<DimensionValue>The maximum height of the element. See MDN.
Positioning
NameTypeDefaultDescription
positionResponsive<'static''relative''absolute''fixed''sticky'>Specifies how the element is positioned. See MDN.
topResponsive<DimensionValue>The top position for the element. See MDN.
bottomResponsive<DimensionValue>The bottom position for the element. See MDN.
leftResponsive<DimensionValue>The left position for the element. See MDN. Consider using start instead for RTL support.
rightResponsive<DimensionValue>The right position for the element. See MDN. Consider using start instead for RTL support.
startResponsive<DimensionValue>The logical start position for the element, depending on layout direction. See MDN.
endResponsive<DimensionValue>The logical end position for the element, depending on layout direction. See MDN.
zIndexResponsive<number>The stacking order for the element. See MDN.
isHiddenResponsive<boolean>Hides the element.
Accessibility
NameTypeDefaultDescription
idstringThe element's unique identifier. See MDN.
excludeFromTabOrderboolean

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-labelstringDefines a string value that labels the current element.
aria-labelledbystringIdentifies the element (or elements) that labels the current element.
aria-describedbystringIdentifies the element (or elements) that describes the object.
aria-detailsstringIdentifies the element (or elements) that provide a detailed, extended description for the object.
aria-errormessagestringIdentifies the element that provides an error message for the object.
Advanced
NameTypeDefaultDescription
UNSAFE_classNamestringSets the CSS className for the element. Only use as a last resort. Use style props instead.
UNSAFE_styleCSSPropertiesSets inline style for the element. Only use as a last resort. Use style props instead.

Visual options#


Quiet#

<ColorField label="Primary Color" isQuiet />
<ColorField label="Primary Color" isQuiet />
<ColorField
  label="Primary Color"
  isQuiet
/>

Disabled#

<ColorField label="Primary Color" isDisabled defaultValue="#e73623" />
<ColorField
  label="Primary Color"
  isDisabled
  defaultValue="#e73623"
/>
<ColorField
  label="Primary Color"
  isDisabled
  defaultValue="#e73623"
/>

Read only#

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

<ColorField label="Primary Color" isReadOnly defaultValue="#e73623" />
<ColorField
  label="Primary Color"
  isReadOnly
  defaultValue="#e73623"
/>
<ColorField
  label="Primary Color"
  isReadOnly
  defaultValue="#e73623"
/>

Label alignment and position#

View guidelines

By default, the label is positioned above the ColorField. The labelPosition prop can be used to position the label to the side. The labelAlign prop can be used to align the label as "start" or "end". For left-to-right (LTR) languages, "start" refers to the left most edge of the ColorField and "end" refers to the right most edge. For right-to-left (RTL) languages, this is flipped.

<ColorField label="Primary Color" labelPosition="side" labelAlign="end" />
<ColorField
  label="Primary Color"
  labelPosition="side"
  labelAlign="end"
/>
<ColorField
  label="Primary Color"
  labelPosition="side"
  labelAlign="end"
/>

Help text#

View guidelines

Both a description and an error message can be supplied to a ColorField. The description is always visible unless the validationState is “invalid” and an error message is provided. The error message can be used to help the user fix their input quickly and should be specific to the detected error. All strings should be localized.

function Example() {
  let [value, setValue] = React.useState(parseColor('#e73623'));
  let isValid = React.useMemo(() => {
    return value && value.red && value.red > value.green &&
      value.red > value.blue;
  }, [value]);

  return (
    <ColorField
      validationState={isValid ? 'valid' : 'invalid'}
      value={value}
      onChange={setValue}
      label="Red colors"
      description="Enter a red color."
      errorMessage={value === null
        ? 'Empty input not allowed.'
        : 'Not a red color.'}
    />
  );
}
function Example() {
  let [value, setValue] = React.useState(
    parseColor('#e73623')
  );
  let isValid = React.useMemo(() => {
    return value && value.red && value.red > value.green &&
      value.red > value.blue;
  }, [value]);

  return (
    <ColorField
      validationState={isValid ? 'valid' : 'invalid'}
      value={value}
      onChange={setValue}
      label="Red colors"
      description="Enter a red color."
      errorMessage={value === null
        ? 'Empty input not allowed.'
        : 'Not a red color.'}
    />
  );
}
function Example() {
  let [value, setValue] =
    React.useState(
      parseColor(
        '#e73623'
      )
    );
  let isValid = React
    .useMemo(() => {
      return value &&
        value.red &&
        value.red >
          value.green &&
        value.red >
          value.blue;
    }, [value]);

  return (
    <ColorField
      validationState={isValid
        ? 'valid'
        : 'invalid'}
      value={value}
      onChange={setValue}
      label="Red colors"
      description="Enter a red color."
      errorMessage={value ===
          null
        ? 'Empty input not allowed.'
        : 'Not a red color.'}
    />
  );
}

Custom width#

View guidelines

<ColorField label="Primary Color" width="size-3600" maxWidth="100%" />
<ColorField
  label="Primary Color"
  width="size-3600"
  maxWidth="100%"
/>
<ColorField
  label="Primary Color"
  width="size-3600"
  maxWidth="100%"
/>