Skip to main content

Date picker

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

In Multi-brand

See it live​

Start Storybook to see it live: npm run storybook

When to use it​

In Multi-brand: A date near today or a range, opened by tap from a field. Not a date known by heart; type it.

  • 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​

  • Shared structure: object, state, next step.
  • Brand tone lives in headlines and marketing copy, not in errors.
  • Errors and confirmations read the same in every brand.
  • Use: Get started, Plan, Order. Avoid: Brand-specific words in errors, Jargon.

The labels components use, from the voice tokens:

  • content.action.commit: Save
  • content.action.cancel: Cancel
  • content.action.destroy: Remove
  • content.action.retry: Try again
  • content.action.empty-action: Get started

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

Multi-brand decides what changes when you switch theme. Here a switch changes colors, type and shape, so the marked rows differ between its brands and 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)Aster Lightslate-deep.light.600:#4B5A6FAster Darkslate-deep.dark.400:#96A3B5Birch Lightslate-deep.light.600:#4B5A6FBirch Darkslate-deep.dark.400:#96A3B5Coral Lightslate-deep.light.600:#4B5A6FCoral Darkslate-deep.dark.400:#96A3B5