use-debounced-value
Debounce value changes
Import
Source
Docs
Package
Usage
use-debounced-value
hook debounces value changes.
This can be useful in case you want to perform a heavy operation based on react state,
for example, send search request. Unlike use-debounced-state it
is designed to work with controlled components.
Value: [empty string]
Debounced value: [empty string]
Differences to useDebouncedState
This hook differs slightly from the useDebouncedState hook.
- You have direct access to the non-debounced value.
- It is used for controlled inputs (
value
prop instead ofdefaultValue
), e.g. renders on every state change like a character typed in an input. - It works with props or other state providers, and it does not force use of
useState
.
Leading update
You can immediately update value with first call with { leading: true }
options:
Value: [empty string]
Debounced value: [empty string]
Cancel update
Hook provides cancel
callback, you can use it to cancel update.
Update cancels automatically on component unmount.
In this example, type in some text and click cancel button within a second to cancel debounced value change:
Value: [empty string]
Debounced value: [empty string]