https://github.com/tighten/react-native-time-input
A simple time input component with autoformatting.
https://github.com/tighten/react-native-time-input
expo react react-native react-native-component typescript
Last synced: about 1 year ago
JSON representation
A simple time input component with autoformatting.
- Host: GitHub
- URL: https://github.com/tighten/react-native-time-input
- Owner: tighten
- License: mit
- Created: 2021-02-22T16:33:59.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2022-03-18T13:56:08.000Z (over 4 years ago)
- Last Synced: 2025-04-02T23:35:31.690Z (over 1 year ago)
- Topics: expo, react, react-native, react-native-component, typescript
- Language: TypeScript
- Homepage:
- Size: 1.28 MB
- Stars: 6
- Watchers: 11
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# React Native Time Input 🕓
[](https://github.com/tighten/react-native-time-input/actions?query=workflow%3A%22Build+and+Test%22)
This package works on both **Android** and **iOS**
## Preview
## Try it out
You can run the example module by performing these steps:
```
$ git clone git@github.com:tighten/react-native-time-input.git
$ yarn
$ yarn example start
```
## Installation
You can install this package by running one of the following commands:
**NPM**
`npm i @tighten/react-native-time-input`
**Yarn**
`yarn add @tighten/react-native-time-input`
### Usage
```js
import React, { useState } from 'react';
import { Text, View } from 'react-native';
import TimeInput from '@tighten/react-native-time-input';
const MyApp = () => {
const [time, setTime] = useState('');
const handleTimeChange = (time, validTime) => {
if (!validTime) return;
setTime(time);
}
return (
Current time entered is: {time}
);
}
export default MyApp;
```
## Props
| Prop | Default | Type | Description |
| ------------ | ----------- | ----------- | ----------- |
| `theme` | | `TimeInputTheme` | See the [customization](#customization) section below for configuration instructions |
| `styles` | | `TimeInputStyle` | See the [customization](#customization) section below for configuration instructions |
| `errorText` | "Please enter a valid time." | string | The message that is displayed when the user enters an invalid time. |
| `initialTime` | `null` | Date | Optionally set the initial time for the input on first render. |
| `setCurrentTime` | `false` | boolean | Decide if the input should load with the user's current time set as it's value. This prop is ignored when an `initialTime` is passed in. |
| `onTimeChange` | `(localeTime, isValid) => {}` | function | A callback function that runs when the value of the time input or meridiem is changed. Receives a locale time string (`hh:mm a`) and a boolean value specifying if the time is valid. |
## Customization
The look and feel of this component is completely customizable.
### Theme
You can implement minimal changes to the look and feel by adjusting the default theme's color values for elements inside the component. Hex color codes and named color text strings (e.g., blue) are valid values.
Here's what's available:
| Prop | Default |
| ----------- | ----------- |
| `errorTextColor`| `#c0392b` |
| `inputBackgroundColor` | `#ffffff` |
| `inputBorderColor` | `#a6a6a6` |
| `inputTextColor` | `#2e2e2e` |
| `toggleBackgroundColor` | `#e6e6e6` |
| `toggleButtonActiveBackgroundColor` | `#a6a6a6` |
| `toggleButtonActiveTextColor` | `#ffffff` |
| `toggleButtonBackgroundColor` | `#e6e6e6` |
| `toggleButtonTextColor` | `#2e2e2e` |
**Example**
```js
import React from 'react';
import TimeInput from '@tighten/react-native-time-input';
export const MyApp = () => {
return (
)
};
```
### Styles
> Note: Theme overrides take precedent over all other styles.
If you want to make adjustments to the component's layout, you can pass in a style object to override the default styles.
| Prop | Description |
| ----------- | ----------- |
| `componentContainer`| A wrapper `View` element that surrounds all elements in the component |
| `container` | A wrapper `View` element that surrounds the text input and meridiem toggle |
| `input` | The `TextInput` field |
| `toggle` | A wrapper `View` element that surrounds the meridiem toggle and buttons |
| `toggleButton` | The `TouchableOpacity` (iOS) or `TouchableNativeFeedback` (Android) element for AM and PM |
| `toggleButtonActive` | An `Animated.View` element |
| `errorText` | The `Text` field displayed below the input when there are errors |
**Example**
```js
import React from 'react';
import TimeInput from '@tighten/react-native-time-input';
export const MyApp = () => {
return (
)
};
```
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## License
MIT