Gathering detailed insights and metrics for react-time-picker
Gathering detailed insights and metrics for react-time-picker
Installations
npm install react-time-pickerReleases
69
Contributors
8
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4){kind=avatar}
Developer
Developer Guide
BETA
Module System
ESM
Min. Node Version
Typescript Support
Yes
Node Version
20.12.2
NPM Version
10.5.0
Statistics
339 Stars
881 Commits
63 Forks
5 Watching
7 Branches
8 Contributors
Updated on 24 Nov 2024
Bundle Size
35.70 kB
Minified
10.99 kB
Minified + Gzipped
Languages
TypeScript (96.86%)
CSS (2.92%)
HTML (0.22%)
Total Downloads
Cumulative downloads
Total Downloads
15,613,114
Last day
-3.2%
25,127
Compared to previous day
Last week
0.9%
129,495
Compared to previous week
Last month
9.7%
599,623
Compared to previous month
Last year
48.9%
5,826,747
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
7
Peer Dependencies
3
Versions
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-pickeroryarn add react-time-picker. - Import by adding
import TimePicker from 'react-time-picker'. - Use by adding
<TimePicker />. UseonChangeprop for getting new values.
Demo
A minimal demo page can be found in sample directory.
Online demo 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.
1<input aria-label="Time" type="time" />
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.8 | latest |
| ā„16.3 | 4.x |
| ā„16.0 | 3.x |
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:
1import { useState } from 'react'; 2import TimePicker from 'react-time-picker'; 3 4function MyApp() { 5 const [value, onChange] = useState('10:00'); 6 7 return ( 8 <div> 9 <TimePicker onChange={onChange} value={value} /> 10 </div> 11 ); 12}
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:
1import 'react-time-picker/dist/TimePicker.css'; 2import '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 |
|
| 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-Time-Picker <div> element. | n/a | "time-picker" |
| disableClock | When set to true, will remove the clock and the button toggling its visibility. | false | true |
| disabled | Whether the time 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-Time-Picker <div> element. | n/a | "time-picker" |
| 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. 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. | "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 |
|
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 |
No vulnerabilities found.
Reason
25 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 10
Reason
no binaries found in the repo
Reason
no dangerous workflow patterns detected
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
packaging workflow detected
Details
- Info: Project packages its releases by way of GitHub Actions.: .github/workflows/publish.yml:14
Reason
0 existing vulnerabilities detected
Reason
Found 0/28 approved changesets -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/ci.yml:1
- Warn: no topLevel permission defined: .github/workflows/close-stale-issues.yml:1
- Info: no jobLevel write permissions found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:82: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:85: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:95: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/ci.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:36: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:68: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/ci.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/ci.yml:71: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/ci.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/close-stale-issues.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/close-stale-issues.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/publish.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/publish.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/wojtekmaj/react-time-picker/publish.yml/main?enable=pin
- Info: 0 out of 12 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 2 third-party GitHubAction dependencies pinned
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 2 are checked with a SAST tool
Score
5.2
/10
Last Scanned on 2024-11-18
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More