Skip to main content

Label

The visible name of a form control.

In Accessible first

See it live​

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

When to use it​

In Accessible first: Names every control.

  • Use it when: Every form control.
  • Not when: Never skipped: a placeholder is not a label.

Instead:

  • Field: The label laid out with hint and error.

How Accessible first uses it​

Field label or column header
Use type.label, above the field, always visible
Not A placeholder as the label
Labels must stay visible while typing.

Words​

  • Use common words. Explain any term you must use.
  • One idea per sentence. Put the action first.
  • Never blame the person.
  • Use: Continue, Change, Start, You. Avoid: Invalid, Utilise, Submit, Error code.

The labels components use, from the voice tokens:

  • content.action.commit: Continue
  • content.action.cancel: Go back
  • content.action.destroy: Delete
  • content.action.retry: Try again
  • content.action.empty-action: Start a new application

See Voice and tone for the whole voice.

Accessibility and keyboard​

Test before you ship:

  • The label is linked to its control and makes the hit area larger. undefined

Use it in code​

npx open-ds add label

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

Tokens it reads​

Label 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 Label's tokens to change Label alone.

Changes with theme

Accessible 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
Label
Gapcomponent.label.gapspace.gap.defaultvar(--label-gap)space.16:1rem
Text
Changes with theme		component.label.labelcolor.text.primaryvar(--label-label)Lightgray.light.900:#141414Darkgray.dark.900:#F7F7F7
Font familycomponent.label.font-familytype.label.font-familyvar(--label-font-family)font.family.atkinson-hyperlegible:"Atkinson Hyperlegible", Verdana, sans-serif
Text sizecomponent.label.font-sizetype.label.font-sizevar(--label-font-size)font.size.18:1.125rem
Weightcomponent.label.font-weighttype.label.font-weightvar(--label-font-weight)font.weight.700:700
Line heightcomponent.label.line-heighttype.label.line-heightvar(--label-line-height)font.line-height.1_6:1.6