Skip to main content

DateRangePicker

<ui5-daterange-picker> | Since 1.0.0-rc.8

The DateRangePicker enables the users to enter a localized date range using touch, mouse, keyboard input, or by selecting a date range in the calendar.

Usage​

The user can enter a date by: Using the calendar that opens in a popup or typing it in directly in the input field (not available for mobile devices). For the ui5-daterange-picker

ES6 Module Import​

import "@ui5/webcomponents/dist/DateRangePicker.js";

Keyboard Handling​

The ui5-daterange-picker provides advanced keyboard handling.

When the ui5-daterange-picker input field is focused the user can increment or decrement respectively the range start or end date, depending on where the cursor is. The following shortcuts are available:

  • [Page Down] - Decrements the corresponding day of the month by one
  • [Shift] + [Page Down] - Decrements the corresponding month by one
  • [Shift] + [Ctrl] + [Page Down] - Decrements the corresponding year by one
  • [Page Up] - Increments the corresponding day of the month by one
  • [Shift] + [Page Up] - Increments the corresponding month by one
  • [Shift] + [Ctrl] + [Page Up] - Increments the corresponding year by one

Basic Sample​

Properties​

delimiter​

DescriptionDetermines the symbol which separates the dates. If not supplied, the default time interval delimiter for the current locale will be used.
Typestring
Default"-"

dateValue​

DescriptionNote: The getter method is inherited and not supported. If called it will return an empty value.
TypeDate | null
Defaultnull
Readonlytrue

dateValueUTC​

DescriptionNote: The getter method is inherited and not supported. If called it will return an empty value.
TypeDate | null
Defaultnull
Readonlytrue

startDateValue​

DescriptionReturns the start date of the currently selected range as JavaScript Date instance.
TypeDate | null
Defaultnull
Readonlytrue

endDateValue​

DescriptionReturns the end date of the currently selected range as JavaScript Date instance.
TypeDate | null
Defaultnull
Readonlytrue

value​

DescriptionDefines a formatted date value.
Typestring
Default""

valueState​

DescriptionDefines the value state of the component.
Type"None" | "Positive" | "Critical" | "Negative" | "Information"
Default"None"

required​

DescriptionDefines whether the component is required.
Typeboolean
Defaultfalse
Since1.0.0-rc.9

disabled​

DescriptionDetermines whether the component is displayed as disabled.
Typeboolean
Defaultfalse

readonly​

DescriptionDetermines whether the component is displayed as read-only.
Typeboolean
Defaultfalse

placeholder​

DescriptionDefines a short hint, intended to aid the user with data entry when the component has no value.
Note: When no placeholder is set, the format pattern is displayed as a placeholder. Passing an empty string as the value of this property will make the component appear empty - without placeholder or format pattern.
Typestring | undefined
Defaultundefined

name​

DescriptionDetermines the name by which the component will be identified upon submission in an HTML form.
Note: This property is only applicable within the context of an HTML Form element.
Typestring | undefined
Defaultundefined

hideWeekNumbers​

DescriptionDefines the visibility of the week numbers column.
Note: For calendars other than Gregorian, the week numbers are not displayed regardless of what is set.
Typeboolean
Defaultfalse
Since1.0.0-rc.8

open​

DescriptionDefines the open or closed state of the popover.
Typeboolean
Defaultfalse
Since2.0.0

accessibleName​

DescriptionDefines the aria-label attribute for the component.
Typestring | undefined
Defaultundefined
Since1.0.0-rc.15

accessibleNameRef​

DescriptionReceives id(or many ids) of the elements that label the component.
Typestring | undefined
Defaultundefined
Since1.0.0-rc.15

primaryCalendarType​

DescriptionSets a calendar type used for display. If not set, the calendar type of the global configuration is used.
Type"Gregorian" | "Islamic" | "Japanese" | "Buddhist" | "Persian" | undefined
Defaultundefined

secondaryCalendarType​

DescriptionDefines the secondary calendar type. If not set, the calendar will only show the primary calendar type.
Type"Gregorian" | "Islamic" | "Japanese" | "Buddhist" | "Persian" | undefined
Defaultundefined
Since1.0.0-rc.16

formatPattern​

DescriptionDetermines the format, displayed in the input field.
Typestring | undefined
Defaultundefined

minDate​

DescriptionDetermines the minimum date available for selection.
Note: If the formatPattern property is not set, the minDate value must be provided in the ISO date format (YYYY-MM-dd).
Typestring
Default""
Since1.0.0-rc.6

maxDate​

DescriptionDetermines the maximum date available for selection.
Note: If the formatPattern property is not set, the maxDate value must be provided in the ISO date format (YYYY-MM-dd).
Typestring
Default""
Since1.0.0-rc.6

calendarWeekNumbering​

DescriptionDefines how to calculate calendar weeks and first day of the week. If not set, the calendar will be displayed according to the currently set global configuration.
Type"Default" | "ISO_8601" | "MiddleEastern" | "WesternTraditional"
Default"Default"
Since2.2.0

Slots​

valueStateMessage​

DescriptionDefines the value state message that will be displayed as pop up under the component.
Note: If not specified, a default text (in the respective language) will be displayed.
Note: The valueStateMessage would be displayed, when the component is in Information, Critical or Negative value state.
TypeArray<HTMLElement>
Since1.0.0-rc.7

Events​

change​

DescriptionFired when the input operation has finished by pressing Enter or on focusout.
TypeCustomEvent<DatePickerChangeEventDetail>
Parametersvalue: string
The submitted value.
valid: boolean
Indicator if the value is in correct format pattern and in valid range.
BubblesYes
CancelableYes - via preventDefault()

input​

DescriptionFired when the value of the component is changed at each key stroke.
TypeCustomEvent<DatePickerInputEventDetail>
Parametersvalue: string
The submitted value.
valid: boolean
Indicator if the value is in correct format pattern and in valid range.
BubblesYes
CancelableYes - via preventDefault()

value-state-change​

DescriptionFired before the value state of the component is updated internally. The event is preventable, meaning that if it's default action is prevented, the component will not update the value state.
TypeCustomEvent<DatePickerValueStateChangeEventDetail>
ParametersvalueState: string
The new valueState that will be set.
valid: boolean
Indicator if the value is in correct format pattern and in valid range.
BubblesYes
CancelableYes - via preventDefault()

open​

DescriptionFired after the value-help dialog of the component is opened.
TypeCustomEvent
Since2.4.0
BubblesYes
CancelableNo

close​

DescriptionFired after the value-help dialog of the component is closed.
TypeCustomEvent
Since2.4.0
BubblesYes
CancelableNo

Methods​

isValid​

DescriptionChecks if a value is valid against the current date format of the DatePicker.
Return typeboolean
Parametersvalue: string
A value to be tested against the current date format

isInValidRange​

DescriptionChecks if a date is between the minimum and maximum date.
Return typeboolean
Parametersvalue: string
A value to be checked

formatValue​

DescriptionFormats a Java Script date object into a string representing a locale date according to the formatPattern property of the DatePicker instance
Return typestring
Parametersdate: Date
A Java Script date object to be formatted as string

CSS Parts​

No CSS parts available for this component.

More Samples​

Date Formats​

Supported format options are pattern-based on Unicode LDML Date Format notation. For more information, see UTS #35: Unicode Locale Data Markup Language.

Min and Max Dates​

Define min and max date boundaries to contrain user choice.