useTimeout()

useTimeout(callback, delay?): void

Defined in: src/hooks/state/useTimeout.ts:25

Hook that runs a function after a specified delay. The timeout resets if the dependencies change.

Parameters

callback

The function to execute after the timeout. Can be a function or a direct callable reference.

void | () => void

delay?

number = 0

The delay in milliseconds. Defaults to 0.

Returns

void

Example

const MyComponent = () => {
  const [isVisible, setIsVisible] = useState(true)

  useTimeout(() => setIsVisible(false), 1000)
  // OR
  useTimeout(setIsVisible.bind(null, false), 1000)

  return <div>{isVisible ? 'Visible' : 'Hidden'}</div>
}