[![npm](https://img.shields.io/npm/v/react-time-picker.svg)](https://www.npmjs.com/package/react-time-picker) ![downloads](https://img.shields.io/npm/dt/react-time-picker.svg) [![CI](https://github.com/wojtekmaj/react-time-picker/actions/workflows/ci.yml/badge.svg)](https://github.com/wojtekmaj/react-time-picker/actions) # React-Time-Picker A time picker for your React app. - Supports virtually any language - No moment.js needed ## 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 ``. Use `onChange` prop for getting new values. ## Demo A minimal demo page can be found in `sample` directory. [Online demo](https://projects.wojtekmaj.pl/react-time-picker/) is also available! ## Consider native alternative If you don't need to support legacy browsers and don't need the advanced features this package provides, consider using native time input instead. It's more accessible, adds no extra weight to your bundle, and works better on mobile devices. ```tsx ``` ## Looking for a date picker or a datetime picker? React-Time-Picker will play nicely with [React-Date-Picker](https://github.com/wojtekmaj/react-date-picker) and [React-DateTime-Picker](https://github.com/wojtekmaj/react-datetime-picker). Check them out! ## Getting started ### Compatibility Your project needs to use React 16.3 or later. If you use an older version of React, please refer to the table below to find a suitable React-Time-Picker version. | React version | Newest compatible React-Time-Picker version | | ------------- | ------------------------------------------- | | ≥16.3 | latest | | ≥16.0 | 3.x | #### Legacy browsers If you need to support legacy browsers like Internet Explorer 10, you will need to use [Intl.js](https://github.com/andyearnshaw/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: ```tsx import { useState } from 'react'; import TimePicker from 'react-time-picker'; function MyApp() { const [value, onChange] = useState('10:00'); return (

); } ``` ### Custom styling If you want to use default React-Date-Picker and React-Clock styling to build upon it, you can import them by using: ```ts import 'react-time-picker/dist/TimePicker.css'; import 'react-clock/dist/Clock.css'; ``` ## User guide ### TimePicker Displays an input field complete with custom inputs, native input and a clock. #### Props | Prop name | Description | Default value | Example values | | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | amPmAriaLabel | `aria-label` for the AM/PM select input. | n/a | `"Select AM/PM"` | | autoFocus | Automatically focuses the input on mount. | n/a | `true` | | className | Class name(s) that will be added along with `"react-time-picker"` to the main React-Time-Picker `

` element. | n/a |

String: `"class1 class2"`
Array of strings: `["class1", "class2 class3"]`

String: `"Clear"`
React element: ``
React function: `ClearIcon`

String: `"Clock"`
React element: ``
React function: `ClockIcon`

Date: `new Date()`
String: `"22:15:00"`

Date: `new Date()`
String: `"22:15:00"`

| | minuteAriaLabel | `aria-label` for the minute input. | n/a | `"Minute"` | | minutePlaceholder | `placeholder` for the minute input. | `"--"` | `"mm"` | | name | Input name. | `"time"` | `"myCustomName"` | | nativeInputAriaLabel | `aria-label` for the native time input. | n/a | `"Time"` | | onChange | Function called when the user picks a valid time. | n/a | `(value) => alert('New time is: ', value)` | | onClockClose | Function called when the clock closes. | n/a | `() => alert('Clock closed')` | | onClockOpen | Function called when the clock opens. | n/a | `() => alert('Clock opened')` | | onFocus | Function called when the user focuses an input. | n/a | `(event) => alert('Focused input: ', event.target.name)` | | onInvalidChange | Function called when the user picks an invalid time. | n/a | `() => alert('Invalid time')` | | openClockOnFocus | Whether to open the clock on input focus. **Note**: It's recommended to use `shouldOpenClock` function instead. | `true` | `false` | | portalContainer | Element to render the clock in using portal. | n/a | `document.getElementById('my-div')` | | required | Whether time input should be required. | `false` | `true` | | secondAriaLabel | `aria-label` for the second input. | n/a | `"Second"` | | secondPlaceholder | `placeholder` for the second input. | `"--"` | `"ss"` | | shouldCloseClock | Function called before the clock closes. `reason` can be `"buttonClick"`, `"escape"`, `"outsideAction"`, or `"select"`. If it returns `false`, the clock will not close. | n/a | `({ reason }) => reason !== 'outsideAction'` | | shouldOpenClock | Function called before the clock opens. `reason` can be `"buttonClick"` or `"focus"`. If it returns `false`, the clock will not open. | n/a | `({ reason }) => reason !== 'focus'` | | value | Input value. Note that if you pass an array of values, only first value will be fully utilized. | n/a |

Date: `new Date(2017, 0, 1, 22, 15)`
String: `"22:15:00"`
An array of dates: `[new Date(2017, 0, 1, 22, 15), new Date(2017, 0, 1, 23, 45)]`
An array of strings: `["22:15:00", "23:45:00"]`

| ### Clock TimePicker 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](https://github.com/wojtekmaj/react-clock#props). ## License The MIT License. ## Author

Wojciech Maj

	Stars	Issues	Version	Updated	Created
react-bootstrap-datetimepicker			0.0.22	9 years ago	10 years ago
react-time-picker	312	6	7.0.0	17 days ago	9 years ago
react-time-range			1.0.4	6 years ago	6 years ago

react-bootstrap-datetimepicker vs react-time-picker vs react-time-range

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past