TRY NEW VERSION

Try now New API BETA

Try out the new view and capabilities of the API documentation

START

Overview

ONLYOFFICE Plugins and Macrosv8.1

ONLYOFFICE Docs and Desktop Editors offer support for plugins allowing developers to add specific features to the editors that are not directly related to the OOXML format.

Plugin is an HTML page that is embedded in the editor and uses API to work with it.

This documentation describes:

What plugins can do

Here are some examples of what you can do with ONLYOFFICE plugins:

Code samples are available at https://github.com/ONLYOFFICE/sdkjs-plugins.

If you are looking for ready-to-use plugins, please visit ONLYOFFICE App Directory.

To quickly install and update plugins, you can use ONLYOFFICE Plugin Marketplace.

How to create plugins

To create your own plugin, you need to follow a few steps:

  1. Learn the fundamental concepts for building plugins on the Getting started with plugins page and write code that defines the plugin appearance and behavior.
  2. After building the plugin, test it thoroughly and make sure the plugin looks and works as you expected. Try to anticipate the problems that might occur and suggest your solutions to them.
  3. Now you can use the plugin on your own or suggest it for publishing by creating a pull request to the plugin marketplace repository.

How to get help

If you have any questions about plugins, try to find them in 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).