• Stars
    star
    322
  • Rank 130,398 (Top 3 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created almost 7 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A time picker for your React app.

npm downloads CI

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 <TimePicker />. Use onChange prop for getting new values.

Demo

A minimal demo page can be found 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

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 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, { useState } from 'react';
import TimePicker from 'react-time-picker';

function MyApp() {
  const [value, onChange] = useState('10:00');

  return (
    <div>
      <TimePicker onChange={onChange} value={value} />
    </div>
  );
}

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:

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 <div> element. n/a
  • String: "class1 class2"
  • Array of strings: ["class1", "class2 class3"]
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)
  • String: "Clear"
  • React element: <ClearIcon />
  • React function: ClearIcon
clockAriaLabel aria-label for the clock button. n/a "Toggle clock"
clockClassName Class name(s) that will be added along with "react-clock" to the main React-Clock <time> element. n/a
  • String: "class1 class2"
  • Array of strings: ["class1", "class2 class3"]
clockIcon Content of the clock button. Setting the value explicitly to null will hide the icon. (default icon)
  • String: "Clock"
  • React element: <ClockIcon />
  • React function: ClockIcon
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-Time-Picker <div> element. n/a "date-picker"
disabled Whether the time picker should be disabled. false true
disableClock When set to true, will remove the clock and the button toggling its visibility. false true
format Input format based on Unicode Technical Standard #35. Supported values are: H, HH, h, hh, m, mm, s, ss, a. n/a "h:m:s a"
hourAriaLabel aria-label for the hour input. n/a "Hour"
hourPlaceholder placeholder for the hour input. "--" "hh"
isOpen Whether the clock should be opened. false true
locale Locale that should be used by the time picker and the clock. Can be any IETF language tag. 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
  • Date: new Date()
  • String: "22:15:00"
minTime Minimum date that the user can select. n/a
  • 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 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 date 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.

License

The MIT License.

Author

Wojciech Maj
[email protected]
https://wojtekmaj.pl

More Repositories

1

react-pdf

Display PDFs in your React app as easily as if they were images.
TypeScript
9,148
star
2

react-lifecycle-methods-diagram

Interactive React Lifecycle Methods diagram.
TypeScript
3,870
star
3

react-calendar

Ultimate calendar for your React app.
TypeScript
3,515
star
4

react-date-picker

A date picker for your React app.
TypeScript
1,255
star
5

react-datetime-picker

A datetime picker for your React app.
TypeScript
543
star
6

react-daterange-picker

A date range picker for your React app.
TypeScript
519
star
7

react-clock

An analog clock for your React app.
TypeScript
335
star
8

enzyme-adapter-react-17

Unofficial adapter for React 17 for Enzyme.
JavaScript
297
star
9

react-datetimerange-picker

A datetime range picker for your React app.
TypeScript
169
star
10

react-timerange-picker

A time range picker for your React app.
TypeScript
87
star
11

react-hooks

A collection of React Hooks.
TypeScript
69
star
12

get-user-locale

A function that returns user's locale as an IETF language tag, based on all available sources.
TypeScript
58
star
13

country-code-to-flag-emoji

A function that returns a flag emoji given IETF language tag.
TypeScript
55
star
14

make-cancellable-promise

Make any Promise cancellable.
TypeScript
28
star
15

merge-refs

A function that merges React refs into one.
TypeScript
25
star
16

react-fit

Fit a popover element on the screen.
TypeScript
22
star
17

detect-element-overflow

A function that tells you whether a given element is overflowing its container or not. Useful for creating dropdowns and tooltips.
TypeScript
21
star
18

date-utils

A collection of date-related utilities.
TypeScript
20
star
19

yarn-plugin-nolyfill

Yarn Berry plugin that replaces unnecessary polyfills with native implementations.
TypeScript
18
star
20

opening-hours-utils

A collection of opening hours-related utilities.
TypeScript
13
star
21

merge-class-names

A function that merges given class names, no matter their format: string with single or multiple class names or an array of class names. Filters out invalid class names as well.
JavaScript
12
star
22

react-t

Simple translation module for React applications.
TypeScript
12
star
23

recreate-from-source-maps

Recreate a Webpack project just by providing an URL.
JavaScript
11
star
24

color-utils

A collection of color-related utilities.
TypeScript
11
star
25

async-array-utils

A collection of array-related async utilities.
TypeScript
11
star
26

react-async-button

A button that handles Promises for your React app.
TypeScript
10
star
27

vite-plugin-simple-html

Vite plugin for HTML processing and minification
TypeScript
10
star
28

i18n-compare

Generates a summary of differences between two i18n files
TypeScript
9
star
29

package-manager-stats

Script to get stats about package managers used in most popular projects on GitHub.
TypeScript
8
star
30

make-event-props

Returns an object with on-event callback props curried with provided args.
TypeScript
8
star
31

predict-input-value

Predicts the input value during KeyDown or KeyPress events, before the input is actually changed
TypeScript
8
star
32

timezone-coworking-tool

A tool to help with coworking with people in different timezones.
TypeScript
7
star
33

eslint-config-wojtekmaj

ESLint configuration by wojtekmaj
TypeScript
5
star
34

next-turbopack-nodenext

Adds module: NodeNext support to Turbopack in Next.js.
TypeScript
4
star
35

is-valid-nip

Check if a number is a valid Numer Identyfikacji Podatkowej (NIP).
TypeScript
3
star
36

update-input-width

A function that given input element, updates its width to fit its content.
TypeScript
3
star
37

uwp-web-framework

Universal Windows Platform web framework
CSS
3
star
38

is-valid-abn

Check if a number is a valid Australian Business Number (ABN).
TypeScript
3
star
39

is-valid-regon

Check if a number is a valid REGON.
TypeScript
2
star
40

eslint-staged-files

Run ESLint on staged files only.
JavaScript
2
star
41

nightmare-advanced-click

Extends Nightmare with .rightClick(), .middleClick(), .ctrlClick() and other actions.
JavaScript
2
star
42

is-valid-pesel

Check if a number is a valid PESEL.
TypeScript
2
star
43

is-valid-australian-postcode

Check if a number is a valid Australian postcode.
TypeScript
1
star
44

is-valid-acn

Check if a number is a valid Australian Company Number (ACN).
TypeScript
1
star
45

webpack-summary-compare

Generates a summary of differences between two Webpack summaries
JavaScript
1
star
46

is-valid-utr

Check if a number is a valid Unique Taxpayer Reference (UTR).
TypeScript
1
star