# react-headless-countdown

> Simple react date countdown without UI

Latest version **1.3.0** (published 2020-02-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-headless-countdown
pnpm add react-headless-countdown
yarn add react-headless-countdown
bun add react-headless-countdown
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2020-02-01 |
| First published | 2020-02-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | >=8 |
| Dependencies | 1 |
| Unpacked size | 2.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Param-Harrison |
| Maintainers | learnwithparam |

## Links

- npm: https://www.npmjs.com/package/react-headless-countdown
- Repository: https://github.com/learnwithparam/react-date-countdown
- Homepage: https://github.com/learnwithparam/react-date-countdown#readme
- Issues: https://github.com/learnwithparam/react-date-countdown/issues
- npm.io page: https://npm.io/package/react-headless-countdown

## Dependencies (1)

- [date-fns](https://npm.io/package/date-fns.md) ^2.9.0

## Recent versions

- 1.3.0 (latest) — 2020-02-01
- 1.2.2 — 2020-02-01
- 1.2.1 — 2020-02-01
- 1.2.0 — 2020-02-01
- 1.1.4 — 2020-02-01
- 1.1.1 — 2020-02-01
- 1.1.0 — 2020-02-01
- 1.0.0 — 2020-02-01

## README

# react-headless-countdown

> React date countdown using render props. Support for hooks is on its way :)

[![NPM](https://img.shields.io/npm/v/react-headless-countdown.svg)](https://www.npmjs.com/package/react-headless-countdown) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

## Install

```bash
npm install --save react-headless-countdown
```

## Usage

```jsx
import React, { Component } from "react";

import DateCountdown from "react-headless-countdown";

class Example extends Component {
  render() {
    const date = new Date("2021-01-01"); // New year 2021!

    return (
      <DateCountdown date={date}>
        {({ timeLeft, isValidDate, isValidFutureDate }) => (
          <div>Render the countdown here!</div>
        )}
      </DateCountdown>
    );
  }
}
```

Example in action [here](https://learnwithparam.github.io/react-date-countdown/).
You can checkout the examples folder for how to use it.

## License

MIT © [Param-Harrison](https://github.com/Param-Harrison)

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