Skip to main content

Getting started with plugins

ONLYOFFICE plugins are interactive tools built with HTML, CSS, and JavaScript that embed native-feeling features directly into the editors. Install them once and make them available to all users.

If you prefer to start coding right away, go directly to the quick start or try things out in the interactive playground.

What you can build​

Build sophisticated integrations that feel native to ONLYOFFICE.

Perfect for:

  • Embedding external content (YouTube, media galleries)
  • Third-party integrations (Translator, Zotero, CRM systems)
  • Advanced processing (OCR, image manipulation, data visualization)
  • Custom workflows (form builders, approval systems, templates)

Development profile:

  • Time: 2-7 days | Skill: Intermediate | Tech: HTML/CSS/JavaScript
  • Distribution: ONLYOFFICE Marketplace or private deployment

Browse live examples in ONLYOFFICE Marketplace

What plugins cannot do​

  • Directly access the editor's internal DOM or JavaScript scope
  • Access the file system on the user's machine
  • Bypass the API to perform operations not exposed by the plugin SDK

This sandboxing is intentional - it keeps the editor stable and secure regardless of what the plugin does.

Plugin architecturePlugin architecture

Comparing approaches​

Not sure which approach fits your use case? See how plugins compare to macros and custom AI tools.

ONLYOFFICE API Scheme ONLYOFFICE API Scheme

FeaturePluginsMacrosAI tools
What is it?HTML/CSS/JS app embedded in editorJavaScript code in documentsPlugin + AI provider integration
InstallationRequired (marketplace or manual)None (embedded in docs)Required (like plugins)
User interface✅ Full custom UI❌ No UI✅ Full custom UI
External APIs✅ Yes (REST, GraphQL, etc.)❌ No✅ Yes (AI services required)
Offline use⚠️ Depends on features✅ Fully offline❌ Requires internet
Skill levelIntermediateBeginnerAdvanced
Dev time2-7 days30 mins - 2 hours3-10 days
DistributionMarketplace, GitHub, privateCopy-paste, templatesMarketplace, private
Best forReusable tools, integrationsPersonal automationAI-powered features
Framework support✅ React, Vue, Angular❌ Vanilla JS only✅ Any framework

Also available: Macros | Custom AI tools

Troubleshooting​

Plugin doesn't appear:

  • Check config.json has a unique GUID
  • Verify file paths are correct
  • Restart ONLYOFFICE

JavaScript errors:

  • Open browser DevTools (F12)
  • Check the Console tab for error messages
  • Verify plugin.js is loaded

API methods fail:

  • Ensure your ONLYOFFICE version supports the method
  • Check method syntax in the API reference
  • Verify editor type compatibility

Need more help?

Resources​

Next steps​