npm.io
1.0.1 • Published 3 years ago

react-cool-timer

Licence
MIT
Version
1.0.1
Deps
0
Size
3 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

react-cool-timer

React timer countdown hook with easy to use API .

Installation

$ npm install --save react-cool-timer

or

yarn add react-cool-timer

or

pnpm add react-cool-timer

Usage

import { useTimer } from "react-cool-timer";

export const App = () => {
  const { timeLeft } = useTimer({
    onEndReached: () => console.log("Reached end"),
    timeInterval: 20,
  });
  return <div>Timeleft : {timeLeft}</div>;
};

Available props

Name Type Default Description
onEndReached () => void null Sets a function to run after timer ends
timeInterval number REQUIRED Sets time interval in seconds

Developer

@1mehdifaraji

Keywords

react-nativereactnextjsandroidiosmobilecountdowntimerhook