# ⏳ react-timecode

![npm](https://img.shields.io/npm/v/react-timecode?style=flat-square)
![NPM](https://img.shields.io/npm/l/react-timecode?style=flat-square)
![npm](https://img.shields.io/npm/dt/react-timecode?style=flat-square)
![Coveralls github](https://img.shields.io/coveralls/github/ryanhefner/react-timecode?style=flat-square)
![CircleCI](https://img.shields.io/circleci/build/github/ryanhefner/react-timecode?style=flat-square)
![Known Vulnerabilities](https://snyk.io/test/github/ryanhefner/react-timecode/badge.svg)
![Twitter Follow](https://img.shields.io/twitter/follow/ryanhefner)


Simple React component for displaying a timecode, with various formatting options.

## Install

Via [npm](https://npmjs.com/package/react-timecode)

```sh
npm install --save react-timecode
```

Via [Yarn](https://yarn.fyi/react-timecode)

```sh
yarn add react-timecode
```

## How to use

The `Timecode` component is setup to be configurable as it needs to be, and hopefully
nothing more. Below are the `props` you can set on the component, along with a
simple example.

### Properties

* `as:String|Function` - Element to render the timecode within. (Default: `span`)
* `[DEPRECATED]` `component:String|Function` - Element to render the timecode within. (Default: `span`)
* `format:String` - Specifies the format to display the timecode. (Default: `H:?m:ss`)
  * `HH:mm:ss.SSS` - (Example: 00:01:23.876)
  * `H:mm:ss.SSS` - (Example: 0:01:23.876)
  * `H:?mm:ss.SSS` - (Example: 01:23.876)
  * `H:?m:ss.SSS` - (Example: 1:23.876)
  * `HH:mm:ss` - (Example: 00:01:23)
  * `H:mm:ss` - (Example: 0:01:23)
  * `H:?mm:ss` - (Example: 01:23)
  * `H:mm` - (Example: 0:01)
  * `s.SSS` - (Example: 0.000)
  * `s.SS` - (Example: 0.00)
  * `mm:ss` - (Example: 90:00)
  * `H:?mm:ss` - (Example: 00:00)
  * `H:?m:ss` - (Example: 1:23 - _Default_)
* `postfix:String` - Append a string after the formatted timecode.
* `prefix:String` - Include a string before the formatted timecode.
* `time:Number` - Time in milliseconds to display the timecode for. (Default: `0`)

### Example

```js
import Timecode from 'react-timecode';

...

  render() {
    const {
      time,
    } = this.state;

    return (
      <Timecode time={time} />
    );
  }

...

```

### Utilities

In addition to the `Timecode` component, the underlying utility methods that the
component uses for rendering the timecodes have also been exposed, in case you
have some need to render some strings without the context of the component.

* `parseTime(time:Number): { hours: Number, minutes: Number, seconds: Number, milliseconds: Number }`
* `pad(number: Number, length: Number = 2): String`
* `formatMilliseconds(milliseconds: Number, length: Number = 3): String`
* `formatTimecode({ format: String, time: Number }): String`

## Pairs well with...

* [react-timer-wrapper](https://github.com/ryanhefner/react-timer-wrapper)

## License

[MIT](LICENSE) © [Ryan Hefner](https://www.ryanhefner.com)