apps-plugin-sdk
Build, audit and explain ONLYOFFICE Apps (formerly DocSpace) plugins made with the Plugins SDK. Use whenever someone wants to create, scaffold, extend or change one, or describes a feature inside the portal without naming the SDK, React or the UI kit — an item in the context menu, main button or profile menu, a page in the sidebar, a tab in the info panel, a handler for a custom file type, a reaction to a portal event, an admin settings form ("a button in ONLYOFFICE Apps that converts a file", "a screen inside ONLYOFFICE Apps listing our rooms"). Use it too when a plugin installs but does nothing, renders blank, shows for the wrong users or does not change after a re-upload; when someone asks to review, debug, fix or migrate an existing plugin; and for questions about scopes, hooks, items, actions or how the portal loads plugins. Not for document-editor plugins (ONLYOFFICE Docs plugins and macros), for embedding ONLYOFFICE Apps into another site (apps-embed-sdk), or for standalone REST API scripts.
- License
- Apache-2.0
Pinned to revision 441a2ea309a6, so it is the text this page describes rather than whatever the author pushed since.
Files
- skills/apps-plugin-sdk/SKILL.md
- skills/apps-plugin-sdk/README.md
- skills/apps-plugin-sdk/evals/README.md
- skills/apps-plugin-sdk/evals/evals.json
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/.gitignore
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/.prettierrc.json
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/assets/icon-16.svg
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/assets/logo.svg
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/package.json
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/src/NoteModal.module.css
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/src/NoteModal.tsx
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/src/css-modules.d.ts
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/src/index.ts
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/src/locales.ts
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/tsconfig.json
- skills/apps-plugin-sdk/evals/fixtures/working-plugin/vite.config.ts
- skills/apps-plugin-sdk/evals/trigger-tests.md
- skills/apps-plugin-sdk/references/audit.md
- skills/apps-plugin-sdk/references/build.md
- skills/apps-plugin-sdk/references/bundling.md
- skills/apps-plugin-sdk/references/components/create-dialog.md
- skills/apps-plugin-sdk/references/components/floating-operations-button.md
- skills/apps-plugin-sdk/references/components/media-viewer.md
- skills/apps-plugin-sdk/references/components/modal-dialog.md
- skills/apps-plugin-sdk/references/components/selector.md
- skills/apps-plugin-sdk/references/dependencies.md
- skills/apps-plugin-sdk/references/items/article-button-item.md
- skills/apps-plugin-sdk/references/items/article-navigation-item.md
- skills/apps-plugin-sdk/references/items/common-fields.md
- skills/apps-plugin-sdk/references/items/context-menu-item.md
- skills/apps-plugin-sdk/references/items/event-listener-item.md
- skills/apps-plugin-sdk/references/items/file-item.md
- skills/apps-plugin-sdk/references/items/info-panel-item.md
- skills/apps-plugin-sdk/references/items/main-button-item.md
- skills/apps-plugin-sdk/references/items/profile-menu-item.md
- skills/apps-plugin-sdk/references/plugins/api-plugin.md
- skills/apps-plugin-sdk/references/plugins/plugin.md
- skills/apps-plugin-sdk/references/plugins/post-message-plugin.md
- skills/apps-plugin-sdk/references/plugins/scopes.md
- skills/apps-plugin-sdk/references/plugins/settings-plugin.md
- skills/apps-plugin-sdk/references/portal.md
- skills/apps-plugin-sdk/references/react/actions.md
- skills/apps-plugin-sdk/references/react/api.md
- skills/apps-plugin-sdk/references/react/hooks.md
- skills/apps-plugin-sdk/references/react/rendering.md
- skills/apps-plugin-sdk/references/rest-api.md
- skills/apps-plugin-sdk/references/sdk-2-plugins.md
- skills/apps-plugin-sdk/references/styles.md
- skills/apps-plugin-sdk/references/ui-kit.md
- skills/apps-plugin-sdk/scripts/README.md
- skills/apps-plugin-sdk/scripts/contract.mjs
- skills/apps-plugin-sdk/scripts/generate-plugin.mjs
- skills/apps-plugin-sdk/scripts/generator/README.md
- skills/apps-plugin-sdk/scripts/generator/options.mjs
- skills/apps-plugin-sdk/scripts/generator/plugin-generator.mjs
- skills/apps-plugin-sdk/scripts/generator/project-files.mjs
- skills/apps-plugin-sdk/scripts/generator/scopes.mjs
- skills/apps-plugin-sdk/scripts/generator/sources.mjs
- skills/apps-plugin-sdk/scripts/preview-plugin.mjs
- skills/apps-plugin-sdk/scripts/preview/README.md
- skills/apps-plugin-sdk/scripts/preview/browser-checks.mjs
- skills/apps-plugin-sdk/scripts/preview/harness-files.mjs
- skills/apps-plugin-sdk/scripts/preview/peer-stubs.mjs
- skills/apps-plugin-sdk/scripts/test-validator.mjs
- skills/apps-plugin-sdk/scripts/validate-plugin.mjs
- skills/apps-plugin-sdk/scripts/validator-tests/README.md
- skills/apps-plugin-sdk/scripts/validator-tests/fixtures.mjs
- skills/apps-plugin-sdk/scripts/validator-tests/harness.mjs
- skills/apps-plugin-sdk/scripts/validator-tests/suites/items.mjs
- skills/apps-plugin-sdk/scripts/validator-tests/suites/locales.mjs
- skills/apps-plugin-sdk/scripts/validator-tests/suites/manifest.mjs
- skills/apps-plugin-sdk/scripts/validator-tests/suites/render.mjs
- skills/apps-plugin-sdk/scripts/validator-tests/suites/runtime.mjs
- skills/apps-plugin-sdk/scripts/validator-tests/suites/sdk-drift.mjs
- skills/apps-plugin-sdk/scripts/validator-tests/suites/ui.mjs
- skills/apps-plugin-sdk/scripts/validator/README.md
- skills/apps-plugin-sdk/scripts/validator/archive-checks.mjs
- skills/apps-plugin-sdk/scripts/validator/findings.mjs
- skills/apps-plugin-sdk/scripts/validator/plugin-project.mjs
- skills/apps-plugin-sdk/scripts/validator/project-checks.mjs
- skills/apps-plugin-sdk/scripts/validator/render-checks.mjs
- skills/apps-plugin-sdk/scripts/validator/runtime-checks.mjs
- skills/apps-plugin-sdk/scripts/validator/sandbox.mjs
- skills/apps-plugin-sdk/scripts/validator/shapes.mjs
- skills/apps-plugin-sdk/scripts/validator/stubs/ui-kit.mjs
- skills/apps-plugin-sdk/sources.json
- skills/apps-plugin-sdk/templates/css-modules.d.ts
- skills/apps-plugin-sdk/templates/gitignore
- skills/apps-plugin-sdk/templates/prettierrc.json
- skills/apps-plugin-sdk/templates/tsconfig
- skills/apps-plugin-sdk/templates/vite.config
Every link opens the file at its source, pinned to the revision this page describes.