Date picker

The date picker allows a user to choose and/or input a date by using a calendar dropdown or by typing the date into a text field.

Examples

Loading story...
Date range picker
Loading story...
TODO:
Add example date range limit indicator. Create an issue

View in Pajamas UI Kit →

Structure

Numbered diagram of a date picker structure
  1. Label: Text associated with the text field.
  2. Text field: Input element that gets populated with a date.
  3. Calendar button: Opens the calendar dropdown.
  4. Clear button: Clears the text field content.
  5. Calendar dropdown: Dropdown showing the month.
TODO:
Update structure with date range limit indicator. Create an issue

Guidelines

When to use

  • Choose a date from a calendar to populate a text field.

When not to use

  • If a user needs to enter a familiar date, like a birthday, consider using a regular text input without the date picker functionality instead (see note in the Reference section).

Variants

  • Date picker: Choose a single date.
  • Date range picker: Choose a start and end date.

Behavior

  • The user can either type a date into the text field or choose a day from the calendar dropdown which will populate the text field with the chosen date.
  • A user can enter a date in different formats. For example, January 22, 2020 or 22/01/2020. The date picker translates the format to GitLab's default (ISO 8601) in the API.
  • For date ranges, the date picker for the end ("To") date only allows a user to pick a date that is either equal to or after the start ("From") date. The days preceding the start date will be disabled.
  • For date ranges, the ending date month should initially default to the same month chosen for the start date.
  • On smaller viewports, the two date text fields in a date range picker are full-width and vertically stacked so the user’s language reading direction doesn’t have an effect on the order.

Content

  • The label for a date picker can specify what the date selection is for, while the date range picker labels should be "From" for the start date and "To" for the end date.
  • The text field uses "YYYY-MM-DD" as placeholder text to indicate the expected format of time to be entered.
  • The text field accepts all special characters and numbers.
  • The current month (MM) is the default month shown in the calendar dropdown.
  • The order of the “From” and “To” text fields should match the user’s reading language setting (left-to-right by default).
  • When the date range picker limits the number of selectable days, indicate it in the UI with text that summarizes the number of days currently selected, followed by an info icon. The tooltip on the info icon should clarify the date range limit.

Accessibility

TODO:
Add accessibility notes. Create an issue

Reference

  • In Adrian Roselli's article, Maybe You Don't Need a Date Picker, he states that "Users generally do not want a complex date picker every time you ask for any date. At least not users with a keyboard." He follows the robustness principle where you should "be conservative in what you do, be liberal in what you accept from others" in his exploration. A date picker can simply be overwhelming for something as simple as entering a familiar date, especially for keyboard-only users. Anecdotally he backs this up with 20 years of research. To be clear though, he also mentions that a plain text field will not work "if you need to see chosen dates, unavailable dates, weekends, holidays, date spans, date ranges, dates where counts from start or end dates matter, and so on."
  • In HTML5 an input with type="date" is available, but accessibility support for screen readers and voice control is inconsistent.

Last updated at: