aq-uiTimerControls
interfaceSource L7Type contract for TimerControls.
interface TimerControlsMembers
| Name | Type |
|---|---|
clear | () => void |
reset | () => void |
isActive | boolean |
Use Timeout
Open-code aq-ui React hook for Use Timeout.
Installation
pnpm dlx aq-ui@alpha add use-timeoutAPI reference
Client moduleImport the parts you need, then jump to an export for its contract.
Quick start
"use client"
import { useTimeout } from "@/hooks/use-timeout"useTimeout
functionSource L17Open-code aq-ui React hook for Use Timeout.
function useTimeout(callback: () => void, delay: number | null, { autoStart = true }: UseTimeoutOptions = {}): TimerControls- Returns
TimerControls
Parameters
| Name | Type | Default |
|---|---|---|
callback | () => void | — |
delay | number | null | — |
options? | UseTimeoutOptions | {} |
UseTimeoutOptions
interfaceSource L13Type contract for UseTimeoutOptions.
interface UseTimeoutOptionsMembers
| Name | Type | Default |
|---|---|---|
autoStart? | boolean | true |
Registry dependencies
use-latest
Files
- hooks/use-timeout.ts