Description

Range pickers allow the user to set a customized range of dates using a unified component.

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

Usage & Behaviour

General guidelines

Structure

Range pickers consist of:

• A range picker field with two date inputs, for:

  • From date. The start of the range.

  • To date. The end of the range.

• Date picker button. A calendar Icon Button which opens the calendar drop-down.

• Calendar drop-down, which consists of:

  • Range picker menu, with month and year pickers for each half of the calendar.

  • Two month calendars.

Component	Image	Comments
Range picker field		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 From (start) date, or a From (start) date which is later than the To (end) date.

• The range picker field will be updated in response to selections made in the calendar drop-down.

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

• Drop-down selectors for months and years should be disabled to prevent a From date which is later than the To date.

• The two date inputs in the range picker field can be directly edited, with no need to use the calendar drop-down.

• Clicking either the From or To fields or the date picker icon will open the calendar drop-down with the relevant date selected (either From or To).

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

Interaction

Happy flow

1. Clicking on the From field.

Opens the menu:

• By default, the From field is highlighted in the calendar and the From text selected in the range picker field.

• Clicking outside of the control is equivalent to the Cancel operation.

2. Selecting the From date.

• The selected date is indicated on the calendar and in the range picker field.

• The focus automatically moves to the To field.

• Clicking outside the menu is equivalent to the Cancel operation.

• As the user hovers over another date, the dates between it and the selected From date should be highlighted. (The hover state is displayed only if the hovered date is later than the currently selected From date or range).

3. Selecting the To date

• Clicking on a date which is the same or later than the From date:

  • the calendar drop-down will close.

  • the entire date range will be selected.

  • the range picker field dates will be updated accordingly.

• Clicking outside the menu (without selecting any date) is equivalent to the Cancel operation.

Additional cases

• Clicking on either a From or To field will highlight the fields, select the dates, and open the menu.

• If the From field is selected, the next selection in the menu will move focus to the To field.

• If the To field is selected, the next selection will close the menu.

• Whenever a user selects a date that is earlier than the currently selected From date, only the From field will update without changing focus in the range picker fields. The To field will reset.

Validations and errors

Validation is displayed on the entire component.

Warning	Error	Comments
		In the example, the From date is later than the To date (manually entered).

Transitions

The calendar drop-down should slide up and down (as with the Date Picker).

<TBD animations>

Best practices

Use:

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

Don’t use:

• When a default set of ranges can be pre-defined to satisfy the user → a Segmented button 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. Example:

Accessibility compliance

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

Design

Code