Search results

DateRangePickerComponent

Represents the Essential JS 2 React DateRangePicker Component.

<DateRangePickerComponent startDate={date} endDate={date}></DateRangePickerComponent>

Properties

allowEdit

boolean

Support for allowEdit has been provided from v16.2.46. Specifies whether the input textbox is editable or not. Here the user can select the value from the popup and cannot edit in the input textbox.

cssClass

string

Sets the root CSS class to the DateRangePicker which allows you to customize the appearance.

dayHeaderFormat

string

Specifies the format of the day that to be displayed in header. By default, the format is ‘short’. Possible formats are:

  • Short - Sets the short format of day name (like Su ) in day header.
  • Narrow - Sets the single character of day name (like S ) in day header.
  • Abbreviated - Sets the min format of day name (like Sun ) in day header.
  • Wide - Sets the long format of day name (like Sunday ) in day header.

depth

string

Sets the maximum level of view (month, year, decade) in the Calendar. Depth view should be smaller than the start view to restrict its view navigation.

enablePersistence

boolean

Enable or disable the persisting component’s state between the page reloads. If enabled, following list of states will be persisted.

  1. startDate
  2. endDate
  3. value

enableRtl

boolean

Enable or disable rendering component in right to left direction.

enabled

boolean

Specifies the component to be disabled which prevents the DateRangePicker from user interactions.

endDate

Date

Gets or sets the end date of the date range selection.

firstDayOfWeek

number

Gets or sets the Calendar’s first day of the week. By default, the first day of the week will be based on the current culture.

For more details about firstDayOfWeek refer to First day of week documentation.

floatLabelType

FloatLabelType | string

Specifies the placeholder text to be floated. Possible values are: Never: The label will never float in the input when the placeholder is available. Always: The floating label will always float above the input. Auto: The floating label will float above the input after focusing or entering a value in the input.

format

string | RangeFormatObject

Sets or gets the required date format to the start and end date string.

For more details refer to Formatsample.

htmlAttributes

Object

You can add the additional html attributes such as disabled, value etc., to the element. If you configured both property and equivalent html attribute then the component considers the property value.

keyConfigs

Object

Customizes the key actions in DateRangePicker. For example, when using German keyboard, the key actions can be customized using these shortcuts. Input Navigation

Key action
Key
altUpArrow
alt+uparrow
altDownArrow
alt+downarrow
escape
escape

Calendar Navigation (Use the following list of keys to navigate the currently focused Calendar after the popup has opened).

Key action
Key
controlUp
ctrl+38
controlDown
ctrl+40
moveDown
downarrow
pageUp
pageup
pageDown
pagedown
shiftPageUp
shift+pageup
shiftPageDown
shift+pagedown
moveUp
uparrow
moveLeft
leftarrow
moveRight
rightarrow
select
enter
home
home
end
end
controlHome
ctrl+home
controlEnd
ctrl+end
altUpArrow
alt+uparrow
spacebar
space
enter
enter
altRightArrow
alt+rightarrow
altLeftArrow
alt+leftarrow

locale

string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

max

Date

Gets or sets the maximum date that can be selected in the calendar-popup.

maxDays

number

Specifies the maximum span of days that can be allowed in a date range selection.

For more details refer to Range Span documentation.

min

Date

Gets or sets the minimum date that can be selected in the calendar-popup.

minDays

number

Specifies the minimum span of days that can be allowed in date range selection.

For more details refer to Range Span documentation.

placeholder

string

Specifies the placeholder text that need to be displayed in the DateRangePicker component.

presets

PresetsModel[]

Set the predefined ranges which let the user pick required range easily in a component.

For more details refer to Preset Ranges documentation.

readonly

boolean

Denies the editing the ranges in the DateRangePicker component.

separator

string

Sets or gets the string that used between the start and end date string.

showClearButton

boolean

Specifies whether to show or hide the clear icon

showTodayButton

boolean

Specifies whether the today button is to be displayed or not.

start

string

Specifies the initial view of the Calendar when it is opened. With the help of this property, initial view can be changed to year or decade view.

startDate

Date

Gets or sets the start date of the date range selection.

strictMode

boolean

Specifies the component to act as strict which allows entering only a valid date range in a DateRangePicker.

For more details refer to Strict Modedocumentation.

value

Date[] | DateRange

Gets or sets the start and end date of the Calendar.

weekNumber

boolean

Determines whether the week number of the Calendar is to be displayed or not. The week number is displayed in every week row.

For more details about weekNumber refer to Calendar with week numberdocumentation.

width

number | string

Specifies the width of the DateRangePicker component.

zIndex

number

specifies the z-index value of the dateRangePicker popup element.

Methods

destroy

To destroy the widget.

Returns void

focusIn

Sets the focus to widget for interaction.

Returns void

focusOut

Remove the focus from widget, if the widget is in focus state.

Returns void

getPersistData

Return the properties that are maintained upon browser refresh.

Returns string

getSelectedRange

Return the selected range and day span in the DateRangePicker.

Returns Object

hide

To close the Popup container in the DateRangePicker component.

Returns void

This method is used to navigate to the month/year/decade view of the Calendar.

Parameter Type Description
view string Specifies the view of the Calendar.
date Date Specifies the focused date in a view.

Returns void

show

To open the Popup container in the DateRangePicker component.

Returns void

Events

blur

EmitType<BlurEventArgs>

Triggers when the control loses the focus.

change

EmitType<RangeEventArgs>

Triggers when the Calendar value is changed.

close

EmitType<Object>

Triggers when the DateRangePicker is closed.

created

EmitType<Object>

Triggers when Calendar is created.

destroyed

EmitType<Object>

Triggers when Calendar is destroyed.

focus

EmitType<FocusEventArgs>

Triggers when the control gets focus.

Triggers when the Calendar is navigated to another view or within the same level of view.

open

EmitType<Object>

Triggers when the DateRangePicker is opened.

renderDayCell

EmitType<RenderDayCellEventArgs>

Triggers when each day cell of the Calendar is rendered.

select

EmitType<Object>

Triggers on selecting the start and end date.