Class ContextMenu<T>

An editor plugin that support showing a context menu using render() function from options parameter

Type parameters

T

Hierarchy

ContextMenu

Implements

EditorPlugin

Index

Constructors

constructor

Methods

Constructors

constructor

new ContextMenu<T>(options: ContextMenuOptions<T>): ContextMenu<T>

- Defined in roosterjs-editor-plugins/lib/plugins/ContextMenu/ContextMenu.ts:37
Create a new instance of ContextMenu class

Type parameters
- T
Parameters
- options: ContextMenuOptions<T>
  
  An options object to determine how to show/hide the context menu
Returns ContextMenu<T>

Methods

dispose

dispose(): void

Implementation of EditorPlugin.dispose
- Defined in roosterjs-editor-plugins/lib/plugins/ContextMenu/ContextMenu.ts:63
Dispose this plugin

Returns void

getName

getName(): string

Implementation of EditorPlugin.getName
- Defined in roosterjs-editor-plugins/lib/plugins/ContextMenu/ContextMenu.ts:48
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/ContextMenu/ContextMenu.ts:56
Initialize this plugin

Parameters
- editor: IEditor
  
  The editor instance
Returns void

onPluginEvent

onPluginEvent(event: PluginEvent): void

Implementation of EditorPlugin.onPluginEvent
- Defined in roosterjs-editor-plugins/lib/plugins/ContextMenu/ContextMenu.ts:77
Handle events triggered from editor

Parameters
- event: PluginEvent
  
  PluginEvent object
Returns void

Generated using TypeDoc