useToggle
Boolean state with a stable action for toggling or setting an explicit value.
useToggle(initialValue?: boolean): readonly [boolean, (next?: ToggleUpdater) => void]Public API / 37 Hooks
Hook index
Search by behavior, category, or TypeScript signature. Every entry links to its runtime contract and source.
Hook results
37 API entries found.
useBoolean
Boolean state with named setTrue, setFalse, and toggle actions.
useBoolean(initialValue?: boolean): UseBooleanResultuseControllableState
A controlled/uncontrolled state primitive with one stable setter contract.
useControllableState<T>(options?: UseControllableStateOptions<T>): readonly [T | undefined, SetValue<T>]usePrevious
Reads the value from the previous committed render.
usePrevious<T, U = undefined>(value: T, initialValue?: U): T | U | undefineduseLatest
A stable ref that follows the latest committed value.
useLatest<T>(value: T): RefObject<T>useMemoizedFn
Keeps a stable callback identity while invoking the latest committed implementation.
useMemoizedFn<T extends (...args: never[]) => unknown>(fn: T): TuseSafeState
Provides state whose setter ignores updates after the component unmounts.
useSafeState<S>(initialState: S | (() => S)): UseSafeStateResult<S>useResetState
Adds a stable reset action that restores the first resolved state value.
useResetState<S>(initialState: S | (() => S)): UseResetStateResult<S>useCounter
Manages a bounded number with stable increment, decrement, set, and reset actions.
useCounter(initialValue?: number, options?: UseCounterOptions): UseCounterResultuseMap
Manages a readonly Map snapshot with stable immutable actions.
useMap<K, V>(initialValue?: MapInitializer<K, V>): UseMapResult<K, V>useSet
Manages a readonly Set snapshot with stable membership actions.
useSet<T>(initialValue?: SetInitializer<T>): UseSetResult<T>useDebounce
Publishes a value after it remains unchanged for the configured delay.
useDebounce<T>(value: T, options: DebounceOptions): TuseThrottle
Limits value publication to at most once per delay window.
useThrottle<T>(value: T, options: ThrottleOptions): TuseDebounceFn
Debounces function calls with cancel, flush, and pending controls.
useDebounceFn<Args, Result>(fn: (...args: Args) => Result, options: DebounceFnOptions): DebouncedFunction<Args, Result>useThrottleFn
Throttles function calls while preserving the latest committed callback.
useThrottleFn<Args, Result>(fn: (...args: Args) => Result, options: ThrottleFnOptions): ThrottledFunction<Args, Result>useTimeout
Runs the latest callback once after a delay, with cancellation state.
useTimeout(callback: () => void, delay: number | null, options?: UseTimeoutOptions): { cancel: () => void; pending: boolean }useInterval
Runs the latest callback on a declarative interval.
useInterval(callback: () => void, delay: number | null, options?: UseIntervalOptions): voiduseAsync
Runs abortable asynchronous work with stale-result protection.
useAsync<T>(task: AsyncTask<T>, options?: UseAsyncOptions): UseAsyncResult<T>useLockFn
Prevents overlapping calls to an async or synchronous action.
useLockFn<Args extends readonly unknown[], Result>(fn: (...args: Args) => Result | PromiseLike<Result>, options?: UseLockFnOptions): LockFn<Args, Awaited<Result>>useWebSocket
Manages a browser WebSocket with raw messages, stable actions, and bounded reconnects.
useWebSocket(url: string | URL | null, options?: UseWebSocketOptions): UseWebSocketResultuseEventListener
Subscribes to an EventTarget with typed window events and automatic cleanup.
useEventListener(target?, type, listener, options?: UseEventListenerOptions | boolean): voiduseClickOutside
Calls a handler for pointer presses outside a referenced element.
useClickOutside<T extends HTMLElement>(ref: RefTarget<T>, onOutside: (event: PointerEvent) => void, enabledOrOptions?: boolean | UseClickOutsideOptions): voiduseMediaQuery
Subscribes to a media query through a shared external store.
useMediaQuery(query: string, options?: MediaQueryOptions): booleanuseWindowSize
Tracks viewport dimensions with one shared resize subscription.
useWindowSize(): Readonly<{ width: number; height: number }>useOnline
Tracks navigator connectivity with one listener pair per browser realm.
useOnline(): booleanuseDocumentVisibility
Tracks document visibility through a shared external-store subscription.
useDocumentVisibility(options?: UseDocumentVisibilityOptions): VisibilityStateuseKeyPress
Matches key alternatives, predicates, and string chords such as ctrl+s.
useKeyPress(keyFilter: KeyFilter, handler: KeyPressHandler, options?: UseKeyPressOptions): voiduseHover
Tracks mouseenter and mouseleave state for a target and follows ref changes.
useHover(target?: HoverTarget, options?: UseHoverOptions): booleanuseCopyToClipboard
Copies text with observable status and protection from stale write results.
useCopyToClipboard(options?: UseCopyToClipboardOptions): UseCopyToClipboardResultuseInput
Connects text inputs to controlled or uncontrolled string state.
useInput(options?: UseInputOptions): UseInputResultuseLocalStorage
Synchronizes typed state with localStorage and reports serialization errors.
useLocalStorage<T>(key: string, initialValue: T | (() => T), options?: StorageOptions<T>): UseStorageResult<T>useSessionStorage
Synchronizes typed state with sessionStorage for the current tab session.
useSessionStorage<T>(key: string, initialValue: T | (() => T), options?: StorageOptions<T>): UseStorageResult<T>useIsMounted
Returns a stable function that reports committed mount state.
useIsMounted(): () => booleanuseIsomorphicLayoutEffect
Uses useLayoutEffect in the browser and useEffect during SSR.
useIsomorphicLayoutEffect: typeof React.useEffectuseUnmountedRef
Exposes a stable ref that becomes true during unmount cleanup.
useUnmountedRef(): RefObject<boolean>useIntersectionObserver
Tracks intersection state for an element or ref with a deterministic SSR snapshot.
useIntersectionObserver(options?: UseIntersectionObserverOptions): IntersectionObserverState; useIntersectionObserver(target: IntersectionObserverTarget, options?: Omit<UseIntersectionObserverOptions, 'target' | 'ref'>): IntersectionObserverStateuseResizeObserver
Tracks an element size through ResizeObserver with stable dimensions and cleanup.
useResizeObserver(options?: UseResizeObserverOptions): ResizeObserverState; useResizeObserver(target: ResizeObserverTarget, options?: Omit<UseResizeObserverOptions, 'target' | 'ref'>): ResizeObserverState