useDebounce

Overview

A hook that deal with the debounced value.

Documentation and Examples

Installation

pnpm dlx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useDebounce.json

npx shadcn@latest add https://shadcn-ahooks.vercel.app/r/useDebounce.json

yarn shadcn@latest add https://shadcn-ahooks.vercel.app/r/useDebounce.json

bun shadcn@latest add https://shadcn-ahooks.vercel.app/r/useDebounce.json

A hook that deal with the debounced value.

Examples

Default usage

API

const debouncedValue = useDebounce(
  value: any,
  options?: Options
);

Params

| Property | Description | Type | Default | | -- | | - | | value | The value to debounce. | any | - | | options | Config for the debounce behaviors. | Options | - |

Options

| Property | Description | Type | Default | | -- | - | ---- | | wait | The number of milliseconds to delay. | number | 1000 | | leading | Specify invoking on the leading edge of the timeout. | boolean | false | | trailing | Specify invoking on the trailing edge of the timeout. | boolean | true | | maxWait | The maximum time func is allowed to be delayed before it’s invoked. | number | - |