react-time-picker

React-Time-Picker

An input component for picking time for your React application.

tl;dr

• Install by executing npm install react-time-picker or yarn add react-time-picker.
• Import by adding import TimePicker from 'react-time-picker'.
• Use by adding <TimePicker />. Use onChange prop for getting new values.

Demo

Minimal demo page is included in sample directory.

Online demo is also available!

Looking for a date picker or a datetime picker?

React-Time-Picker will play nicely with React-Date-Picker and React-DateTime-Picker. Check them out!

Getting started

Compatibility

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.

Browser	Minimum supported version
Google Chrome	24
Mozilla Firefox	29
Microsoft Edge	12
Apple Safari	10
Apple Safari (iOS)	10.2
Opera	15
Internet Explorer	11
Samsung Internet	4

Legacy 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-Date-Picker.

Installation

Add React-Time-Picker to your project by executing npm install react-time-picker or yarn add react-time-picker.

Usage

Here's an example of basic usage:

import React, { Component } from 'react';
import TimePicker from 'react-time-picker';

class MyApp extends Component {
  state = {
    time: '10:00',
  }

  onChange = time => this.setState({ time })

  render() {
    return (
      <div>
        <TimePicker
          onChange={this.onChange}
          value={this.state.time}
        />
      </div>
    );
  }
}

Custom styling

If you don't want to use default React-Time-Picker styling to build upon it, you can import React-Time-Picker by using import TimePicker from 'react-time-picker/dist/entry.nostyle'; instead.

User guide

TimePicker

Displays an input field complete with custom inputs, native input and a clock.

Props

Prop name	Description	Example values
clockClassName	Defines class name(s) that will be added along with "react-clock" to the main React-Clock <time> element.	String: "class1 class2" Array of strings: ["class1", "class2 class3"]
clockIcon	Defines the content of the clock button.	String: "Clock" React element: <ClockIcon />
className	Defines class name(s) that will be added along with "react-time-picker" to the main React-Time-Picker <div> element.	String: "class1 class2" Array of strings: ["class1", "class2 class3"]
clearIcon	Defines the content of the clear button.	String: "Clear" React element: <ClearIcon />
isOpen	Defines whether the calendar should be opened. Defaults to false.	true
locale	Defines which locale should be used by the calendar. Can be any IETF language tag. Defaults to user's browser settings.	"hu-HU"
maxDetail	Defines how detailed time picking shall be. Can be "hour", "minute" or "second". Defaults to "minute".	"second"
maxTime	Defines maximum time that the user can select.	Date: new Date() String: "22:15:00"
minTime	Defines minimum date that the user can select.	Date: new Date() String: "22:15:00"
onChange	Function called when the user picks a valid time.	(value) => alert('New time is: ', value)
required	Defines whether date input should be required. Defaults to false.	true
value	Defines the value of the input.	Date: new Date() String: "22:15:00"

License

The MIT License.

Author

Wojciech Maj [e-mail] http://wojtekmaj.pl