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
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:
[PAGEDOWN] - Decrements the corresponding day of the month by one
[SHIFT] + [PAGEDOWN] - Decrements the corresponding month by one
[SHIFT] + [CTRL] + [PAGEDOWN] - Decrements the corresponding year by one
[PAGEUP] - Increments the corresponding day of the month by one
[SHIFT] + [PAGEUP] - Increments the corresponding month by one
[SHIFT] + [CTRL] + [PAGEUP] - Increments the corresponding year by one
Properties/Attributes
You can use both properties and attributes with the same effect. The name of each attribute is listed below the name of the property, if different.
Name
Type
Default Value
Description
dateValue
(readonly)
date-value
Date
Note: The getter method is inherited and not supported. If called it will return an empty value.
dateValueUTC
(readonly)
date-value-utc
Date
Note: The getter method is inherited and not supported. If called it will return an empty value.
delimiter
string
"-"
Determines the symbol which separates the dates. If not supplied, the default time interval delimiter for the current locale will be used.
endDateValue
(readonly)
end-date-value
Date
Returns the end date of the currently selected range as JavaScript Date instance.
startDateValue
(readonly)
start-date-value
Date
Returns the start date of the currently selected range as JavaScript Date instance.
accessibleName
accessible-name
string
""
Defines the aria-label attribute for the component.
since v1.0.0-rc.15
accessibleNameRef
accessible-name-ref
string
""
Receives id(or many ids) of the elements that label the component.
since v1.0.0-rc.15
disabled
boolean
false
Determines whether the component is displayed as disabled.
hideWeekNumbers
hide-week-numbers
boolean
false
Defines the visibility of the week numbers column.
Note: For calendars other than Gregorian, the week numbers are not displayed regardless of what is set.
since v1.0.0-rc.8
name
string
""
Determines the name with which the component will be submitted in an HTML form.
Important: For the name property to have effect, you must add the following import to your project: import "@ui5/webcomponents/dist/features/InputElementsFormSupport.js";
Note: When set, a native input HTML element will be created inside the component so that it can be submitted as part of an HTML form. Do not use this property unless you need to submit a form.
placeholder
string
undefined
Defines 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.
readonly
boolean
false
Determines whether the component is displayed as read-only.
required
boolean
false
Defines whether the component is required.
since v1.0.0-rc.9
value
string
""
Defines a formatted date value.
valueState
value-state
ValueState
"None"
Defines the value state of the component.
Available options are:
None
Error
Warning
Success
Information
formatPattern
format-pattern
string
""
Determines the format, displayed in the input field.
maxDate
max-date
string
""
Determines the maximum date available for selection.
since v1.0.0-rc.6
minDate
min-date
string
""
Determines the minimum date available for selection.
since v1.0.0-rc.6
primaryCalendarType
primary-calendar-type
CalendarType
Sets a calendar type used for display. If not set, the calendar type of the global configuration is used.
secondaryCalendarType
secondary-calendar-type
CalendarType
undefined
Defines the secondary calendar type. If not set, the calendar will only show the primary calendar type.
since v1.0.0-rc.16
Slots
This Element provides slot(s). This means it can display its child nodes.
Unless targeting the default slot, use the slot attribute to define the destination slot for each child.
Text, along with HTML Elements with no slot attribute, goes the the default slot.
Slot
Type
Description
valueStateMessage
HTMLElement
Defines 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, Warning or Error value state.
Events
This Web Component fires semantic events upon user interaction. You can bind to these events with the standard DOM APIs, such as addEventListener.
Name
Description
change
Fired when the input operation has finished by pressing Enter or on focusout.
value
type: string description: The submitted value.
valid
type: boolean description: Indicator if the value is in correct format pattern and in valid range.
input
Fired when the value of the component is changed at each key stroke.
value
type: string description: The submitted value.
valid
type: boolean description: Indicator if the value is in correct format pattern and in valid range.
Methods
This Web Component exposes public methods. You can invoke them directly on the Web Component instance.
Name
Description
closePicker
Closes the picker.
formatValue
Formats a Java Script date object into a string representing a locale date according to the formatPattern property of the DatePicker instance
date
type: object description: A Java Script date object to be formatted as string
isInValidRange
Checks if a date is between the minimum and maximum date.
value
type: string description: A value to be checked
isOpen
Checks if the picker is open.
isValid
Checks if a value is valid against the current date format of the DatePicker.
value
type: string description: A value to be tested against the current date format
openPicker
Opens the picker.
Theme:Morning Horizon (Light)Evening Horizon (Dark)Horizon High Contrast BlackHorizon High Contrast WhiteQuartz LightQuartz DarkQuartz High Contrast BlackQuartz High Contrast White
