Search results

DatePickerComponent

Represents the Essential JS 2 React DatePicker Component.

<DatePickerComponent value={date}></DatePickerComponent>

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.

calendarMode

string

Gets or sets the Calendar’s Type like gregorian or islamic.

cssClass

string

Specifies the root CSS class of the DatePicker that allows to customize the appearance by overriding the styles.

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 such as month, year, and decade in the Calendar. Depth view should be smaller than the start view to restrict its view navigation.

view
Description
Month
Calendar view shows up to the days of the month.
Year
Calendar view shows up to the months of the year.
Decade
Calendar view shows up to the years of the decade.

For more details about depth refer to calendarViewdocumentation.

enablePersistence

boolean

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

  1. value

enableRtl

boolean

Enable or disable rendering component in right to left direction.

enabled

boolean

Specifies the component to be disabled or not.

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 | FormatObject

Specifies the format of the value that to be displayed in component. By default, the format is based on the culture.

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 DatePicker. 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

Key action
Key
controlUp
ctrl+38
controlDown
ctrl+40
moveDown
downarrow
moveUp
uparrow
moveLeft
leftarrow
moveRight
rightarrow
shiftPageUp
shift+pageup
shiftPageDown
shift+pagedown
select
enter
home
home
end
end
pageUp
pageup
pageDown
pagedown
controlHome
ctrl+home
controlEnd
ctrl+end
altUpArrow
alt+uparrow
spacebar
space
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.

min

Date

Gets or sets the minimum date that can be selected in the Calendar.

placeholder

string

Specifies the placeholder text that displayed in textbox.

readonly

boolean

Specifies the component in readonly state. When the Component is readonly it does not allow user input.

showClearButton

boolean

Specifies whether to show or hide the clear icon in textbox.

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.

View
Description
Month
Calendar view shows the days of the month.
Year
Calendar view shows the months of the year.
Decade
Calendar view shows the years of the decade.

For more details about start refer to calendarViewdocumentation.

strictMode

boolean

Specifies the component to act as strict. So that, it allows to enter only a valid date value within a specified range or else it will resets to previous value. By default, strictMode is in false. it allows invalid or out-of-range date value with highlighted error class.

For more details refer to Strict Mode documentation.

value

Date

Gets or sets the selected date of the Calendar.

weekNumber

boolean

Determines whether the week number of the year is to be displayed in the calendar or not.

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

width

number | string

Specifies the width of the DatePicker component.

zIndex

number

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

Methods

addDate

This method is used to add the single or multiple dates to the values property of the Calendar.

Parameter Type Description
dates Date | Date[] Specifies the date or dates to be added to the values property of the Calendar.

Returns void

currentView

Gets the current view of the DatePicker.

Returns string

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

Gets the properties to be maintained upon browser refresh.

Returns string

hide

Hide the Calendar.

Returns void

Navigates to specified month or year or decade view of the DatePicker.

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

Returns void

removeDate

This method is used to remove the single or multiple dates from the values property of the Calendar.

Parameter Type Description
dates Date | Date[] Specifies the date or dates which need to be removed from the values property of the Calendar.

Returns void

show

Shows the Calendar.

Returns void

Events

blur

EmitType<BlurEventArgs>

Triggers when the input loses the focus.

change

EmitType<ChangedEventArgs>

Triggers when the Calendar value is changed.

close

EmitType<PreventableEventArgs|PopupObjectArgs>

Triggers when the popup is closed.

created

EmitType<Object>

Triggers when the component is created.

destroyed

EmitType<Object>

Triggers when the component is destroyed.

focus

EmitType<FocusEventArgs>

Triggers when the input gets focus.

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

open

EmitType<PreventableEventArgs|PopupObjectArgs>

Triggers when the popup is opened.

renderDayCell

EmitType<RenderDayCellEventArgs>

Triggers when each day cell of the Calendar is rendered.