Package Exports
- react-date-picker
- react-date-picker/index.css
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-date-picker) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
react-date-picker
Date picker for React
See demo at jslog.com/react-date-picker
Install
$ npm install react-date-picker
Usage
NOTES:
Don't forget to include index.css or index.styl! ( require('react-date-picker/index.css') )
Also you need to have React
included in the page.
The preferred React version for react-date-picker
is >=0.12. The initial version of react-date-picker
worked with React 0.11.2 as well, but I do not intend to continue to support it, in order to be able to focus on advancing the current features and developing other high-quality React components.
Example
var date = '2014-10-10' //or Date.now()
function onChange(moment, dateString){
//...
}
<DatePicker
minDate='2014-04-04'
maxDate='2015-10-10'
date={date}
onChange={onChange}
/>
Options
- hideFooter: Boolean - by default footer is shown, so specify this to true if you don't want the footer
- date : Date / String / Moment / Number
- viewDate: Date / String / Moment / Number
- minDate : Date / String / Moment / Number
- maxDate : Date / String / Moment / Number
- dateFormat: String see moment.js formats. Default date format is 'YYYY-MM-DD'
- onChange: Function(moment, dateText, event) - called when the user selects a date
- onSelect: Function(moment, dateText, view) - called when the user selects a year/month
- onNav: Function(moment, dateText, view, direction) - called when the user navigates to the next/previous month/year/decade.
- renderDay: Function - (optional) A function that should return a React DOM for the day cell. The first param is the props object. You can use this to have full control over what gets rendered for a day.
- onRenderDay: Function - (optional) A function that can manipulate the props object for a day, and SHOULD return a new props object. Use this for custom day styling. You can use this to take full control over the styles/css classes/attributes applied to the day cell in the month view.
Examples
Custom styling of day cells
function onRenderDay(props){
if (props.date.isBefore('2010-01-01')){
props.className += ' invalid'
}
props.style.border = '1px solid red'
return props
}
<DatePicker
onChange={this.onChange}
onRenderDay={onRenderDay}
/>
Contributing
When contributing, please work on the src
dir.
You'll need to run the following commands:
$ npm run serve # starts a local http server
$ npm run dev # starts webpack dev server, which does all the bundling
Now navigate to http://localhost:8080/
In order to build a new version, make sure you run npm run build
in order to build the lib
directory from the src
directory.
Other
react-date-picker
uses the awesome moment.js
library ( Big thanks!)
If you don't use npm you can include any of the following:
dist/react-date-picker.js
- the full sources. NOTE: You'll need to includeReact
separatelydist/react-date-picker.min.js
- minified & optimized version. NOTE: You'll need to includeReact
separatelydist/react-date-picker.nomoment.js
- the full sources. NOTE: You'll need to includeReact
ANDmoment.js
separatelydist/react-date-picker.nomoment.min.js
- minified & optimized version. NOTE: You'll need to includeReact
ANDmoment.js
separately
Changelog
v1.3.0
renderDay
&onRenderDay
properties are available to allow full control over day-cell renderingonNav
is called with new args: moment, text, view, direction - where moment is a date as a momentjs instance, text is the date formatted as text, the view is the view name ('month','year','decade') and direction is 1 (nav to next period) or -1 (nav to prev period)onSelect
is called with new args: moment, text, view