Skip to main content

@lexical/react/LexicalHistoryAnnouncePlugin

Interfaces​

HistoryAnnouncePluginProps​

Defined in: packages/lexical-react/src/LexicalHistoryAnnouncePlugin.ts:14

Properties​

messages?​

optional messages?: object

Defined in: packages/lexical-react/src/LexicalHistoryAnnouncePlugin.ts:19

Messages announced after the corresponding history command runs. Hosts supply localized strings; defaults are English.

redone?​

optional redone?: string

undone?​

optional undone?: string

Functions​

HistoryAnnouncePlugin()​

HistoryAnnouncePlugin(__namedParameters?): null

Defined in: packages/lexical-react/src/LexicalHistoryAnnouncePlugin.ts:35

React wrapper around registerHistoryAnnounce from @lexical/a11y.

Announces undo / redo into a polite aria-live region (provided by useLexicalAriaLiveRegion) so screen readers pick up history navigation.

Hosts using @lexical/extension can wire the same behavior via HistoryAnnounceExtension from @lexical/a11y.

Parameters​

__namedParameters?​

HistoryAnnouncePluginProps = {}

Returns​

null