| commit | author | age | ||
| 9fb8e8 | 1 | react-datetime |
| 4afe21 | 2 | =============================== |
| 18dc17 | 3 | A date and time picker in the same React.js component. It can be used as a datepicker, timepicker or both at the same time. |
| 4afe21 | 4 | |
| 889b6c | 5 | [](https://travis-ci.org/arqex/react-datetime) |
| 7d1067 | 6 | [](http://badge.fury.io/js/react-datetime) |
| 889b6c | 7 | |
| eba92b | 8 | It allows to edit even date's milliseconds. |
| M | 9 | |
| 18dc17 | 10 | This project started as a fork of https://github.com/quri/react-bootstrap-datetimepicker but the code and the API has changed a lot. |
| ce8749 | 11 | |
| f13618 | 12 | Usage |
| LC | 13 | =============================== |
| 14 | ||
| 15 | Installation : | |
| 16 | ``` | |
| 9fb8e8 | 17 | npm install react-datetime |
| f13618 | 18 | ``` |
| LC | 19 | |
| f60b22 | 20 | [React.js](http://facebook.github.io/react/) and [Moment.js](http://momentjs.com/) are peer dependencies for react-datetime. These dependencies are not installed along with react-datetime automatically, but your project needs to have them installed in order to make the datetime picker work. |
| M | 21 | |
| f13618 | 22 | Then |
| LC | 23 | ```javascript |
| 9fb8e8 | 24 | require('react-datetime'); |
| f13618 | 25 | |
| LC | 26 | ... |
| 27 | ||
| 28 | render: function() { | |
| 9fb8e8 | 29 | return <Datetime />; |
| f13618 | 30 | } |
| LC | 31 | ``` |
| 18dc17 | 32 | [See this example working](http://codepen.io/arqex/pen/BNRNBw). |
| f13618 | 33 | |
| LC | 34 | API |
| 35 | =============================== | |
| 36 | ||
| 37 | | Name | Type | Default | Description | | |
| 38 | | ------------ | ------- | ------- | ----------- | | |
| 0d9dc7 | 39 | | **value** | Date | new Date() | Represents the selected date by the component, in order to use it as a [controlled component](https://facebook.github.io/react/docs/forms.html#controlled-components). This prop is parsed by moment.js, so it is possible to use a date string or a moment.js date. | |
| M | 40 | | **defaultValue** | Date | new Date() | Represents the selected date for the component to use it as a [uncontrolled component](https://facebook.github.io/react/docs/forms.html#uncontrolled-components). This prop is parsed by moment.js, so it is possible to use a date string or a moment.js date. | |
| cbe644 | 41 | | **dateFormat** | `bool` or `string` | `true` | Defines the format for the date. It accepts any [moment.js date format](http://momentjs.com/docs/#/displaying/format/). If `true` the date will be displayed using the defaults for the current locale. If `false` the datepicker is disabled and the component can be used as timepicker. | |
| M | 42 | | **timeFormat** | `bool` or `string` | `true` | Defines the format for the time. It accepts any [moment.js time format](http://momentjs.com/docs/#/displaying/format/). If `true` the time will be displayed using the defaults for the current locale. If `false` the timepicker is disabled and the component can be used as datepicker. | |
| c37f80 | 43 | | **input** | boolean | true | Wether to show an input field to edit the date manually. | |
| 87c677 | 44 | | **open** | boolean | null | Wether to open or close the picker. If not set react-datetime will open the datepicker on input focus and close it on click outside. | |
| c37f80 | 45 | | **locale** | string | null | Manually set the locale for the react-datetime instance. Moment.js locale needs to be loaded to be used, see [i18n docs](#i18n). |
| 62fd2f | 46 | | **onChange** | function | empty function | Callback trigger when the date changes. The callback receives the selected `moment` object as only parameter, if the date in the input is valid. If it isn't, the value of the input (a string) is returned. | |
| M | 47 | | **onBlur** | function | empty function | Callback trigger for when the user clicks outside of the input, simulating a regular onBlur. The callback receives the selected `moment` object as only parameter, if the date in the input is valid. If it isn't, the value of the input (a string) is returned. | |
| 9fb8e8 | 48 | | **viewMode** | string or number | 'days' | The default view to display when the picker is shown. ('years', 'months', 'days', 'time') | |
| 8abb28 | 49 | | **className** | string | `""` | Extra class names for the component markup. | |
| 4cdcdb | 50 | | **inputProps** | object | undefined | Defines additional attributes for the input element of the component. | |
| baa9f1 | 51 | | **isValidDate** | function | () => true | Define the dates that can be selected. The function receives `(currentDate, selectedDate)` and should return a `true` or `false` whether the `currentDate` is valid or not. See [selectable dates](#selectable-dates).| |
| 0d9dc7 | 52 | | **renderDay** | function | DOM.td( day ) | Customize the way that the days are shown in the day picker. The accepted function has the `selectedDate`, the current date and the default calculated `props` for the cell, and must return a React component. See [appearance customization](#appearance-customization) | |
| M | 53 | | **renderMonth** | function | DOM.td( month ) | Customize the way that the months are shown in the month picker. The accepted function has the `selectedDate`, the current date and the default calculated `props` for the cell, the `month` and the `year` to be shown, and must return a React component. See [appearance customization](#appearance-customization) | |
| 54 | | **renderYear** | function | DOM.td( year ) | Customize the way that the years are shown in the year picker. The accepted function has the `selectedDate`, the current date and the default calculated `props` for the cell, the `year` to be shown, and must return a React component. See [appearance customization](#appearance-customization) | | |
| 0eb226 | 55 | | **strictParsing** | boolean | false | Whether to use moment's [strict parsing](http://momentjs.com/docs/#/parsing/string-format/) when parsing input. |
| f13618 | 56 | |
| c37f80 | 57 | ## i18n |
| M | 58 | Different language and date formats are supported by react-datetime. React uses [moment.js](http://momentjs.com/) to format the dates, and the easiest way of changing the language of the calendar is [changing the moment.js locale](http://momentjs.com/docs/#/i18n/changing-locale/). |
| 59 | ||
| 60 | ```js | |
| 61 | var moment = require('moment'); | |
| 62 | require('moment/locale/fr'); | |
| 63 | // Now react-datetime will be in french | |
| 64 | ``` | |
| 65 | ||
| 66 | If there are multiple locales loaded, you can use the prop `locale` to define what language should be used by the instance: | |
| 67 | ```js | |
| 182c2b | 68 | <Datetime locale="fr-ca" /> |
| c37f80 | 69 | <Datetime locale="de" /> |
| M | 70 | ``` |
| 71 | [Here you can see the i18n example working](http://codepen.io/arqex/pen/PqJMQV). | |
| 72 | ||
| eba92b | 73 | ## Appearance customization |
| M | 74 | It is possible to customize the way that the datetime picker display the days, months and years in the calendar. To adapt the calendar to every need it is possible to use the props `renderDay( props, currentDate, selectedDate )`, `renderMonth( props, month, year, selectedDate )` and `renderYear( props, year, selectedDate )` of react-datetime. |
| 75 | ||
| 76 | ```js | |
| 77 | var MyDTPicker = React.createClass({ | |
| 78 | render: function(){ | |
| 79 | return <Datetime | |
| 80 | renderDay={ this.renderDay } | |
| 81 | renderMonth={ this.renderMonth } | |
| 82 | renderYear={ this.renderYear } | |
| 83 | />; | |
| 84 | }, | |
| 199ffb | 85 | renderDay: function( props, currentDate, selectedDate ){ |
| M | 86 | return <td {...props}>{ '0' + currentDate.date() }</td>; |
| eba92b | 87 | }, |
| 199ffb | 88 | renderMonth: function( props, month, year, selectedDate){ |
| eba92b | 89 | return <td {...props}>{ month }</td>; |
| M | 90 | }, |
| 199ffb | 91 | renderYear: function( props, year, selectedDate ){ |
| M | 92 | return <td {...props}>{ year % 100 }</td>; |
| eba92b | 93 | } |
| M | 94 | }); |
| 95 | ``` | |
| 199ffb | 96 | [You can see this customized calendar here.](http://codepen.io/arqex/pen/mJzRwM) |
| eba92b | 97 | |
| M | 98 | * `props` is the object that react-date picker has calculated for this object. It is convenient to use this object as the props for your custom component, since it knows how to handle the click event and its `className` attribute is used by the default styles. |
| 99 | * `selectedDate` and `currentDate` are Moment.js objects and can be used to change the output depending on the selected date, or the date for the current day. | |
| 100 | * `month` and `year` are the numeric representation of the current month and year to be displayed. Notice that the possible `month` values go from `0` to `11`. | |
| 101 | ||
| baa9f1 | 102 | ## Selectable dates |
| M | 103 | It is possible to disable dates in the calendar if we don't want the user to select them. It is possible thanks to the prop `isValidDate`, which admits a function in the form `function( currentDate, selectedDate )` where both arguments are moment.js objects. The function should return `true` for selectable dates, and `false` for disabled ones. |
| 104 | ||
| 105 | If we want to disable all the dates before today we can do like | |
| 106 | ```js | |
| 199ffb | 107 | // Let's use moment static reference in the Datetime component. |
| M | 108 | var yesterday = Datetime.moment().subtract(1,'day'); |
| baa9f1 | 109 | var valid = function( current ){ |
| 199ffb | 110 | return current.isAfter( yesterday ); |
| baa9f1 | 111 | }; |
| M | 112 | <Datetime isValidDate={ valid } /> |
| 113 | ``` | |
| 199ffb | 114 | [See the isValidDate prop working here](http://codepen.io/arqex/pen/jPeyGX). |
| baa9f1 | 115 | |
| 199ffb | 116 | If we want to disable the weekends |
| baa9f1 | 117 | ```js |
| M | 118 | var valid = function( current ){ |
| 199ffb | 119 | return current.day() != 0 && current.day() != 6; |
| baa9f1 | 120 | }; |
| M | 121 | <Datetime isValidDate={ valid } /> |
| 122 | ``` | |
| 199ffb | 123 | [The example working here](http://codepen.io/arqex/pen/VLEPXb). |
| baa9f1 | 124 | |
| ce8749 | 125 | Contributions |
| LC | 126 | =============================== |
| 9fb8e8 | 127 | Any help is always welcome :) |
| M | 128 | |
| 8abb28 | 129 | ### [Changelog](CHANGELOG.md) |
| M | 130 | |
| 9fb8e8 | 131 | ### [MIT Licensed](LICENSE) |
