Skip to content
aq-ui
Back to HooksHook

Use Live Region

Open-code aq-ui React hook for Use Live Region.

Installation

pnpm dlx aq-ui@alpha add use-live-region

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 { useLiveRegion } from "@/hooks/use-live-region"

const result = useLiveRegion()

LiveRegionControls

interfaceSource L15

Type contract for LiveRegionControls.

interface LiveRegionControls

Members

NameType
announce(message: string) => void
clear() => void
supportedboolean

LiveRegionPoliteness

typeSource L8

Type contract for LiveRegionPoliteness.

type LiveRegionPoliteness = "polite" | "assertive"

useLiveRegion

functionSource L69

Open-code aq-ui React hook for Use Live Region.

function useLiveRegion({ politeness = "polite", clearAfter = 7_000, }: UseLiveRegionOptions = {}): LiveRegionControls
Returns
LiveRegionControls

Parameters

NameTypeDefault
options?UseLiveRegionOptions{}
const result = useLiveRegion()

UseLiveRegionOptions

interfaceSource L10

Type contract for UseLiveRegionOptions.

interface UseLiveRegionOptions

Members

NameTypeDefault
politeness?LiveRegionPoliteness"polite"
clearAfter?number7_000

Registry dependencies

use-hydrated, use-stable-callback

Files

  • hooks/use-live-region.ts

Source