Skip to main content

Form

Form state and validation wired to the fields.

In Content first

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 Content first: The newsletter and search forms, with a plain sentence that says what to fix. Not for a single control.

  • 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 Content first uses it​

An error message
Use color.status.danger and a plain sentence
Not Color alone
The sentence says what to fix; color only draws the eye.
The words of an error
Use Calm and helpful. Take the blame, offer the way forward.
Not Blaming the reader
A calm error keeps the reader's trust. Example: “We could not save your email. Check it and try again.”

Words​

  • Write to one person: "you", not "users".
  • Short sentences with room to breathe.
  • Explain why before asking for anything.
  • Use: Read, Save for later, You, Next issue. Avoid: Click here, Submit, Users, Content.

The labels components use, from the voice tokens:

  • content.action.commit: Save
  • content.action.cancel: Not now
  • content.action.destroy: Remove
  • content.action.retry: Try again
  • content.action.empty-action: Browse guides

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

Content first 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.18:1.125rem
Text
Changes with theme		component.form.description.labelcolor.text.mutedvar(--form-description-label)Lightstone.light.600:#61594DDarkstone.dark.400:#A39A8B
Message
Text sizecomponent.form.message.font-sizetype.body.font-sizevar(--form-message-font-size)font.size.18:1.125rem
Text
Changes with theme		component.form.message.labelcolor.status.dangervar(--form-message-label)Lightred.light.600:#C42B2BDarkred.dark.600:#F28B8B