@lexical/react/useLexicalAriaLiveRegion

Functions

useLexicalAriaLiveRegion()

useLexicalAriaLiveRegion(options?): (message) => void

Defined in: packages/lexical-react/src/useLexicalAriaLiveRegion.ts:25

React wrapper around registerAriaLiveRegion from @lexical/a11y.

Mounts a visually hidden aria-live region on first render, removes it on unmount, and returns an announce function that writes a message into it. The returned function is stable across renders.

Parameters

options?

AriaLiveRegionOptions = {}

Returns

(message) => void

References

AriaLiveRegionOptions

Re-exports AriaLiveRegionOptions

---

AriaPoliteness

Re-exports AriaPoliteness