Manifest structure

💁🏻 The manifest is an important file. A plugin cannot be installed without a correct formatted manifest.json file.

Default manifest object

{
  "bundle": "se.infomaker.DashboardPlugin",
  "name": "Dashboard Plugin",
  "description": "Dashboard Plugin Description",
  "author": {
    "name": "Team Dashboard",
    "organization": "Infomaker Scandinavia AB",
    "email": "support@infomaker.se",
    "website": "www.infomaker.se"
  },
  "version": "1.0.0"
}

Required properties:

Property

Description

bundle

a unique plugin id, create it by use reverse domain style and add your plugin name.

name

your plugin name, must be unique for your organisation. This is what will be displayed in the Dashboard.

author

plugin's developer, either and Object or an Array of Objects if there is many developers.

version

plugin version.

Optional properties:

Property

Description

graphic_url

plugin image displayed in Dashboard, defaults to default placeholder image if not defined.

markdown_url

plugin markdown documnet, displayed in plugin's settings in Dashboard store.

thumbnail_url

plugin thumbnail image displayed in plugin widget in Dashboard toolbar, defaults to graphic image if not defined.

wiki_url

plugin wiki url, for more details will point to wiki url.

allowRunInModal

boolean value to specify if the plugin's application can be run inside a Dashboard modal, default to true.

Last updated