Skip to main content

@lexical/react/LexicalEditorModeAnnouncePlugin

Interfaces

EditorModeAnnouncePluginProps

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

Properties

messages?

optional messages?: object

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

Messages announced when the editor transitions between modes. Hosts supply localized strings; defaults are English.

editable?

optional editable?: string

readOnly?

optional readOnly?: string

Functions

EditorModeAnnouncePlugin()

EditorModeAnnouncePlugin(__namedParameters?): null

Defined in: packages/lexical-react/src/LexicalEditorModeAnnouncePlugin.ts:33

React wrapper around registerEditorModeAnnounce from @lexical/a11y.

Announces editor.setEditable(true|false) transitions into a polite aria-live region (provided by useLexicalAriaLiveRegion).

Parameters

__namedParameters?

EditorModeAnnouncePluginProps = {}

Returns

null

Deprecated

A pure Lexical implementation is available in @lexical/a11y as EditorModeAnnounceExtension