A time range picker for your React app.
- Supports virtually any language
- No moment.js needed
- Install by executing
npm install @wojtekmaj/react-timerange-picker
oryarn add @wojtekmaj/react-timerange-picker
. - Import by adding
import TimeRangePicker from '@wojtekmaj/react-timerange-picker'
. - Use by adding
<TimeRangePicker />
. UseonChange
prop for getting new values.
A minimal demo page can be found in sample
directory.
Online demo is also available!
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.
<input aria-label="Time from" max={valueTo} min={minTime} type="date" />
<input aria-label="Time to" max={maxTime} min={valueFrom} type="date" />
React-TimeRange-Picker will play nicely with React-DateRange-Picker and React-DateTimeRange-Picker. Check them out!
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-TimeRange-Picker version.
React version | Newest compatible React-TimeRange-Picker version |
---|---|
≥16.3 | latest |
≥16.0 | 2.x |
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.
Add React-TimeRange-Picker to your project by executing npm install @wojtekmaj/react-timerange-picker
or yarn add @wojtekmaj/react-timerange-picker
.
Here's an example of basic usage:
import { useState } from 'react';
import TimeRangePicker from '@wojtekmaj/react-timerange-picker';
type ValuePiece = Date | string | null;
type Value = ValuePiece | [ValuePiece, ValuePiece];
function MyApp() {
const [value, onChange] = useState<Value>(['10:00', '11:00']);
return (
<div>
<TimeRangePicker onChange={onChange} value={value} />
</div>
);
}
If you want to use default React-Date-Picker and React-Calendar styling to build upon it, you can import them by using:
import '@wojtekmaj/react-timerange-picker/dist/TimeRangePicker.css';
import 'react-clock/dist/Clock.css';
Displays an input field complete with custom inputs, native input and a clock.
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-timerange-picker" to the main React-TimeRange-Picker <div> element. |
n/a |
|
clearAriaLabel |
aria-label for the clear button. |
n/a | "Clear value" |
clearIcon | Content of the clear button. Setting the value explicitly to null will hide the icon. |
(default icon) |
|
clockAriaLabel |
aria-label for the clock button. |
n/a | "Toggle clock" |
clockProps | Props to pass to React-Clock component. | n/a | See React-Clock documentation |
clockIcon | Content of the clock button. Setting the value explicitly to null will hide the icon. |
(default icon) |
|
closeClock | Whether to close the clock on value selection. Note: It's recommended to use shouldCloseClock function instead. |
true |
false |
data-testid |
data-testid attribute for the main React-TimeRange-Picker <div> element. |
n/a | "timerange-picker" |
disableClock | When set to true , will remove the clock and the button toggling its visibility. |
false |
true |
disabled | Whether the time range picker should be disabled. | false |
true |
format | Input format based on Unicode Technical Standard #35. Supported values are: H , HH , h , hh , m , mm , s , ss , a . Note: When using SSR, setting this prop may help resolving hydration errors caused by locale mismatch between server and client. |
n/a | "h:m:s a" |
hourAriaLabel |
aria-label for the hour input. |
n/a | "Hour" |
hourPlaceholder |
placeholder for the hour input. |
"--" |
"hh" |
id |
id attribute for the main React-TimeRange-Picker <div> element. |
n/a | "timerange-picker" |
isOpen | Whether the clock should be opened. | false |
true |
locale | Locale that should be used by the time range picker and the clock. Can be any IETF language tag. Note: When using SSR, setting this prop may help resolving hydration errors caused by locale mismatch between server and client. | Server locale/User's browser settings | "hu-HU" |
maxDetail | How detailed time picking shall be. Can be "hour" , "minute" or "second" . |
"minute" |
"second" |
maxTime | Maximum time that the user can select. | n/a |
|
minTime | Minimum date that the user can select. | n/a |
|
minuteAriaLabel |
aria-label for the minute input. |
n/a | "Minute" |
minutePlaceholder |
placeholder for the minute input. |
"--" |
"mm" |
name | Input name prefix. Time from/Time to fields will be named "yourprefix_from" and "yourprefix_to" respectively. |
"timerange" |
"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') |
rangeDivider | Divider between time inputs. | "–" |
" to " |
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. | n/a |
|
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.
The MIT License.
Wojciech Maj |