use-react-timer

A minimal timer hook, countdown time for react and react native. Just <1kB

Installation

npm

npm install use-react-timer

yarn

yarn add use-react-timer

Live examples (Sandbox)

useTimer

useTimer(endAt) returns a object, the values of the object is day, hour, min, sec, isRunning. Argument endAt is Date type, the date that you want to compare to now time for timer.

Apply timer with useTimer function

Example:

1import React from "react";
2import { useTimer } from "use-react-timer";
3
4let endAt = new Date();
5endAt.setDate(new Date().getDate() + 2);
6
7const Timer = () => {
8  const { day, hour, min, sec, isRunning } = useTimer(endAt);
9  return (
10    <div className="timer">
11      <span>{day}{':'}</span>
12      <span>{hour}{':'}</span>
13      <span>{min}{':'}</span>
14      <span>{sec}</span>
15    </div>
16  );
17};
18
19export default Timer;
20

API

const { day, hour, min, sec, isRunning } = useTimer(endAt);

name	type	description
day	string	day of countdown
hour	string	hour of countdown
min	string	minute of countdown
sec	string	second of countdown
isRunning	boolean	returns a boolean value whether countdown is running or tap to end

License

MIT