Installations
npm install react-date-pickerScore
90.8
Supply Chain
94.4
Quality
77.5
Maintenance
100
Vulnerability
100
License
Developer
Developer Guide
Module System
ESM
Min. Node Version
Typescript Support
Yes
Node Version
20.12.2
NPM Version
10.5.0
Statistics
1,278 Stars
1,109 Commits
195 Forks
13 Watching
4 Branches
26 Contributors
Updated on 27 Nov 2024
Bundle Size
61.27 kB
Minified
16.76 kB
Minified + Gzipped
Languages
TypeScript (97.09%)
CSS (2.69%)
HTML (0.21%)
Total Downloads
Cumulative downloads
Total Downloads
33,966,898
Last day
7.5%
43,327
Compared to previous day
Last week
-4.8%
222,647
Compared to previous week
Last month
10.9%
1,050,321
Compared to previous month
Last year
42.1%
10,938,971
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
7
Peer Dependencies
3
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-pickeroryarn add react-date-picker. - Import by adding
import DatePicker from 'react-date-picker'. - Use by adding
<DatePicker />. UseonChangeprop for getting new values.
Demo
A minimal demo page can be found in sample directory.
Online demo is also available!
Consider native alternative
If you don't need to support legacy browsers and don't need the advanced features this package provides, consider using native date input instead. It's more accessible, adds no extra weight to your bundle, and works better on mobile devices.
1<input aria-label="Date" type="date" />
Looking for a time picker or a datetime picker?
React-Date-Picker will play nicely with React-Time-Picker and 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.8 | latest |
| ≥16.3 | 8.x |
| ≥16.0 | 7.x |
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.
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:
1import { useState } from 'react'; 2import DatePicker from 'react-date-picker'; 3 4type ValuePiece = Date | null; 5 6type Value = ValuePiece | [ValuePiece, ValuePiece]; 7 8function MyApp() { 9 const [value, onChange] = useState<Value>(new Date()); 10 11 return ( 12 <div> 13 <DatePicker onChange={onChange} value={value} /> 14 </div> 15 ); 16}
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:
1import 'react-date-picker/dist/DatePicker.css'; 2import '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" |
| calendarProps | Props to pass to React-Calendar component. | n/a | See React-Calendar documentation |
| calendarIcon | Content of the calendar button. Setting the value explicitly to null will hide the icon. | (default icon) |
|
| className | Class name(s) that will be added along with "react-date-picker" to the main React-Date-Picker <div> element. | n/a |
|
| clearAriaLabel | aria-label for the clear button. | n/a | "Clear value" |
| clearIcon | Content of the clear button. Setting the value explicitly to null will hide the icon. | (default icon) |
|
| closeCalendar | Whether to close the calendar on value selection. Note: It's recommended to use shouldCloseCalendar function instead. | true | false |
| data-testid | data-testid attribute for the main React-Date-Picker <div> element. | n/a | "date-picker" |
| dayAriaLabel | aria-label for the day input. | n/a | "Day" |
| dayPlaceholder | placeholder for the day input. | "--" | "dd" |
| disableCalendar | When set to true, will remove the calendar and the button toggling its visibility. | false | true |
| disabled | Whether the date picker should be disabled. | false | true |
| format | Input format based on Unicode Technical Standard #35. Supported values are: y, M, MM, MMM, MMMM, d, dd. Note: When using SSR, setting this prop may help resolving hydration errors caused by locale mismatch between server and client. | n/a | "y-MM-dd" |
| id | id attribute for the main React-Date-Picker <div> 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. 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 |
|
| 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.
License
The MIT License.
Author
| Wojciech Maj |
Thank you
Sponsors
Thank you to all our sponsors! Become a sponsor and get your image on our README on GitHub.
Backers
Thank you to all our backers! Become a backer and get your image on our README on GitHub.
Top Contributors
Thank you to all our contributors that helped on this project!
No vulnerabilities found.
Reason
14 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/publish.yml:14
Reason
0 existing vulnerabilities detected
Reason
Found 0/27 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/close-stale-issues.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/ci.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/ci.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/close-stale-issues.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/close-stale-issues.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/publish.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/publish.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-date-picker/publish.yml/main?enable=pin
- Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 3 are checked with a SAST tool
Score
5.2
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More