# react-deadline

> countdown timer that works with react and react native

Latest version **1.0.1** (published 2016-03-09) · ISC license · 0 weekly downloads

## Install

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

## 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 | 1.0.1 |
| Published | 2016-03-09 |
| First published | 2016-03-09 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Zack Perdue |
| Maintainers | zackperdue |
| Keywords | react, native, component, countdown, timer, moment |

## Links

- npm: https://www.npmjs.com/package/react-deadline
- Repository: https://github.com/zackperdue/React-Deadline
- Homepage: https://github.com/zackperdue/React-Deadline#readme
- Issues: https://github.com/zackperdue/React-Deadline/issues
- npm.io page: https://npm.io/package/react-deadline

## Dependencies (3)

- [moment](https://npm.io/package/moment.md) ^2.12.x
- [react-native](https://npm.io/package/react-native.md) ^0.21.x
- [react-timer-mixin](https://npm.io/package/react-timer-mixin.md) ^0.13.x

## 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

- 1.0.1 (latest) — 2016-03-09
- 1.0.0 — 2016-03-09

## README

# React Deadline

Countdown Timer for React and React Native

## Install
`npm install react-deadline --save`

```
import CountdownTimer from 'react-deadline';

...

render() {
  return (
    <CountdownTimer
      endsAt={this.props.date}
      onUpdate={timer => this.setState({timer: timer})>
      {`${this.state.timer.hours}:${this.state.timer.minutes}:${this.state.timer.seconds}`}
    </CountdownTimer>
  )
}
```

## Properties

- `endsAt` __string__ - any string that [moment js](http://momentjs.com/) can parse
- `onUpdate` __function__ - called every 1000ms (1 second). Use this to set your state to the timer values.

## Dependencies
- [react timer mixin](https://github.com/reactjs/react-timer-mixin)
- [moment.js](http://momentjs.com)

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