activeStartDate | The beginning of a period that shall be displayed by default when no value is given. Defaults to today. | new Date(2017, 0, 1) |
calendarType | Defines which type of calendar should be used. Can be "ISO 8601", "US", "Arabic", or "Hebrew". Defaults to a calendar most commonly used in specific locale. Setting to "US" or "Hebrew" will change the first day of the week to Sunday. Setting to "Arabic" will change the first day of the week to Saturday. Setting to "Arabic" or "Hebrew" will make weekends appear on Friday to Saturday. | "ISO 8601" |
className | Defines class name(s) that will be added along with "react-calendar" to the main React-Calendar <div> element. | - String:
"class1 class2" - Array of strings:
["class1", "class2 class3"]
|
formatMonth | Function called to override default formatting of month names. Can be used to use your own formatting function. | (locale, date) => formatDate(date, 'MMM') |
formatMonthYear | Function called to override default formatting of month and year in the top navigation section. Can be used to use your own formatting function. | (locale, date) => formatDate(date, 'MMMM YYYY') |
formatShortWeekday | Function called to override default formatting of weekday names. Can be used to use your own formatting function. | (locale, date) => formatDate(date, 'dd') |
locale | Defines which locale should be used by the calendar. Can be any IETF language tag. Defaults to user's browser settings. | "hu-HU" |
maxDate | Defines maximum date that the user can select. Periods partially overlapped by maxDate will also be selectable, although react-calendar will ensure that no later date is selected. | Date: new Date() |
maxDetail | Defines the most detailed view that the user shall see. View defined here also becomes the one on which clicking an item will select a date and pass it to onChange. Can be "month", "year", "decade" or "century". Defaults to "month". | "month" |
minDate | Defines minimum date that the user can select. Periods partially overlapped by minDate will also be selectable, although react-calendar will ensure that no earlier date is selected. | Date: new Date() |
minDetail | Defines the least detailed view that the user shall see. Can be "month", "year", "decade" or "century". Defaults to "century". | "century" |
navigationLabel | Defines the content of a label rendered on calendar navigation bar. | ({ date, view, label }) => `Current view: ${view}, date: ${date.toLocaleDateString()}` |
nextLabel | Defines the content of the "next" button on the navigation pane. Defaults to "›". | - String:
"›" - React element:
<NextIcon />
|
next2Label | Defines the content of the "next on higher level" button on the navigation pane. Defaults to "»". | - String:
"»" - React element:
<DoubleNextIcon />
|
onActiveDateChange | Function called when the user navigates from one view to another using previous/next button. | ({ activeStartDate, view }) => alert('Changed view to: ', activeStartDate, view) |
onChange | Function called when the user clicks an item (day on month view, month on year view and so on) on the most detailed view available. | (value) => alert('New date is: ', value) |
onClickDay | Function called when the user clicks a day. | (value) => alert('Clicked day: ', value) |
onClickDecade | Function called when the user clicks a decade. | (value) => alert('Clicked decade: ', value) |
onClickMonth | Function called when the user clicks a month. | (value) => alert('Clicked month: ', value) |
onClickWeekNumber | Function called when the user clicks a week number. | (weekNumber, date) => alert('Clicked week: ', weekNumber, 'that starts on: ', date) |
onClickYear | Function called when the user clicks a year. | (value) => alert('Clicked year: ', value) |
onDrillDown | Function called when the user drills down by clicking a tile. | ({ activeStartDate, view }) => alert('Drilled down to: ', activeStartDate, view) |
onDrillUp | Function called when the user drills up by clicking drill up button. | ({ activeStartDate, view }) => alert('Drilled up to: ', activeStartDate, view) |
prevLabel | Defines the content of the "previous" button on the navigation pane. Defaults to "‹". | - String:
"‹" - React element:
<PreviousIcon />
|
prev2Label | Defines the content of the "previous on higher level" button on the navigation pane. Defaults to "«". | - String:
"«" - React element:
<DoublePreviousIcon />
|
returnValue | Defines which dates shall be passed by the calendar to the onChange function and onClick{Period} functions. Can be "start", "end" or "range". The latter will cause an array with start and end values to be passed. Defaults to "start". | "range" |
showNavigation | Defines whether a navigation bar with arrows and title shall be rendered. Defaults to true. | false |
showFixedNumberOfWeeks | Defines whether to always show fixed number of weeks (6). Forces showNeighboringMonth prop to be true. Defaults to false. | true |
showNeighboringMonth | Defines whether days from previous or next month shall be rendered if the month doesn't start on the first day of the week or doesn't end on the last day of the week, respectively. Defaults to true. | false |
selectRange | Defines whether the user shall select two dates forming a range instead of just one. Note: This feature will make React-Calendar return array with two dates regardless of returnValue setting. Defaults to false. | true |
showWeekNumbers | Defines whether week numbers shall be shown at the left of MonthView or not. Defaults to false. | true |
tileClassName | Defines class name(s) that will be applied to a given calendar item (day on month view, month on year view and so on). | - String:
"class1 class2" - Array of strings:
["class1", "class2 class3"] - Function:
({ date, view }) => view === 'month' && date.getDay() === 3 ? 'wednesday' : null
|
tileContent | Allows to render custom content within a given calendar item (day on month view, month on year view and so on). | - String:
"Sample" - React element:
<TileContent /> - Function:
({ date, view }) => view === 'month' && date.getDay() === 0 ? <p>It's Sunday!</p> : null
|
tileDisabled | Pass a function to determine if a certain day should be displayed as disabled. | - Function:
({activeStartDate, date, view }) => date.getDay() === 0
|
value | Defines the value of the calendar. | - Date:
new Date() - An array of dates:
[new Date(2017, 0, 1), new Date(2017, 7, 1)]
|
view | Determines which calendar view shall be opened initially. Does not disable navigation. Can be "month", "year", "decade" or "century". Defaults to the most detailed view allowed. | "year" |