Class Announce

Announce messages to screen reader by using aria live element.

Hierarchy

Announce

Implements

EditorPlugin

Index

Constructors

constructor

Methods

Constructors

constructor

new Announce(stringsMapOrGetter?: Map<KnownAnnounceStrings | CompatibleKnownAnnounceStrings, string> | ((key: KnownAnnounceStrings | CompatibleKnownAnnounceStrings) => string), skipAnnounceFeatures?: AnnounceFeatureKey[], additionalFeatures?: AnnounceFeature[]): Announce

- Defined in roosterjs-editor-plugins/lib/plugins/Announce/AnnouncePlugin.ts:44
Parameters
- Optional stringsMapOrGetter: Map<KnownAnnounceStrings | CompatibleKnownAnnounceStrings, string> | ((key: KnownAnnounceStrings | CompatibleKnownAnnounceStrings) => string)
- skipAnnounceFeatures: AnnounceFeatureKey[] = []
- Optional additionalFeatures: AnnounceFeature[]
Returns Announce

Methods

Protected announce

announce(announceData: AnnounceData, editor: IEditor): void

- Defined in roosterjs-editor-plugins/lib/plugins/Announce/AnnouncePlugin.ts:132
Parameters
- announceData: AnnounceData
- editor: IEditor
Returns void

dispose

dispose(): void

Implementation of EditorPlugin.dispose
- Defined in roosterjs-editor-plugins/lib/plugins/Announce/AnnouncePlugin.ts:84
Dispose this plugin

Returns void

getAriaLiveElement

getAriaLiveElement(): HTMLDivElement

- Defined in roosterjs-editor-plugins/lib/plugins/Announce/AnnouncePlugin.ts:163
internal

Public only for unit testing.

Returns HTMLDivElement

getName

getName(): string

Implementation of EditorPlugin.getName
- Defined in roosterjs-editor-plugins/lib/plugins/Announce/AnnouncePlugin.ts:69
Get a friendly name of this plugin

Returns string

initialize

initialize(editor: IEditor): void

Implementation of EditorPlugin.initialize
- Defined in roosterjs-editor-plugins/lib/plugins/Announce/AnnouncePlugin.ts:77
Initialize this plugin

Parameters
- editor: IEditor
  
  The editor instance
Returns void

onPluginEvent

onPluginEvent(ev: PluginEvent): void

Implementation of EditorPlugin.onPluginEvent
- Defined in roosterjs-editor-plugins/lib/plugins/Announce/AnnouncePlugin.ts:99
Handle events triggered from editor

Parameters
- ev: PluginEvent
Returns void

Generated using TypeDoc