| | |
|---|
| | | | ------------ | ------- | ------- | ----------- | |
|---|
| | | | **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` object. | |
|---|
| | | | **defaultValue** | `Date` | `new Date()` | Represents the selected date for the component to use it as a [uncontrolled component](https://facebook.github.io/react/docs/uncontrolled-components.html). This prop is parsed by Moment.js, so it is possible to use a date `string` or a `moment` object. | |
|---|
| | | | **viewDate** | `Date` | `new Date()` | Represents the month which is viewed on opening the calendar when there is no selected date. This prop is parsed by Moment.js, so it is possible to use a date `string` or a `moment` object. | |
|---|
| | | | **dateFormat** | `boolean` or `string` | `true` | Defines the format for the date. It accepts any [Moment.js date format](http://momentjs.com/docs/#/displaying/format/) (not in localized 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, see [available units docs](#specify-available-units). | |
|---|
| | | | **timeFormat** | `boolean` or `string` | `true` | Defines the format for the time. It accepts any [Moment.js time format](http://momentjs.com/docs/#/displaying/format/) (not in localized 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, see [available units docs](#specify-available-units). | |
|---|
| | | | **input** | `boolean` | `true` | Whether to show an input field to edit the date manually. | |
|---|
| | |
|---|
| | | | **className** | `string` or `string array` | `''` | Extra class name for the outermost markup element. | |
|---|
| | | | **inputProps** | `object` | `undefined` | Defines additional attributes for the input element of the component. For example: `onClick`, `placeholder`, `disabled`, `required`, `name` and `className` (`className` *sets* the class attribute for the input element). See [Customize the Input Appearance](#customize-the-input-appearance). | |
|---|
| | | | **isValidDate** | `function` | `() => true` | Define the dates that can be selected. The function receives `(currentDate, selectedDate)` and shall return a `true` or `false` whether the `currentDate` is valid or not. See [selectable dates](#selectable-dates).| |
|---|
| | | | **renderInput** | `function` | `undefined` | Replace the rendering of the input element. The accepted function has `openCalendar` (a function which opens the calendar) and the default calculated `props` for the input. Must return a React component or `null`. See [Customize the Input Appearance](#customize-the-input-appearance). | |
|---|
| | | | **renderInput** | `function` | `undefined` | Replace the rendering of the input element. The function has the following arguments: the default calculated `props` for the input, `openCalendar` (a function which opens the calendar) and `closeCalendar` (a function which closes the calendar). Must return a React component or `null`. See [Customize the Input Appearance](#customize-the-input-appearance). | |
|---|
| | | | **renderDay** | `function` | `DOM.td(day)` | Customize the way that the days are shown in the daypicker. The accepted function has the `selectedDate`, the current date and the default calculated `props` for the cell, and must return a React component. See [Customize the Datepicker Appearance](#customize-the-datepicker-appearance). | |
|---|
| | | | **renderMonth** | `function` | `DOM.td(month)` | Customize the way that the months are shown in the monthpicker. 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 [Customize the Datepicker Appearance](#customize-the-datepicker-appearance). | |
|---|
| | | | **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 [Customize the Datepicker Appearance](#customize-the-datepicker-appearance). | |
|---|
| | | | **strictParsing** | `boolean` | `false` | Whether to use Moment.js's [strict parsing](http://momentjs.com/docs/#/parsing/string-format/) when parsing input. |
|---|
| | | | **strictParsing** | `boolean` | `true` | Whether to use Moment.js's [strict parsing](http://momentjs.com/docs/#/parsing/string-format/) when parsing input. |
|---|
| | | | **closeOnSelect** | `boolean` | `false` | When `true`, once the day has been selected, the datepicker will be automatically closed. |
|---|
| | | | **closeOnTab** | `boolean` | `true` | When `true` and the input is focused, pressing the `tab` key will close the datepicker. |
|---|
| | | | **timeConstraints** | `object` | `null` | Add some constraints to the timepicker. It accepts an `object` with the format `{ hours: { min: 9, max: 15, step: 2 }}`, this example means the hours can't be lower than `9` and higher than `15`, and it will change adding or subtracting `2` hours everytime the buttons are clicked. The constraints can be added to the `hours`, `minutes`, `seconds` and `milliseconds`. |
|---|
| | |
|---|
| | | It is possible to customize the way that the input is displayed. The simplest is to supply `inputProps` which get assigned to the default `<input />` element within the component. |
|---|
| | | |
|---|
| | | ```js |
|---|
| | | <DateTime inputProps={{ placeholder: 'N/A', disabled: true }}> |
|---|
| | | <Datetime inputProps={{ placeholder: 'N/A', disabled: true }}> |
|---|
| | | ``` |
|---|
| | | |
|---|
| | | Alternatively, if you need to render different content than an `<input />` element, you may supply a `renderInput` function which is called instead. |
|---|
| | |
|---|
| | | render: function(){ |
|---|
| | | return <Datetime renderInput={ this.renderInput } />; |
|---|
| | | }, |
|---|
| | | renderInput: function( props, openCalendar ){ |
|---|
| | | renderInput: function( props, openCalendar, closeCalendar ){ |
|---|
| | | function clear(){ |
|---|
| | | props.onChange({target: {value: ''}}); |
|---|
| | | } |
|---|
| | |
|---|
| | | <div> |
|---|
| | | <input {...props} /> |
|---|
| | | <button onClick={openCalendar}>open calendar</button> |
|---|
| | | <button onClick={closeCalendar}>close calendar</button> |
|---|
| | | <button onClick={clear}>clear</button> |
|---|
| | | </div> |
|---|
| | | ); |
|---|
| | |
|---|
| | | |
|---|
| | | ## Specify Available Units |
|---|
| | | You can filter out what you want the user to be able to pick by using `dateFormat` and `timeFormat`, e.g. to create a timepicker, yearpicker etc. |
|---|
| | | |
|---|
| | | |
|---|
| | | In this example the component is being used as a *timepicker* and can *only be used for selecting a time*. |
|---|
| | | ```js |
|---|
| | | <Datetime dateFormat={false} /> |
|---|
