Navigation Menu

How to create a plugin step by step

ONLYOFFICE DocSpace Plugins SDK is an npm package based on TypeScript engines which provides interfaces allowing you to create your own plugins and embed them into the DocSpace portal. To illustrate how to use our Plugins SDK, we created a repository with the plugin samples.

Let's dive into the entire process of plugin development based on our plugin samples.

The plugin development lifecycle contains the following steps:

  1. Planning. Define the plugin's purpose, think about where you will access it and what third-party services you need to connect.
  2. Developing. Learn the Plugins SDK and generate the plugin's code.
  3. Testing. Test the prepared plugin and fix bugs if found.
  4. Using. Upload your plugin to the DocSpace and use it.

Get Help

  • If you have any questions about ONLYOFFICE DocSpace, 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).