Changelog

The list of changes for ONLYOFFICE Apps Plugins SDK.

Version 3.0

For migration instructions, see Updating a plugin to SDK 3.0.0.

• Added IArticleNavigationPlugin and IArticleNavigationItem to embed first-class navigation items in the article sidebar.
• Added the Section enum for the appears property of article navigation items.
• Added the component property to IInfoPanelItem, IArticleButtonItem, IMediaViewer, and ISettings, and dialogBodyComponent to IModalDialog, so a React component can be passed instead of a declarative IBox tree. See React components.
• Added the @onlyoffice/docspace-plugin-sdk/react hooks: usePluginAPI, usePluginActions, usePluginSettings, useCurrentFile, useCurrentUser, and usePluginRuntime.
• Added PluginAPIClient (via usePluginAPI) for authenticated HTTP requests to the portal, and PluginApiError / isPluginApiError for failed requests.
• Deprecated body in IInfoPanelItem and IArticleButtonItem, settings in ISettings, content in IMediaViewer, and dialogBody / dialogFooter in IModalDialog. Use component (dialogBodyComponent in IModalDialog) instead.
• Deprecated onLoad on those items and components. Load data with useEffect inside the React component.
• Replaced Webpack with Vite in the plugin template and build process.
• Raised minDocSpaceVersion to "4.0.0". Plugins built with SDK 3.0.0 require ONLYOFFICE Apps 4.0.0 or later.

Version 2.1.1

• Added markdown documentation generation with TypeDoc
• Added LLM instructions for DocSpace Plugin SDK development

Version 2.1.0

• Removed type: "module" from package.json
• Updated Webpack config in template (add "..." to minimizer array to save default minimizers)
• Converted const enums to regular enums
• Added Promise<void> return type to plugin methods onClick (IFileItem, IInfoPanelItem, IMainButtonItem, IProfileMenuItem)
• Made onLoad prop optional in IInfoPanelItem
• Made onClick prop optional in IContextMenuItem
• Switched from yarn to npm in npx create-docspace-plugin
• DEPRECATED onClick in IContextMenuItem is now deprecated in favor of onItemClick
• DEPRECATED onClick in IMainButtonItem is now deprecated in favor of onItemClick
• Added onItemClick callback to IContextMenuItem to support both string and number identifiers
• Added onItemClick callback to IMainButtonItem to support both string and number identifiers
• Added PluginLocale enum
• Added language, setLanguage, getLanguage properties to IPlugin
• Added isHeaderVisible property to IInfoPanelItem
• Added support for CSS files
• Added className property to components (IBox, IButton, ICheckbox, IComboBox, IFrame, IImage, IInput, ILabel, ISkeleton, IText, ITextArea, IToggleButton)
• Added id property to IBox
• Added onGroupClick, isGroupAction properties to IContextMenuItem
• Added items property to IContextMenuItem
• Added selector components (Base, Files, Groups, People, Room), enums (SelectorType, RoomSearchArea, RoomsType), and actions (showSelector, updateSelector, closeSelector)
• Added IFloatingOperationsButton component with progress tracking functionality and actions (addFloatingOperationsButton, updateFloatingOperationsButton, removeFloatingOperationsButton)
• Added IPostMessagePlugin, IPostMessageCallbackMessage util
• Added navigate, openInfoPanel actions to Actions
• Added IArticleButtonPlugin, IArticleButtonItem
• Added IconButton component
• Added ILink component
• Added IMediaViewer component, actions (showMediaViewer, updateMediaViewer, closeMediaViewer)
• Added placement property to IContextMenuItem
• Added itemId property to IContextMenuItem
• Fixed onClick id type in IMainButtonItem, IContextMenuItem

Version 2.0

• Separated file security into a new FilesSecurity enum.
• Added the fileSecurity and security properties to IFileItem.
• Added the withoutBodyPadding and withoutHeaderMargin properties to IModalDialog.
• Added the updateCreateDialogModal action to Actions.
• Added the isAutoFocusOnError, errorText, onError, onChange, isCloseAfterCreate, and isCreateDisabled properties to ICreateDialog.
• Added the itemSecurity property to IContextMenuItem.