use-interval
#
Installation#
API#
useIntervalA hook for setting intervals based on this article.
#
useSyncedIntervalA hook for setting synced intervals. Use this if you have intervals in different parts of the app that should execute at the same time.
You can optionally specify a channel to have multiple groups of synced intervals. For example 2 intervals that run every 10s and 3 intervals that run every 2s.
The hook will use the last delay that was mounted, so in the example above it should be 2000
until OtherComponent
unmounts, at which point it will become 1000
. See below how to specify only
callbacks.
The callbacks leverage a ref
under the hood, so you technically don't have to use useCallback
for the callback, but it is recommended. Changing the delay will cause a re-render.
#
useSyncedIntervalCallbackSame as useSyncedInterval
but without specifying a delay. It will use the last delay specified of
the defaultDelay
passed to SyncedIntervalProvider
.
#
useSyncedIntervalDelaySame as useSyncedIntervalCallback
but only specifying the delay instead.