[![npm](https://img.shields.io/npm/v/react-date-picker.svg)](https://www.npmjs.com/package/react-date-picker) ![downloads](https://img.shields.io/npm/dt/react-date-picker.svg) [![CI](https://github.com/wojtekmaj/react-date-picker/actions/workflows/ci.yml/badge.svg)](https://github.com/wojtekmaj/react-date-picker/actions) # React-Date-Picker A date picker for your React app. - Pick days, months, years, or even decades - Supports virtually any language - No moment.js needed ## tl;dr - Install by executing `npm install react-date-picker` or `yarn add react-date-picker`. - Import by adding `import DatePicker from 'react-date-picker'`. - Use by adding ``. Use `onChange` prop for getting new values. ## Demo A minimal demo page can be found in `sample` directory. [Online demo](https://projects.wojtekmaj.pl/react-date-picker/) is also available! ## Looking for a time picker or a datetime picker? React-Date-Picker will play nicely with [React-Time-Picker](https://github.com/wojtekmaj/react-time-picker) and [React-DateTime-Picker](https://github.com/wojtekmaj/react-datetime-picker). Check them out! ## Getting started ### Compatibility Your project needs to use React 16.3 or later. If you use an older version of React, please refer to the table below to find a suitable React-Date-Picker version. | React version | Newest compatible React-Date-Picker version | | ------------- | ------------------------------------------- | | ≥16.3 | latest | | ≥16.0 | 7.x | [React-Calendar](https://github.com/wojtekmaj/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](https://caniuse.com/#feat=internationalization). #### Legacy browsers If you need to support legacy browsers like Internet Explorer 10, you will need to use [Intl.js](https://github.com/andyearnshaw/Intl.js/) or another Intl polyfill along with React-Date-Picker. ### Installation Add React-Date-Picker to your project by executing `npm install react-date-picker` or `yarn add react-date-picker`. ### Usage Here's an example of basic usage: ```tsx import { useState } from 'react'; import DatePicker from 'react-date-picker'; type ValuePiece = Date | null; type Value = ValuePiece | [ValuePiece, ValuePiece]; function MyApp() { const [value, onChange] = useState(new Date()); return (

); } ``` ### Custom styling If you want to use default React-Date-Picker and React-Calendar styling to build upon it, you can import them by using: ```ts import 'react-date-picker/dist/DatePicker.css'; import 'react-calendar/dist/Calendar.css'; ``` ## User guide ### DatePicker Displays an input field complete with custom inputs, native input, and a calendar. #### Props | Prop name | Description | Default value | Example values | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | autoFocus | Automatically focuses the input on mount. | n/a | `true` | | calendarAriaLabel | `aria-label` for the calendar button. | n/a | `"Toggle calendar"` | | calendarClassName | Class name(s) that will be added along with `"react-calendar"` to the main React-Calendar `

` element. | n/a |

String: `"class1 class2"`
Array of strings: `["class1", "class2 class3"]`

String: `"Calendar"`
React element: ``
React function: `CalendarIcon`

| | className | Class name(s) that will be added along with `"react-date-picker"` to the main React-Date-Picker `

` element. | n/a |

String: `"class1 class2"`
Array of strings: `["class1", "class2 class3"]`

String: `"Clear"`
React element: ``
React function: `ClearIcon`

` element. | n/a | `"date-picker"` | | isOpen | Whether the calendar should be opened. | `false` | `true` | | locale | Locale that should be used by the date picker and the calendar. Can be any [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag). **Note**: When using SSR, setting this prop may help resolving hydration errors caused by locale mismatch between server and client. | Server locale/User's browser settings | `"hu-HU"` | | maxDate | 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. | n/a | Date: `new Date()` | | maxDetail | The most detailed calendar view that the user shall see. View defined here also becomes the one on which clicking an item in the calendar will select a date and pass it to onChange. Can be `"month"`, `"year"`, `"decade"` or `"century"`. | `"month"` | `"year"` | | minDate | 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. | n/a | Date: `new Date()` | | monthAriaLabel | `aria-label` for the month input. | n/a | `"Month"` | | monthPlaceholder | `placeholder` for the month input. | `"--"` | `"mm"` | | name | Input name. | `"date"` | `"myCustomName"` | | nativeInputAriaLabel | `aria-label` for the native date input. | n/a | `"Date"` | | onCalendarClose | Function called when the calendar closes. | n/a | `() => alert('Calendar closed')` | | onCalendarOpen | Function called when the calendar opens. | n/a | `() => alert('Calendar opened')` | | onChange | Function called when the user picks a valid date. If any of the fields were excluded using custom `format`, `new Date(y, 0, 1, 0, 0, 0)`, where `y` is the current year, is going to serve as a "base". | n/a | `(value) => alert('New date is: ', value)` | | onFocus | Function called when the user focuses an input. | n/a | `(event) => alert('Focused input: ', event.target.name)` | | onInvalidChange | Function called when the user picks an invalid date. | n/a | `() => alert('Invalid date')` | | openCalendarOnFocus | Whether to open the calendar on input focus. **Note**: It's recommended to use `shouldOpenCalendar` function instead. | `true` | `false` | | portalContainer | Element to render the calendar in using portal. | n/a | `document.getElementById('my-div')` | | required | Whether date input should be required. | `false` | `true` | | returnValue | 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. | `"start"` | `"range"` | | shouldCloseCalendar | Function called before the calendar closes. `reason` can be `"buttonClick"`, `"escape"`, `"outsideAction"`, or `"select"`. If it returns `false`, the calendar will not close. | n/a | `({ reason }) => reason !== 'outsideAction'` | | shouldOpenCalendar | Function called before the calendar opens. `reason` can be `"buttonClick"` or `"focus"`. If it returns `false`, the calendar will not open. | n/a | `({ reason }) => reason !== 'focus'` | | showLeadingZeros | Whether leading zeros should be rendered in date inputs. | `false` | `true` | | value | Input value. Note that if you pass an array of values, only first value will be fully utilized. | n/a |

Date: `new Date(2017, 0, 1)`
String: `"2017-01-01"`
An array of dates: `[new Date(2017, 0, 1), new Date(2017, 7, 1)]`
An array of strings: `["2017-01-01", "2017-08-01"]`

| | yearAriaLabel | `aria-label` for the year input. | n/a | `"Year"` | | yearPlaceholder | `aria-label` for the year input. | `"----"` | `"yyyy"` | ### Calendar DatePicker component passes all props to React-Calendar, with the exception of `className` (you can use `calendarClassName` for that instead). There are tons of customizations you can do! For more information, see [Calendar component props](https://github.com/wojtekmaj/react-calendar#props). ## License The MIT License. ## Author

Wojciech Maj

## Thank you ### Sponsors Thank you to all our sponsors! [Become a sponsor](https://opencollective.com/react-date-picker#sponsor) and get your image on our README on GitHub.

### Backers Thank you to all our backers! [Become a backer](https://opencollective.com/react-date-picker#backer) and get your image on our README on GitHub.

### Top Contributors Thank you to all our contributors that helped on this project! ![Top Contributors](https://opencollective.com/react-date-picker/contributors.svg?width=890&button=false)

	Stars	Issues	Version	Updated	Created
react-bootstrap-date-picker	344	62	5.1.0	7 years ago	8 years ago
react-date-picker	1,217	26	10.6.0	5 months ago	10 years ago
react-datepicker	7,835	316	6.9.0	8 days ago	10 years ago

react-bootstrap-date-picker vs react-date-picker vs react-datepicker

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past