use-debounced-value

Debounce value changes

Import

Source

View source code

Docs

Edit this page

Package

@mantine/hooks

Usage

use-debounced-value to debounce value change. This can be useful in case you want to perform a heavy operation based on react state, for example, send search request.

Enter value to see debounce effect

Value: [empty string]

Debounced value: [empty string]

import { useState } from 'react';
import { useDebouncedValue } from '@mantine/hooks';
import { TextInput, Text } from '@mantine/core';

function Demo() {
  const [value, setValue] = useState('');
  const [debounced] = useDebouncedValue(value, 200);

  return (
    <>
      <TextInput
        label="Enter value to see debounce"
        value={value}
        style={{ flex: 1 }}
        onChange={(event) => setValue(event.currentTarget.value)}
      />

      <Text>Value: {value}</Text>
      <Text>Debounced value: {debounced}</Text>
    </>
  );
}

Leading update

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

Enter value to see debounce effect

Value: [empty string]

Debounced value: [empty string]

import { useState } from 'react';
import { useDebouncedValue } from '@mantine/hooks';
import { TextInput, Text } from '@mantine/core';

function Demo() {
  const [value, setValue] = useState('');
  const [debounced] = useDebouncedValue(value, 200, { leading: true });

  return (
    <>
      <TextInput
        label="Enter value to see debounce"
        value={value}
        style={{ flex: 1 }}
        onChange={(event) => setValue(event.currentTarget.value)}
      />

      <Text>Value: {value}</Text>
      <Text>Debounced value: {debounced}</Text>
    </>
  );
}

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:

Enter value to see debounce effect

Value: [empty string]

Debounced value: [empty string]

import { useState } from 'react';
import { useDebouncedValue } from '@mantine/hooks';
import { TextInput, Text, Button } from '@mantine/core';

function Demo() {
  const [value, setValue] = useState('');
  const [debounced, cancel] = useDebouncedValue(value, 1000);

  return (
    <>
      <TextInput
        label="Enter value to see debounce"
        value={value}
        style={{ flex: 1 }}
        onChange={(event) => setValue(event.currentTarget.value)}
      />
      <Button onClick={cancel} size="lg" style={{ marginLeft: 15 }}>
        Cancel
      </Button>

      <Text>Value: {value}</Text>
      <Text>Debounced value: {debounced}</Text>
    </>
  );
}

Definition

function useDebouncedValue<T = any>(
  value: T,
  wait: number,
  options?: {
    leading: boolean;
  }
): readonly [T, () => void];

Go back

Usage with Gatsby.js – Theming

Up next

use-disclosure – @mantine/hooks

Build fully functional accessible web applications faster than ever

About

Contribute Media assets Changelog Releases

Community

Chat on Discord Follow on Twitter Follow on Github GitHub discussions

Project

Mantine UI Documentation Github organization npm organization

Built by Vitaly Rtishchev and these awesome people

Join Discord community

Follow Mantine on Twitter