useDebounce

Description

Debounce hook.

Parameters

value

Value to debounce.

delay

number

Delay in milliseconds.

=>

The debounced value.

Example

Inspect

Source code

/packages/react-hooks/hooks/useDebounce.ts


import { useState } from 'react';
import { useDebouncedEffect } from './useDebouncedEffect';
 
/**
 * Debounce hook.
 * @param value - Value to debounce.
 * @param delay - Delay in milliseconds.
 * @returns The debounced value.
 * @public
 */
export function useDebounce<T>(value: T, delay: number) {
    const [debouncedValue, setDebouncedValue] = useState(value);
    useDebouncedEffect(() => setDebouncedValue(value), [value, delay], delay);
    return debouncedValue;
}