Skip to main content

Date picker

A field-like button that opens a calendar for one date or a range.

In Accessible first

See it live​

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

When to use it​

In Accessible first: A date near today, such as a health appointment. Not a birth date or other known date.

  • Use it when: Dates near today, ranges, or when the day of the week matters.
  • Not when: A date people know by heart, such as a birth date: typed fields are faster.

Instead:

  • Calendar: The calendar on its own, always shown.
  • Input: A known date typed in.

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 button says the chosen date, not just Pick a date. undefined

Use it in code​

npx open-ds add date-picker

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

Tokens it reads​

Date picker reads 2 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 Date picker's tokens to change Date picker 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
Date picker
Weightcomponent.date-picker.font-weighttype.body.font-weightvar(--date-picker-font-weight)font.weight.400:400
Text
Changes with theme		component.date-picker.labelcolor.text.mutedvar(--date-picker-label)Lightgray.light.500:#595959Darkgray.dark.500:#949494