Skip to main content

Form

Form state and validation wired to the fields.

In Brand expressive

See it live​

Start Storybook to see it live: npm run storybook
Live from StorybookOpen Form in StorybookSee it in dark

When to use it​

In Brand expressive: The sign-up email, checked, with its error next to the field. Not for sections without a field.

  • Use it when: Any form that checks answers and shows errors next to the fields.
  • Not when: A single control that saves at once (a switch).

Instead:

  • Field: How one control is laid out.

How Brand expressive uses it​

An error message
Use color.status.danger and a short sentence
Not The brand magenta
Errors must not look like the brand.
The words of an error
Use Plain first, a light touch after
Not A joke before the fix
Playful copy must never hide what went wrong. Example: “That email doesn't look right. Check it and try again.”

Words​

  • Headlines are short and bold. Three to six words.
  • Verbs that move: Join, Try, Go.
  • Playful in headlines, plain in errors.
  • Use: Join, Drop, Go, Love. Avoid: Synergy, Leverage, Kindly.

The labels components use, from the voice tokens:

  • content.action.commit: Go
  • content.action.cancel: Not now
  • content.action.destroy: Remove
  • content.action.retry: Try again
  • content.action.empty-action: Explore the drop

See Voice and tone for the whole voice.

Accessibility and keyboard​

Test before you ship:

  • Errors are announced, linked to their fields, and the first one gets focus on submit. undefined

Use it in code​

npx open-ds add form

The component reads only component keys and semantic tokens, so it follows the brand and mode on <html>.

Tokens it reads​

Form reads 6 tokens of its own, each an alias of a semantic token. Each row is one part: its own token, the semantic it aliases, and the value it ends at. Change a semantic and every component that reads it follows; override one of Form's tokens to change Form alone.

Changes with theme

Brand expressive decides what changes when you switch theme. Here a switch changes colors only, so the marked rows differ between light and dark; everything else holds steady.

PartIts token and the semantic it aliasesValue
Item
Gapcomponent.form.item.gapspace.gap.defaultvar(--form-item-gap)space.16:1rem
Text
Text
Changes with theme		component.form.label.labelcolor.status.dangervar(--form-label-label)Lightred.light.600:#C42B2BDarkred.dark.600:#F28B8B
Description
Text sizecomponent.form.description.font-sizetype.body.font-sizevar(--form-description-font-size)font.size.17:1.0625rem
Text
Changes with theme		component.form.description.labelcolor.text.mutedvar(--form-description-label)Lighttaupe.light.600:#6B544ADarktaupe.dark.400:#B5988A
Message
Text sizecomponent.form.message.font-sizetype.body.font-sizevar(--form-message-font-size)font.size.17:1.0625rem
Text
Changes with theme		component.form.message.labelcolor.status.dangervar(--form-message-label)Lightred.light.600:#C42B2BDarkred.dark.600:#F28B8B