use-debounced-value | Mantine

Debounces value changes

The use-debounced-value hook debounces value changes. This can be useful when you want to perform a heavy operation based on React state, for example, sending a search request. Unlike use-debounced-state , it is designed to work with controlled components.

Value: [empty string]

Debounced value: [empty string]

You can immediately update the value with the first call using { leading: true } options:

The hook returns a third element with cancel and flush handlers. cancel discards the pending update, flush applies it immediately. Updates cancel automatically on component unmount.

In this example, type in some text and click the cancel button within a second to cancel debounced value change:

The second element of the returned tuple is a shorthand for cancel for backwards compatibility.

The UseDebouncedValueOptions and UseDebouncedValueReturnValue types are exported from the @mantine/hooks package; you can import them in your application:

Recommended articles