An input component for picking dates for your React application.
Sadly, the authors of original React-Date-Picker ≤5 have abandoned the package. Because it lacked compatibility with React 16, the package would quickly become dead.
In version 6 I aim to provide a solution that will suit everyone's needs. To make that happen, I need time and your help. Please don't hesitate to file an issues with bugs, suggestions, or simply telling me more about how you use react-date-picker. Your help will be invaluable!
Upgrade guide for React-Date-Picker ≤5 users is there to help you with the upgrade.
- Install by executing
npm install react-date-pickeroryarn add react-date-picker. - Import by adding
import DatePicker from 'react-date-picker'. - Use by adding
<DatePicker />. UseonChangeprop for getting new values.
Minimal demo page is included in sample directory.
Online demo is also available!
React-Calendar, on which React-Date-Picker relies heavily, uses modern web technologies. That's why it's so fast, lightweight and easy to style. This, however, comes at a cost of supporting only modern browsers.
| Browser | Minimum supported version |
|---|---|
| Google Chrome | 24 |
| Mozilla Firefox | 29 |
| Microsoft Edge | 12 |
| Apple Safari | 10 |
| Apple Safari (iOS) | 10.2 |
| Opera | 15 |
| Internet Explorer | 11 |
| Samsung Internet | 4 |
If you need to support legacy browsers like Internet Explorer 10, you will need to use Intl.js or another Intl polyfill along with React-Date-Picker.
Add React-Date-Picker to your project by executing npm install react-date-picker or yarn add react-date-picker.
Here's an example of basic usage:
import React, { Component } from 'react';
import DatePicker from 'react-date-picker';
class MyApp extends Component {
state = {
date: new Date(),
}
onChange = date => this.setState({ date })
render() {
return (
<div>
<DatePicker
onChange={this.onChange}
value={this.state.date}
/>
</div>
);
}
}If you don't want to use default React-Date-Picker styling to build upon it, you can import React-Date-Picker by using import DatePicker from 'react-date-picker/build/entry.nostyle'; instead.
Displays an input field complete with custom inputs, native input, and a calendar.
| Prop name | Description | Example values |
|---|---|---|
| calendarClassName | Defines class name(s) that will be added along with "react-calendar" to the main React-Calendar <div> element. |
|
| calendarType | Defines which type of calendar should be used. Can be "US" or "ISO 8601". Defaults to "US" for "en-US" locale, "ISO 8601" to all the others. | "ISO 8601" |
| className | Defines class name(s) that will be added along with "react-date-picker" to the main React-Date-Picker <div> element. |
|
| isOpen | Defined whether the calendar should be opened. Defaults to false. | true |
| 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-date-picker 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-date-picker 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" |
| nextLabel | Defines the content of the "next" button on the navigation pane. Defaults to "›". |
|
| next2Label | Defines the content of the "next on higher level" button on the navigation pane. Defaults to "»". |
|
| onChange | Function called when the user clicks an item on the most detailed view available. | (value) => alert('New date is: ', value) |
| onClickDay | Function called when the user clicks a day on a calendar. | (value) => alert('Clicked day: ', value) |
| onClickDecade | Function called when the user clicks a decade on a calendar. | (value) => alert('Clicked decade: ', value) |
| onClickMonth | Function called when the user clicks a month on a calendar. | (value) => alert('Clicked month: ', value) |
| onClickYear | Function called when the user clicks a year on a calendar. | (value) => alert('Clicked year: ', value) |
| prevLabel | Defines the content of the "previous" button on the navigation pane. Defaults to "‹". |
|
| prev2Label | Defines the content of the "previous on higher level" button on the navigation pane. Defaults to "«". |
|
| renderChildren | Allows to render custom content within a given calendar item (day on month view, month on year view and so on). | ({ date, view }) => view === 'month' && date.getDay() === 0 ? <p>It's Sunday!</p> : null |
| 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" |
| 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 |
| showWeekNumbers | Defines whether week numbers shall be shown at the left of MonthView or not. Defaults to false. | true |
| value | Defines the value of the input. |
|
| 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" |
The MIT License.
|
Wojciech Maj [email protected] http://wojtekmaj.pl |