Name | Type | Default | Availability (DatePicker/ Calendar) |
---|---|---|---|
ref | React.RefObject | true | both |
value | Date, DateObject, String, Number or Array | new Date() | both |
multiple | Boolean | false (true if value is Array) | both |
range | Boolean | false | both |
onlyMonthPicker | Boolean | false | both |
onlyYearPicker | Boolean | false | both |
format | String | YYYY/MM/DD | both |
formattingIgnoreList | Array | both | |
calendar | String | gregorian | both |
locale | String | en | both |
mapDays | Function | both | |
onChange | Function | both | |
className | String | both | |
weekDays | Array | both | |
months | Array | both | |
showOtherDays | Boolean | false | both |
minDate | Date, DateObject, String or Number | both | |
maxDate | Date, DateObject, String or Number | both | |
disableYearPicker | Boolean | false | both |
disableMonthPicker | Boolean | false | both |
zIndex | Number | 100 | both |
plugins | Array | [] | both |
sort | Boolean | false | both |
numberOfMonths | Number | 1 | both |
currentDate | DateObject | both | |
digits | Array | both | |
buttons | Boolean | true | both |
renderButton | Function or React.ReactElement | both | |
weekStartDayIndex | Number | both | |
disableDayPicker | Boolean | false | both |
onPropsChange | Function | both | |
onMonthChange | Function | both | |
onYearChange | Function | both | |
onFocusedDateChange | Function | both | |
readOnly | Boolean | false | both |
disabled | Boolean | false | both |
hideMonth | Boolean | false | both |
hideYear | Boolean | false | both |
shadow | Boolean | true | both |
fullYear | Boolean | false | both |
displayWeekNumbers | Boolean | false | both |
weekNumber | String | both | |
weekPicker | Boolean | false | both |
rangeHover | Boolean | false | both |
monthYearSeparator | String | "," for LTR locales "،" for RTL locales | both |
formatMonth | Function | undefined | both |
formatYear | Function | undefined | both |
highlightToday | Boolean | true | both |
style | React.CSSProperties | {} | Both |
headerOrder | Array | ["LEFT_BUTTON", "MONTH_YEAR", "RIGHT_BUTTON"] | Both |
arrow | Boolean or React.ReactElement | true | DatePicker |
arrowStyle | React.CSSProperties | DatePicker | |
arrowClassName | String | DatePicker | |
animations | Array | false | DatePicker |
inputClass | String | "" | DatePicker |
name | String | "" | DatePicker |
id | String | "" | DatePicker |
title | String | "" | DatePicker |
placeholder | String | "" | DatePicker |
render | React.Component or Function | DatePicker | |
disabled | Boolean | false | DatePicker |
inputMode | String | DatePicker | |
scrollSensitive | Boolean | true | DatePicker |
hideOnScroll | Boolean | false | DatePicker |
calendarPosition | String | auto | DatePicker |
containerStyle | Object | DatePicker | |
containerClassName | String | DatePicker | |
editable | Boolean | true | DatePicker |
onlyShowInRangeDates | Boolean | true | DatePicker |
onOpen | Function | DatePicker | |
onClose | Function | DatePicker | |
fixMainPosition | Boolean | false | DatePicker |
fixRelativePosition | Boolean | false | DatePicker |
offsetY | Number | 0 | DatePicker |
offsetX | Number | 0 | DatePicker |
onPositionChange | Function | DatePicker | |
mobileLabels | Object | DatePicker | |
portal | Boolean | DatePicker | |
portalTarget | HTMLElement | DatePicker | |
onOpenPickNewDate | Boolean | true | DatePicker |
mobileButtons | HTMLButtonElement[] | [] | DatePicker |
dateSeparator | String | '~' in range mode, ',' in multiple mode | DatePicker |
multipleRangeSeparator | String | ',' | DatePicker |
typingTimeout | Number | 700 | DatePicker |
autoFocus | Boolean | false | Calendar |