time-picker

A time range picker for your React app

Dec 24, 2018
A time range picker for your React app

React-TimeRange-Picker

A time range picker for your React app.

View Demo Download Source

  • Supports virtually any language
  • No moment.js needed

tl;dr

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

Looking for a date range picker or a datetime range picker?

React-TimeRange-Picker will play nicely with React-DateRange-Picker and React-DateTimeRange-Picker. Check them out!

Getting started

Compatibility

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-TimeRange-Picker version.

React versionNewest supported React-TimeRange-Picker
>16.0latest
>15.02.1.1

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-TimeRange-Picker to your project by executing npm install @wojtekmaj/react-timerange-picker or yarn add @wojtekmaj/react-timerange-picker.

Usage

Here's an example of basic usage:

import React, { Component } from 'react'; import TimeRangePicker from 'react-timerange-picker'; class MyApp extends Component { state = { time: ['10:00', '11:00'], } onChange = time => this.setState({ time }) render() { return ( <div> <TimeRangePicker onChange={this.onChange} value={this.state.time} /> </div> ); } }

Custom styling

If you don't want to use default React-TimeRange-Picker styling to build upon it, you can import React-TimeRange-Picker by using import TimeRangePicker from '@wojtekmaj/react-timerange-picker/dist/entry.nostyle'; instead.

User guide

TimeRangePicker

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

Props

Prop nameDescriptionExample values
clockClassNameDefines 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"]
clockIconDefines the content of the clock button. Setting the value explicitly to null will hide the icon.* String: "Clock"
* React element: <ClockIcon />
classNameDefines class name(s) that will be added along with "react-timerange-picker" to the main React-TimeRange-Picker <div> element.* String: "class1 class2"
* Array of strings: ["class1", "class2 class3"]
clearIconDefines the content of the clear button. Setting the value explicitly to null will hide the icon.* String: "Clear"
* React element: <ClearIcon />
disabledDefines whether the time range picker should be disabled. Defaults to false.true
disableClockDefines whether the clock should be disabled. Defaults to false.true
isOpenDefines whether the clock should be opened. Defaults to false.true
localeDefines which locale should be used by the time range picker and the clock. Can be any IETF language tag. Defaults to user's browser settings."hu-HU"
maxDetailDefines how detailed time picking shall be. Can be "hour", "minute" or "second". Defaults to "minute"."second"
maxTimeDefines maximum time that the user can select.* Date: new Date()
* String: "22:15:00"
minTimeDefines minimum date that the user can select.* Date: new Date()
* String: "22:15:00"
nameDefines input name prefix. Date from/Date to fields will be named "yourprefix_from" and "yourprefix_to" respectively. Defaults to "timerange"."myCustomName"
onChangeFunction called when the user picks a valid time.(value) => alert('New time is: ', value)
requiredDefines whether date input should be required. Defaults to false.true
valueDefines the value of the input.* Date: new Date()
* String: "22:15:00"

Clock

TimeRangePicker 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.

GitHub

Recommended