# react-timepicker

> React timepicker in Android KitKat style

Latest version **2.0.2** (published 2017-10-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-timepicker
pnpm add react-timepicker
yarn add react-timepicker
bun add react-timepicker
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.2 |
| Published | 2017-10-19 |
| First published | 2015-10-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Radosław Miernik |
| Maintainers | radekmie |
| Keywords | android, svg, react, reactjs, react-component, time, timepicker, time picker, time-picker |

## Links

- npm: https://www.npmjs.com/package/react-timepicker
- Repository: https://github.com/radekmie/react-timepicker
- Homepage: https://github.com/radekmie/react-timepicker#readme
- Issues: https://github.com/radekmie/react-timepicker/issues
- npm.io page: https://npm.io/package/react-timepicker

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.0.2 (latest) — 2017-10-19
- 2.0.1 — 2017-10-19
- 2.0.0 — 2017-10-08
- 2.0.0-alpha.1 — 2017-10-03
- 2.0.0-alpha.0 — 2017-10-02
- 1.3.1 — 2017-05-12
- 1.3.0 — 2017-01-13
- 1.2.0 — 2017-01-07
- 1.1.6 — 2016-12-13
- 1.1.5 — 2016-10-06
- 1.1.4 — 2016-10-06
- 1.1.3 — 2016-01-29
- 1.1.2 — 2015-12-01
- 1.1.1 — 2015-11-07
- 1.1.0 — 2015-11-07
- … 3 more at https://npm.io/package/react-timepicker/versions

## README

[![npm](https://nodei.co/npm/react-timepicker.png?downloads=true)](https://www.npmjs.com/package/react-timepicker)

# react-timepicker
`Timepicker` is a [React](https://facebook.github.io/react/) timepicker component that looks like Android KitKat one.

### Example
[![Timepicker](https://raw.githubusercontent.com/radekmie/react-timepicker/master/timepicker.png)](https://jsfiddle.net/radekm/o7syg3q9/embedded/result/)

### Install
From [npm](https://www.npmjs.com/package/react-timepicker)

```sh
npm install react-timepicker --save
```

### Quick Start
```javascript
'use strict';

import React      from 'react';
import ReactDOM   from 'react-dom';
import Timepicker from 'react-timepicker';

// Remember to include timepicker.css

class TimepickerExample extends React.Component {
    onChange (hours, minutes) {
        // ...
    },

    render () {
        return (
            <Timepicker onChange={this.onChange} />
        );
    }
}

ReactDOM.render(<TimepickerExample />, document.getElementById('timepicker-example'));
```

### Prop Values
#### mode
`React.PropTypes.bool`

Initial mode - `Timepicker.HOURS` or `Timepicker.MINUTES` **(default: `Timepicker.HOURS`)**.

#### size
`React.PropTypes.number`

Clock size in pixels **(default: 300)**.

#### radius
`React.PropTypes.number`

Clock radius in pixels **(default: 125)**.

#### hours
`React.PropTypes.number`

Initial hours **(default: 0)**.

#### minutes
`React.PropTypes.number`

Initial minutes **(default: 0)**.

#### formatNumber
`React.PropTypes.func.isRequired`

Function `(number, 'info' | 'clock') => string` formatting numbers **(default: left pad with 0)**

#### militaryTime
`React.PropTypes.bool`

Military (24-hour) time switch **(default: `true`)**.

#### onChange
`React.PropTypes.func`

Callback function when a hour or a minute is changed. Passes 2 parameters: new hours and minutes.

#### onChangeMode
`React.PropTypes.func`

Callback function when mode is changed. Passes 1 parameter: new mode.

---
_Source: https://npm.io/package/react-timepicker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._