Skip to content
aq-ui
Back to HooksHook

Use Focus Return

Open-code aq-ui React hook for Use Focus Return.

Installation

pnpm dlx aq-ui@alpha add use-focus-return

API reference

Client module

Import the parts you need, then jump to an export for its contract.

View full source

Quick start

"use client"

import { useFocusReturn } from "@/hooks/use-focus-return"

const result = useFocusReturn()

FocusReturnControls

interfaceSource L7

Type contract for FocusReturnControls.

interface FocusReturnControls

Members

NameType
capture() => void
restore() => void

useFocusReturn

functionSource L18

Open-code aq-ui React hook for Use Focus Return.

function useFocusReturn({ enabled = true, preventScroll = true, fallback, }: UseFocusReturnOptions = {}): FocusReturnControls
Returns
FocusReturnControls

Parameters

NameTypeDefault
options?UseFocusReturnOptions{}
const result = useFocusReturn()

UseFocusReturnOptions

interfaceSource L12

Type contract for UseFocusReturnOptions.

interface UseFocusReturnOptions

Members

NameTypeDefault
enabled?booleantrue
preventScroll?booleantrue
fallback?Target<HTMLElement>—

Registry dependencies

hook-target

Files

  • hooks/use-focus-return.ts

Source