Skip to main content

Plugins

Core plugin interfaces that define the contract for each plugin type supported by DocSpace. Every plugin must implement IPlugin plus one or more type-specific interfaces.

Implement the interface that matches the DocSpace UI area you want to extend. Each plugin type registers its UI entries as items kept in a Map.

Overview

Available plugin type interfaces:

InterfaceDescription
IApiPluginThe plugin that is provided with the origin, proxy, and prefix to make requests to the portal server.
IArticleButtonPluginDescribes a plugin that adds custom button items to the article sidebar.
IContextMenuPluginThe plugin that is embedded in the context menu of files, folders, rooms, images, video (audio).
IEventListenerPluginThe plugin that is given the access to the portal events.
IFilePluginThe plugin that can interact with the file list.
IInfoPanelPluginThe plugin that is embedded as a separate tab in the file info panel.
IMainButtonPluginThe plugin that can add items to the main button menu.
IPluginThe default plugin.
IPostMessagePluginThe plugin that is given the access to handle postMessage events from iframe components.
IProfileMenuPluginPlugin for embedding items in the profile menu.
ISettingsPluginThe plugin that manages settings for the administrator or owner.