Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 921 Bytes

README.md

File metadata and controls

46 lines (32 loc) · 921 Bytes

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