Description

The range picker allows the user to set a customized range of dates using a unified component.

The range picker’s structure and behavior are based on the Date Picker, and are therefore are not repeated here.

Open

Usage & Behavior

General guidelines

Structure

The range picker consists of:

• The range picker field, with two date inputs:

  • From date. The start of the range.

  • To date. The end of the range.

• The date picker button. A calendar Icon Button which opens the drop-down menu.

• Preceding label (optional).

• A drop-down range picker menu, which consists of:

  • Month and year pickers for each half of the calendar.

  • Two month calendars.

Component	Image	Comments

Component	Image	Comments
Range picker field	Open	A string indicating the range (From - To) and an icon button. Next to the field, a preceding label can be set describing the purpose of the control.
Range picker menu		2 month calendars, displayed horizontally from left (start) to right (end). The direction of the dates might change according to RTL languages.

Internal Logic

• The months displayed in the menu can be changed independently.

• The user cannot select a To (end) date which is earlier than the selected From (start) date, or a From (start) date which is later than the selected To (end) date.

• The range picker field will be updated in response to selections made in the range picker menu.

• When 2 consecutive months are displayed together on the menu, the arrows are disabled accordingly, so that the From month cannot be moved forward and the To month cannot be moved backward:

• Options should be disabled in the month and year drop-down selectors to prevent a From date which is later than the To date. For example, if the From date is set to 2021, then 2020 and earlier will be disabled in the To date drop-down.

• The two date inputs in the range picker field can always be directly edited, with no need to use the range picker menu.

• Clicking either the From or To fields or the date picker icon will open the range picker menu with the relevant date selected (either From or To).

  • Clicking the date picker icon is equivalent to clicking on the From date.

States

Date input field

Interaction

1. Clicking on the From field.

The menu is opened:

2. Selecting the From date.

3. Selecting the To date

• Directly editing an existing range.

• Selecting a date that is earlier than the selected From date.

Validations and errors

Validation is displayed across the entire component.

Transitions

The Range picker menu should slide up and down.

Selecting the right and left arrows should swipe the dates horizontally. See the Date Picker for an example.

A swipe transition is used when pressing the left and right arrows to navigate between the months, as shown in the Date Picker.

Best practices

Use:

• whenever a user is required to set a custom period.

Don’t use:

• when a default set of ranges is pre-defined → a Selector can be a better approach for offering different periods.

General

• If start and end times are also required, use the Time Picker component adjacent to the range picker:

Accessibility compliance

Unless otherwise specified, see our general compliance information in Fundamentals - Accessibility.

Design

Code