React Use Precision Timer
Edit page
HomeDemo
Hooks
useDelayuseStopwatchDescriptionUsageSignatureDemouseTimer
Code of ConductMIT License

useStopwatch

Description

This convenience hook creates a stopwatch using useTimer. A stopwatch tracks time when started and can be paused, resumed, and stopped.

Usage

import { useStopwatch } from 'react-use-precision-timer';

In your function component:

const stopwatch = useStopwatch();

Use start(), stop(), pause(), and resume() to control the stopwatch.

Stopwatch is a Timer object. Refer to Timer's getters to retrieve elapsed running time, paused time, and so forth.

Calling start while a stopwatch is already running will restart it.

Signature

useStopwatch() => Timer

Props

This hook takes no props.

Return

The hook returns a Timer that behaves like a stopwatch.

Demo

Go to the useTimer demo and set the delay to 0. This will turn the timer into a stopwatch.