Choose a version:

ColorField

Allow users to select a color with a color picker or as a text input.

Anchor to propertiesProperties

Anchor to alpha alpha boolean Default: false: Allow user to select an alpha value.
Anchor to autocomplete autocomplete "on" | "off" Default: 'on' for everything else: A hint as to the intended content of the field.

When set to on (the default), this property indicates that the field should support autofill, but you do not have any more semantic information on the intended contents.

When set to off, you are indicating that this field contains sensitive information, or contents that are never saved, like one-time codes.

Alternatively, you can provide value which describes the specific data you would like to be entered into this field during autofill.
Anchor to defaultValue defaultValue string: The default value for the field.
Anchor to details details string: Additional text to provide context or guidance for the field. This text is displayed along with the field and its label to offer more information or instructions to the user.

This will also be exposed to screen reader users.
Anchor to disabled disabled boolean Default: false: Disables the field, disallowing any interaction.
Anchor to error error string: Indicate an error to the user. The field will be given a specific stylistic treatment to communicate problems that have to be resolved immediately.
Anchor to id id string: A unique identifier for the element.
Anchor to label label string: Content to use as the field label.
Anchor to labelAccessibilityVisibility labelAccessibilityVisibility "visible" | "exclusive" Default: 'visible': Changes the visibility of the component's label.

visible: the label is visible to all users.

exclusive: the label is visually hidden but remains in the accessibility tree.
Anchor to name name string: An identifier for the field that is unique within the nearest containing form.
Anchor to placeholder placeholder string: A short hint that describes the expected value of the field.
Anchor to readOnly readOnly boolean Default: false: The field cannot be edited by the user. It is focusable will be announced by screen readers.
Anchor to required required boolean Default: false: Whether the field needs a value. This requirement adds semantic value to the field, but it will not cause an error to appear automatically. If you want to present an error when this field is empty, you can do so with the error property.
Anchor to value value string: The current value for the field. If omitted, the field will be empty.

The current value for the field. If omitted, the field will be empty.

Anchor to eventsEvents

Learn more about registering events.

Anchor to blur blur <'input'>
Anchor to change change <'input'>
Anchor to focus focus <'input'>
Anchor to input input <'input'>

Examples

<s-color-field placeholder="Select a color" value="#FF0000" />

Preview

Examples

Code

jsx

<s-color-field placeholder="Select a color" value="#FF0000" />

html

<s-color-field placeholder="Select a color" value="#FF0000"></s-color-field>

Basic Usage

Description

Standard color input field with hex value.

jsx

<s-stack gap="base">
  <s-color-field label="Brand color" name="brandColor" value="#FF0000" />
</s-stack>

html

<s-stack gap="base">
  <s-color-field label="Brand color" name="color" value="#FF0000"></s-color-field>
</s-stack>

Required

Description

Required color field ensuring essential color values are provided.

jsx

<s-stack gap="base">
  <s-color-field label="Brand color" value="#FF0000" required />
</s-stack>

html

<s-stack gap="base">
  <s-color-field label="Brand color" value="#FF0000" required></s-color-field>
</s-stack>

With Alpha Transparency

Description

Color field supporting alpha channel for transparency control.

jsx

<s-stack gap="base">
  <s-color-field
    label="Background color"
    value="rgba(255, 0, 0, 0.5)"
    alpha
   />
</s-stack>

html

<s-stack gap="base">
  <s-color-field
    label="Background color"
    value="rgba(255, 0, 0, 0.5)"
    alpha
  ></s-color-field>
</s-stack>

With Error State

Description

Color field with validation error for invalid color format inputs.

jsx

<s-stack gap="base">
  <s-color-field
    label="Brand color"
    name="brandColor"
    value="#invalid"
    error="Please enter a valid color format (hex, rgb, or rgba)"
    required
  ></s-color-field>
</s-stack>

html

<s-stack gap="base">
  <s-color-field
    label="Brand color"
    name="brandColor"
    value="#invalid"
    error="Please enter a valid color format (hex, rgb, or rgba)"
    required
  ></s-color-field>
</s-stack>

With Help Text

Description

Color field with contextual details providing additional guidance.

jsx

<s-stack gap="base">
  <s-color-field
    label="Primary color"
    value="#1a73e8"
    details="Main brand color used for buttons and links"
   />
</s-stack>

html

<s-stack gap="base">
  <s-color-field
    label="Primary color"
    value="#1a73e8"
    details="Main brand color used for buttons and links"
  ></s-color-field>
</s-stack>

With Placeholder

Description

Color field demonstrating how to use a placeholder to guide user input for color selection.

jsx

<s-stack gap="base">
  <s-color-field
    label="Theme color"
    placeholder="Enter a hex color (e.g., #FF0000)"
    value="#000000"
   />
</s-stack>

html

<s-stack gap="base">
  <s-color-field
    label="Theme color"
    placeholder="Enter a hex color (e.g., #FF0000)"
    value="#000000"
  ></s-color-field>
</s-stack>

Read Only State

Description

Color field in a read-only mode, preventing user modifications to the color value.

jsx

<s-stack gap="base">
  <s-color-field label="System color" name="color" value="#1a73e8" readOnly />
</s-stack>

html

<s-stack gap="base">
  <s-color-field label="System color" name="color" value="#1a73e8" readOnly></s-color-field>
</s-stack>

Form Integration

Description

A multi-color field form section demonstrating how ColorField can be used to capture different color settings in a single form.

jsx

<s-stack gap="base">
  <s-section>
    <s-heading>Theme settings</s-heading>
    <s-stack gap="base">
      <s-color-field
        label="Primary brand color"
        name="primaryColor"
        value="#1a73e8"
        defaultValue="#1a73e8"
        details="This color will be used for buttons, links, and brand elements"
        required
       />
      <s-color-field
        label="Secondary color"
        name="secondaryColor"
        value="#34a853"
        details="Used for secondary actions and accents"
       />
      <s-color-field
        label="Background overlay"
        name="overlayColor"
        value="rgba(0, 0, 0, 0.5)"
        alpha
        details="Background color for modal overlays and dropdowns"
       />
    </s-stack>
  </s-section>
</s-stack>

html

<s-stack gap="base">
  <s-section>
    <s-heading>Theme settings</s-heading>
    <s-stack gap="base">
      <s-color-field
        label="Primary brand color"
        name="primaryColor"
        value="#1a73e8"
        defaultValue="#1a73e8"
        details="This color will be used for buttons, links, and brand elements"
        required
      ></s-color-field>
      <s-color-field
        label="Secondary color"
        name="secondaryColor"
        value="#34a853"
        details="Used for secondary actions and accents"
      ></s-color-field>
      <s-color-field
        label="Background overlay"
        name="overlayColor"
        value="rgba(0, 0, 0, 0.5)"
        alpha
        details="Background color for modal overlays and dropdowns"
      ></s-color-field>
    </s-stack>
  </s-section>
</s-stack>

Color validation

Description

Interactive example showing real-time hex color validation with error messages.

jsx

const [color, setColor] = useState('#invalid');
const [error, setError] = useState('Please enter a valid color format');

return (
  <s-section>
    <s-stack gap="base" justifyContent="start">
      <s-text-field label="Theme name" />
      <s-color-field
        label="Brand color"
        name="Color"
        value={color}
        error={error}
        required
        onInput={(e) => {
          setColor(e.currentTarget.value);
          setError(/^#([0-9A-F]{3}){1,2}$/i.test(e.currentTarget.value) ? '' : 'Please enter a valid color format');
        }}
      />
    </s-stack>
  </s-section>
)

Anchor to best-practicesBest practices

Use the alpha property to allow merchants to select transparent colors
Provide clear labels that indicate what the color will be used for
Use details text to provide context about the color's purpose
Validate color format inputs and provide clear error messages

Was this page helpful?

ColorField

Anchor to propertiesProperties

Anchor to eventsEvents

CallbackEventListener

CallbackEvent

Preview

Examples

Code

jsx

html

Basic Usage

Description

jsx

html

Required

Description

jsx

html

With Alpha Transparency

Description

jsx

html

With Error State

Description

jsx

html

With Help Text

Description

jsx

html

With Placeholder

Description

jsx

html

Read Only State

Description

jsx

html

Form Integration

Description

jsx

html

Color validation

Description

jsx

Anchor to best-practicesBest practices