A datetime picker for your React app.
- Supports virtually any language
- No moment.js needed
- Install by executing
npm install --save https://github.com/mohsinriaz17/react-datetime-pickeroryarn add react-datetime-picker. - Import by adding
import DateTimePicker from 'react-datetime-picker'. - Use by adding
<DateTimePicker />. UseonChangeprop for getting new values.
Minimal demo page is included in sample directory.
Online demo is also available!
React-DateTime-Picker will play nicely with React-Date-Picker and React-Time-Picker. Check them out!
Your project needs to use React 16 or later. If you use older version of React, please refer to the table below to find suitable React-DateTime-Picker version.
| React version | Newest supported React-DateTime-Picker |
|---|---|
| >16.0 | latest |
| >15.5 | 1.0.1 |
React-Calendar, on which React-DateTime-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.
If you need to support legacy browsers like Internet Explorer 10, you will need to use Intl.js or another Intl polyfill along with React-DateTime-Picker.
Add React-DateTime-Picker to your project by executing npm install react-datetime-picker or yarn add react-datetime-picker.
Here's an example of basic usage:
import React, { Component } from 'react';
import DateTimePicker from 'react-datetime-picker';
class MyApp extends Component {
state = {
date: new Date(),
}
onChange = date => this.setState({ date })
render() {
return (
<div>
<DateTimePicker
onChange={this.onChange}
value={this.state.date}
/>
</div>
);
}
}If you don't want to use default React-DateTime-Picker styling to build upon it, you can import React-DateTime-Picker by using import DateTimePicker from 'react-datetime-picker/dist/entry.nostyle'; instead.
Displays an input field complete with custom inputs, native input, a calendar, and a clock.
| Prop name | Description | Example values |
|---|---|---|
| calendarClassName | Defines class name(s) that will be added along with "react-calendar" to the main React-Calendar <div> element. |
|
| clockClassName | Defines class name(s) that will be added along with "react-clock" to the main React-Calendar <div> element. |
|
| calendarIcon | Defines the content of the calendar button. Setting the value explicitly to null will hide the icon. |
|
| className | Defines class name(s) that will be added along with "react-datetime-picker" to the main React-DateTime-Picker <div> element. |
|
| clearIcon | Defines the content of the clear button. Setting the value explicitly to null will hide the icon. |
|
| disabled | Defines whether the date picker should be disabled. Defaults to false. | true |
| disableClock | Defines whether the clock should be disabled. Defaults to false. | true |
| isCalendarOpen | Defines whether the calendar should be opened. Defaults to false. | true |
| isClockOpen | Defines whether the clock should be opened. Defaults to false. | true |
| locale | Defines which locale should be used by the datetime picker and the calendar. Can be any IETF language tag. Defaults to user's browser settings. | "hu-HU" |
| maxDate | Defines maximum date that the user can select. Periods partially overlapped by maxDate will also be selectable, although React-DateTime-Picker will ensure that no later date is selected. | Date: new Date() |
| maxDetail | Defines 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". Defaults to "month". | "month" |
| minDate | Defines minimum date that the user can select. Periods partially overlapped by minDate will also be selectable, although React-DateTime-Picker will ensure that no earlier date is selected. | Date: new Date() |
| minDetail | Defines the least detailed calendar view that the user shall see. Can be "month", "year", "decade" or "century". Defaults to "century". | "century" |
| name | Defines input name. Defaults to "datetime". | "myCustomName" |
| onChange | Function called when the user clicks an item on the most detailed view available. | (value) => alert('New date is: ', value) |
| returnValue | Defines 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. Defaults to "start". | "range" |
| required | Defines whether date input should be required. Defaults to false. | true |
| showLeadingZeros | Defines whether leading zeros should be rendered in date inputs. Defaults to false. | true |
| value | Defines the value of the input. |
|
DateTimePicker 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.
DateTimePicker component passes all props to React-Clock, with the exception of className (you can use clockClassName for that instead). There are tons of customizations you can do! For more information, see Clock component props.
The MIT License.
|
Wojciech Maj [email protected] http://wojtekmaj.pl |