Skip to main content

Config

The config.json file is generated based on the data from the package.json file.

ParameterTypeExampleDescription
authorstring"ONLYOFFICE"The plugin author.
cspDomainsstring"https://embed.diagrams.net/,https://*.diagrams.net/"The list of all third-party resources that are used in the plugin. It is converted from an array into a string.
descriptionstring"plugin description"The description, i.e. what describes your plugin in the best way.
homePagestring"https://example.com/url-to-plugin-repository"The plugin homepage. For example, it can be the plugin GitHub repository.
imagestring"logo.png"The name of the logo image. It is equal to the logo parameter from the package.json file. The required icon size is 48x48 px. Otherwise, it will be compressed to this size.
licensestring"MIT"The plugin license.
minDocSpaceVersionstring"3.5.0"The minimum DocSpace version supported by the installed SDK. It is substituted automatically when building the plugin, not set by the plugin author. It is compared with the DocSpace portal version when the plugin is uploaded.
namestring"plugin-name"The plugin name.
pluginNamestring"Pluginname"The name by which the plugin is registered in the window object. It must match the pluginName parameter from the package.json file.
scopesstring"ContextMenu,InfoPanel,MainButton"The plugin scopes which are converted from an array into a string.
versionstring"1.0.0"The current plugin version.

Example

const config = {
author: "ONLYOFFICE",
cspDomains: "https://embed.diagrams.net/,https://*.diagrams.net/",
description: "plugin description",
homePage: "https://example.com/url-to-plugin-repository",
image: "logo.png",
license: "MIT",
name: "plugin-name",
pluginName: "Pluginname",
scopes: "ContextMenu,InfoPanel,MainButton",
version: "1.0.0",
}