@lexical/react/LexicalEditorModeAnnouncePlugin

Interfaces

EditorModeAnnouncePluginProps

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

Properties

messages?

optional messages?: object

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

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:34

Announces editor mode transitions (editor.setEditable(true|false)) into a polite aria-live region so screen readers pick up the change. The aria-readonly attribute on the editor root is already managed by LexicalContentEditableElement; this plugin only contributes the announcement.

Parameters

__namedParameters?

EditorModeAnnouncePluginProps = {}

Returns

null