Types

The plugin type is specified with the type parameter in the config.json file. The following plugin types can be distinguished.

System

The system plugin is not displayed in the editor interface and is started in the background with the server (or desktop editors start) not interfering with other plugins, so that they can work simultaneously. You don’t need to run such plugins. And unlike background plugins, they cannot be disabled. Samples of system plugins: Settings, Search and replace on start.

Background

Launch such a plugin and it will work until you disable it in all opened documents and documents that will be opened later. Samples of background plugins: ChatGPT, QR Code Generator. The plugin state (enabled / disabled) persists between sessions. To access background plugins, click the Background Plugins button on the top toolbar.

Background plugins

Window

The plugin operates as a standalone window upon launch, like Highlight codePhoto editorOCR.

Plugin window

Panel

The plugin is opened in the left-side panel, like Translator, Thesaurus, Zotero. You can run multiple panel plugins at the same time. For each plugin, a separate button will appear on the left toolbar.

Plugin left panel

PanelRight

The plugin is opened in the right-side panel, like Translator, Thesaurus, Zotero. You can run multiple panel plugins at the same time. For each plugin, a separate button will appear on the right toolbar.

Plugin right panel

Unvisible

The plugin that does not display any windows or panels upon launch but can create them later during its operation. It provides a button (or buttons) to apply some transformations or manipulations to the document, like Hello world, Speech. For example, it can be used when the plugin displays different windows depending on the document content.

Insisible plugin

Please note that a plugin of any type can create windows and tabs during its work.

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).