Skip to content

ONLYOFFICE/sdkjs-plugins

Repository files navigation

License Release

Overview

The plugins for ONLYOFFICE Document Server and ONLYOFFICE Desktop Editors to enhance their functionality.

Available plugins

Currently the following plugins are available:

  • OCR for recognizing text from pictures and screenshots and inserting it into your documents.
  • Photo Editor for editing images right in your documents, including cropping, resizing, applying effects, and more.
  • Speech for converting selected text into speech.
  • Thesaurus for finding synonyms of a word and replacing it with the selected one.
  • Translator for translating the selected text using Yandex Translator.
  • YouTube for embedding YouTube videos into your documents.
  • Macros for creating JavaScript macros to run in your documents.
  • Highlight code for highlighting syntax of the code selecting the necessary language, style, and background color.

If you want to create your own plugin, check out the examples folder.

All the plugins are released under an MIT license. See the LICENSE file for more information.

How to add plugins to ONLYOFFICE solutions

For server solutions

Put the folder with the plugin code to ONLYOFFICE Document Server folder:

  • For Linux - /var/www/onlyoffice/documentserver/sdkjs-plugins/.
  • For Windows - %ProgramFiles%\ONLYOFFICE\DocumentServer\sdkjs-plugins.

For desktop editors

  • Archive the plugin files (config.json, index.html, and pluginCode.js).
  • Change the file extension to .plugin.
  • Go to the Plugins tab, click Manage Plugins >> Add plugin, browse for the .plugin file.

For the cloud version

Turn your plugin into a browser extension. Currently, it works for Chrome users only.

Use chrome_extension_example to learn how to transform an ONLYOFFICE plugin into a Chrome extension.

Detailed installation instructions for all versions can be found in the API documentation.

Project information

Official website: https://www.onlyoffice.com/

App Directory: https://www.onlyoffice.com/app-directory

SaaS version: https://www.onlyoffice.com/cloud-office.aspx

Documentation

Plugins structure and installation https://api.onlyoffice.com/plugin/basic.

Plugins code and methods https://api.onlyoffice.com/docbuilder/basic.

User feedback and support

If you have any problems or question about ONLYOFFICE plugins, use the issues section here, in this repository.