Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ndresx/react-countdown

A customizable countdown component for React.
https://github.com/ndresx/react-countdown

component countdown hacktoberfest react typescript

Last synced: 3 months ago
JSON representation

A customizable countdown component for React.

Lists

README 

        
# React <Countdown /> [![npm][npm]][npm-url] [![CI: Build Status](https://img.shields.io/github/workflow/status/ndresx/react-countdown/CI)](https://github.com/ndresx/react-countdown/actions/workflows/main.yml) [![Coverage Status](https://coveralls.io/repos/github/ndresx/react-countdown/badge.svg?branch=master)](https://coveralls.io/github/ndresx/react-countdown?branch=master)

A customizable countdown component for React.



* [Getting Started](#getting-started)

* [Motivation](#motivation)

* [Examples](#examples)

* [Props](#props)

* [API Reference](#api-reference)

* [Helpers](#helpers)

* [FAQ](#faq)

* [Contributing](#contributing)

* [License](#license)



## Getting Started



You can install the module via `npm` or `yarn`:



```sh

npm install react-countdown --save

```



```sh

yarn add react-countdown

```



## Motivation



As part of a small web app at first, the idea was to separate the countdown component from the main package to combine general aspects of the development with React, testing with Jest and more things that relate to publishing a new Open Source project.



## Examples



Here are some examples which you can try directly online. You can also clone this repo and explore some more examples in there by running `yarn start` within the `examples` folder.



### Basic Usage

A very simple and minimal example of how to set up a countdown that counts down from 10 seconds.

```js

import React from 'react';

import ReactDOM from 'react-dom';

import Countdown from 'react-countdown';



ReactDOM.render(

  ,

  document.getElementById('root')

);

```

[Live Demo](https://codesandbox.io/s/cool-fermat-uk0dq)



### Custom & Conditional Rendering

In case you want to change the output of the component or want to signal that the countdown's work is done, you can do this by either using the [`onComplete`](#oncomplete) callback, a

custom [`renderer`](#renderer), or by specifying a React child within ``, which will only be shown once the countdown is complete.



#### Using a React Child for the Completed State



```js

import React from 'react';

import ReactDOM from 'react-dom';

import Countdown from 'react-countdown';



// Random component

const Completionist = () => You are good to go!;



ReactDOM.render(

  (

    

      

    

  ),

  document.getElementById('root')

);

```

[Live Demo](https://codesandbox.io/s/condescending-bartik-kyp2v)



#### Custom Renderer with Completed Condition



```js

import React from 'react';

import ReactDOM from 'react-dom';

import Countdown from 'react-countdown';



// Random component

const Completionist = () => You are good to go!;



// Renderer callback with condition

const renderer = ({ hours, minutes, seconds, completed }) => {

  if (completed) {

    // Render a completed state

    return ;

  } else {

    // Render a countdown

    return {hours}:{minutes}:{seconds};

  }

};



ReactDOM.render(

  ,

  document.getElementById('root')

);

```

[Live Demo](https://codesandbox.io/s/sad-zhukovsky-hs7hc)



### Countdown in Milliseconds

Here is an example with a countdown of 10 seconds that displays the total time difference in milliseconds. In order to display the milliseconds appropriately, the [`intervalDelay`](#intervaldelay) value needs to be lower than `1000`ms and a [`precision`](#precision) of `1` to `3` should be used. Last but not least, a simple [`renderer`](#renderer) callback needs to be set up.



```js

import React from 'react';

import ReactDOM from 'react-dom';

import Countdown from 'react-countdown';



ReactDOM.render(

   
{props.total}
}

  />,

  document.getElementById('root')

);

```

[Live Demo](https://codesandbox.io/s/elastic-euclid-6vnlw)



## Props



|Name|Type|Default|Description|

|:--|:--:|:-----:|:----------|

|[**date**](#date)|Date|string|number|required|[`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) or timestamp in the future|

|[**key**](#key)|string|number|`undefined`|React [`key`](https://reactjs.org/docs/lists-and-keys.html#keys); can be used to restart the countdown|

|[**daysInHours**](#daysinhours)|`boolean`|`false`|Days are calculated as hours|

|[**zeroPadTime**](#zeropadtime)|`number`|`2`|Length of zero-padded output, e.g.: `00:01:02`|

|[**zeroPadDays**](#zeropaddays)|`number`|`zeroPadTime`|Length of zero-padded days output, e.g.: `01`|

|[**controlled**](#controlled) |`boolean`|`false`|Hands over the control to its parent(s)|

|[**intervalDelay**](#intervaldelay)|`number`|`1000`|Interval delay in milliseconds|

|[**precision**](#precision)|`number`|`0`|The precision on a millisecond basis|

|[**autoStart**](#autostart)|`boolean`|`true`|Countdown auto-start option|

|[**overtime**](#overtime) |`boolean`|`false`|Counts down to infinity|

|[**children**](#children)|`any`|`null`|A React child for the countdown's completed state|

|[**renderer**](#renderer)|`function`|`undefined`|Custom renderer callback|

|[**now**](#now)|`function`|`Date.now`|Alternative handler for the current date|

|[**onMount**](#onmount)|`function`|`undefined`|Callback when component mounts|

|[**onStart**](#onstart)|`function`|`undefined`|Callback when countdown starts|

|[**onPause**](#onpause)|`function`|`undefined`|Callback when countdown pauses|

|[**onStop**](#onstop)|`function`|`undefined`|Callback when countdown stops|

|[**onTick**](#ontick)|`function`|`undefined`|Callback on every interval tick (`controlled` = `false`)|

|[**onComplete**](#oncomplete)|`function`|`undefined`|Callback when countdown ends|



### `date`

The `date` prop is the only required one and can be a [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) object, `string`, or timestamp in the future. By default, this date is compared with the current date, or a custom handler defined via [`now`](#now).



Valid values can be _(and more)_:

* `'2020-02-01T01:02:03'` // [`Date` time string format](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse#Date_Time_String_Format)

* `1580518923000` // Timestamp in milliseconds

* `new Date(1580518923000)` // [`Date`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date) object



### `key`

This is one of React's internal component props to help identify elements throughout the reconciliation process. It can be used to restart the countdown by

passing in a new `string` or `number` value.



Please see [official React docs](https://reactjs.org/docs/lists-and-keys.html#keys) for more information about keys.



### `daysInHours`

Defines whether the time of day should be calculated as hours rather than separated days.



### `controlled`

Can be useful if the countdown's interval and/or date control should be handed over to the parent. In case `controlled` is `true`, the

provided [`date`](#date) will be treated as the countdown's actual time difference and not be compared to [`now`](#now) anymore.



### `zeroPadTime`

This option defaults to `2` in order to display the common format `00:00:00` instead of `0:0:0`. If the value is higher than `2`, only the hours part _(see [`zeroPadDays`](#zeropaddays) for days)_ will be zero-padded while it stays at `2` for minutes as well as seconds. If the value is lower, the output won't be zero-padded like the example before is showing.



### `zeroPadDays`

Defaults to `zeroPadTime`. It works the same way as [`zeroPadTime`](#zeropadtime) does, just for days.



### `intervalDelay`

Since this countdown is based on date comparisons, the default value of `1000` milliseconds is probably enough for most scenarios and doesn't need to be changed.



However, if it needs to be more precise, the `intervalDelay` can be set to something lower - down to `0`, which would, for example, allow showing the milliseconds in a more fancy way (_currently_ only possible through a custom [`renderer`](#renderer)).



### `precision`

In certain cases, you might want to base off the calculations on a millisecond basis. The `precision` prop, which defaults to `0`, can be used to refine this calculation. While the default value simply strips the milliseconds part (e.g., `10123`ms => `10000`ms), a precision of `3` leads to `10123`ms.



### `autoStart`

Defines whether the countdown should start automatically or not. Defaults to `true`.



### `overtime`

Defines whether the countdown can go into overtime by extending its lifetime past the targeted endpoint. Defaults to `false`.



When set to `true`, the countdown timer won't stop when hitting 0, but instead becomes negative and continues to run unless paused/stopped. The [`onComplete`](#oncomplete) callback would still get triggered when the initial countdown phase completes.



> Please note that the [`children`](#children) prop will be ignored if `overtime` is `true`. Also, when using a custom [`renderer`](#renderer), you'll have to check one of the [render props](#render-props), e.g., `total`, or `completed`, to render the overtime output.



### `children`

This component also considers the child that may live within the `` element, which, in case it's available, replaces the countdown's component state once it's complete. Moreover, an additional prop called `countdown` is set and contains data similar to what the [`renderer`](#renderer) callback would receive. Here's an [example](#using-a-react-child-for-the-completed-state) that showcases its usage.



> Please note that the [`children`](#children) prop will be ignored if a custom [`renderer`](#renderer) is defined.



### `renderer`

The component's raw render output is kept very simple.



For more advanced countdown displays, a custom `renderer` callback can be defined to return a new React element. It receives the following [render props](#render-props) as the first argument.



#### Render Props



The render props object consists of the current time delta object, the countdown's [`api`](#api-reference), the component [`props`](#props), and last but not least, a [`formatted`](#formattimedelta) object.



```js

{

  total: 0,

  days: 0,

  hours: 0,

  minutes: 0,

  seconds: 0,

  milliseconds: 0,

  completed: true,

  api: { ... },

  props: { ... },

  formatted: { ... }

}

```



> Please note that a defined custom [`renderer`](#renderer) will ignore the [`children`](#children) prop.



### `now`

If the current date and time (determined via a reference to `Date.now`) is not the right thing to compare with for you, a reference to a custom function that returns a similar dynamic value could be provided as an alternative.



### `onMount`

`onMount` is a callback and triggered when the countdown mounts. It receives a [time delta object](#calctimedelta) as the first argument.



### `onStart`

`onStart` is a callback and triggered whenever the countdown is started (including first-run). It receives a [time delta object](#calctimedelta) as the first argument.



### `onPause`

`onPause` is a callback and triggered every time the countdown is paused. It receives a [time delta object](#calctimedelta) as the first argument.



### `onStop`

`onStop` is a callback and triggered every time the countdown is stopped. It receives a [time delta object](#calctimedelta) as the first argument.



### `onTick`

`onTick` is a callback and triggered every time a new period is started, based on what the [`intervalDelay`](#intervaldelay)'s value is. It only gets triggered when the countdown's [`controlled`](#controlled) prop is set to `false`, meaning that the countdown has full control over its interval. It receives a [time delta object](#calctimedelta) as the first argument.



### `onComplete`

`onComplete` is a callback and triggered whenever the countdown ends. In contrast to [`onTick`](#ontick), the [`onComplete`](#oncomplete) callback also gets triggered in case [`controlled`](#controlled) is set to `true`. It receives a [time delta object](#calctimedelta) as the first argument and a `boolean` as a second argument, indicating whether the countdown transitioned into the completed state (`false`) or completed on start (`true`).



## API Reference



The countdown component exposes a simple API through the `getApi()` function that can be accessed via component `ref`. It is also part (`api`) of the [render props](#render-props) passed into [`renderer`](#renderer) if needed. Here's an [example](https://github.com/ndresx/react-countdown/blob/master/examples/src/CountdownApi.tsx) of how to use it.



### `start()`

Starts the countdown in case it is paused/stopped or needed when [`autoStart`](#autostart) is set to `false`.



### `pause()`

Pauses the running countdown. This only works as expected if the [`controlled`](#controlled) prop is set to `false` because [`calcTimeDelta`](#calctimedelta) calculates an offset time internally.



### `stop()`

Stops the countdown. This only works as expected if the [`controlled`](#controlled) prop is set to `false` because [`calcTimeDelta`](#calctimedelta) calculates an offset time internally.



### `isPaused()`

Returns a `boolean` for whether the countdown has been paused or not.



### `isStopped()`

Returns a `boolean` for whether the countdown has been stopped or not.



### `isCompleted()`

Returns a `boolean` for whether the countdown has been completed or not.



> Please note that this will always return `false` if [`overtime`](#overtime) is `true`. Nevertheless, an into overtime running countdown's completed state can still be looking at the time delta object's `completed` value.



## Helpers



This module also exports three simple helper functions, which can be utilized to build your own countdown custom [`renderer`](#renderer).



```js

import Countdown, { zeroPad, calcTimeDelta, formatTimeDelta } from 'react-countdown';

```



### `zeroPad(value, [length = 2])`

The `zeroPad` function transforms and returns a given `value` with padded zeros depending on the `length`. The `value` can be a `string` or `number`, while the `length` parameter can be a `number`, defaulting to `2`. Returns the zero-padded `string`, e.g., `zeroPad(5)` => `05`.



```js

const renderer = ({ hours, minutes, seconds }) => (

  

    {zeroPad(hours)}:{zeroPad(minutes)}:{zeroPad(seconds)}

  

);

```





### `calcTimeDelta(date, [options])`

`calcTimeDelta` calculates the time difference between a given end [`date`](#date) and the current date (`now`). It returns, similar to the [`renderer`](#renderer) callback, a custom object (also referred to as **countdown time delta object**) with the following time-related data:



```js

{ total, days, hours, minutes, seconds, milliseconds, completed }

```



The `total` value is the absolute time difference in milliseconds, whereas the other time-related values contain their relative portion of the current time difference. The `completed` value signalizes whether the countdown reached its initial end or not.



The `calcTimeDelta` function accepts two arguments in total; only the first one is required.



**`date`**

Date or timestamp representation of the end date. See [`date`](#date) prop for more details.



**`options`** The second argument consists of the following optional keys.



- **`now = Date.now`**

Alternative function for returning the current date, also see [`now`](#now).



- **`precision = 0`**

The [`precision`](#precision) on a millisecond basis.



- **`controlled = false`**

Defines whether the calculated value is provided in a [`controlled`](#controlled) environment as the time difference or not.



- **`offsetTime = 0`**

Defines the offset time that gets added to the start time; only considered if controlled is false.



- **`overtime = false`**

Defines whether the time delta can go into [`overtime`](#overtime) and become negative or not. When set to `true`, the `total` could become negative, at which point `completed` will still be set to `true`.





### `formatTimeDelta(timeDelta, [options])`

`formatTimeDelta` formats a given countdown time delta object. It returns the formatted portion of it, equivalent to:



```js

{

  days: '00',

  hours: '00',

  minutes: '00',

  seconds: '00',

}

```



This function accepts two arguments in total; only the first one is required.



**`timeDelta`**

Time delta object, e.g., returned by [`calcTimeDelta`](#calctimedelta).



**`options`**

The `options` object consists of the following three component props and is used to customize the time delta object's formatting:

* [`daysInHours`](#daysinhours)

* [`zeroPadTime`](#zeropadtime)

* [`zeroPadDays`](#zeropaddays)



## FAQ



### Why does my countdown reset on every re-render?



A common reason for this is that the [`date`](#date) prop gets passed directly into the component without persisting it in any way.



In order to avoid this from happening, it should be stored in a place that persists throughout lifecycle changes, for example, in the component's local `state`.



### Why aren't my values formatted when using the custom [`renderer`](#renderer)?



The [`renderer`](#renderer) callback gets called with a [time delta object](#calctimedelta) that also consists of a `formatted` object which holds these formatted values.



### Why do I get this error `"Warning: Text content did not match..."`?



This could have something to do with server-side rendering and that the countdown already runs on the server-side, resulting in a timestamp discrepancy between the client and the server. In this case, it might be worth checking https://reactjs.org/docs/dom-elements.html#suppresshydrationwarning.



Alternatively, you could try to set [`autoStart`](#autostart) to `false` and start the countdown through the [API](#api-reference) once it's available on the client. Here are some related [issues](https://github.com/ndresx/react-countdown/issues/152) that might help in fixing this problem.



## Contributing



Contributions of any kind are very welcome. Read more in our [contributing guide](https://github.com/ndresx/react-countdown/blob/master/CONTRIBUTING.md) about how to report bugs, create pull requests, and other development-related topics.



## License



MIT



[npm]: https://img.shields.io/npm/v/react-countdown.svg

[npm-url]: https://npmjs.com/package/react-countdown