Plugins
Core plugin interfaces that define the contract for each plugin type supported by ONLYOFFICE Apps. Every plugin must implement IPlugin plus one or more type-specific interfaces.
Implement the interface that matches the ONLYOFFICE Apps UI area you want to extend. Each plugin type registers its UI entries as items kept in a Map.
Overview
Available plugin type interfaces:
| Interface | Description |
|---|---|
IApiPlugin | The plugin that is provided with the origin, proxy, and prefix to make requests to the portal server. |
IArticleButtonPlugin | Describes a plugin that adds custom button items to the article sidebar. |
IArticleNavigationPlugin | Describes a plugin that adds navigation items to the article sidebar. |
IContextMenuPlugin | The plugin that is embedded in the context menu of files, folders, rooms, images, video (audio). |
IEventListenerPlugin | The plugin that is given the access to the portal events. |
IFilePlugin | The plugin that can interact with the file list. |
IInfoPanelPlugin | The plugin that is embedded as a separate tab in the file info panel. |
IMainButtonPlugin | The plugin that can add items to the main button menu. |
IPlugin | The default plugin, implemented by every plugin class together with the interfaces of the scopes it declares, such as IContextMenuPlugin. |
IPostMessagePlugin | The plugin that is given the access to handle postMessage events from iframe components. |
IProfileMenuPlugin | Plugin for embedding items in the profile menu. |
ISettingsPlugin | The plugin that manages settings for the administrator or owner. |