Skip to main content

Widget Pack Configuration

Each plugin must include a mobro-widget-pack-config.json file which defines some important metadata. This file must be located in the root directory for you widget pack project. If you created the project via the dashboard-cli, an example file should exist by default.

caution

If this file is missing, the dashboard-cli won't be able to start the dev command or publish the widget pack to the marketplace and MoBro won't be able to detect it as a widget pack.

Fields​

FieldDefaultRestrictionsDescription
name-Required
Length: 3 - 128
Pattern: ^[\w-]+$		The globally unique name (=id) of the widget pack
displayNamename-Visible human readable name of the widget pack
authorUnknown-The name of the author of this widget pack
description--A short textual description for the widget pack

Example​

The following configuration file is taken from the charts widget pack.

mobro-widget-pack-config.json
{
  "name": "modbros_charts",
  "displayName": "Charts",
  "description": "Includes highly customizable base widgets such as textual values, bar/line charts, donuts and gauges.",
  "author": "ModBros"
}