Overview
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:
- How to build, localize, run, test and publish a plugin
- How to customize plugins: create context menu items, toolbar buttons, windows and panels, input helpers, process buttons
- How to write, debug and run a macro, add a custom function, or convert VBA macros to use in ONLYOFFICE
- How to interact with the editors, use ONLYOFFICE methods and events
- Where to find guides and plugin/macro code samples to get started
What plugins can do
Here are some examples of what you can do with ONLYOFFICE plugins:
- connect third-party services, like YouTube, Thesaurus, Translator, Zotero, OCR, etc.;
- add custom components & controls in the UI, like Trackchanges, Trackchanges_off;
- enhance the existing user experience and the editors’ functionality: Autocomplete, Search & Replace, Move cursor, Extended comments;
- automate tasks in documents with Macros.
Code samples are available at GitHub.
To maintain a consistent plugin user interface, you can use a set of prebuilt base components designed specifically for plugin UI creation. You can explore and interact with these components in our storybook.
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:
- Learn the fundamental concepts for building plugins on the Getting started page and write code that defines the plugin appearance and behavior.
- 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.
- Now you can use the plugin on your own or suggest it for publishing by creating a pull request to the plugin marketplace repository.