widget files package json

package.json

This file contains many information about your widget

{
	"type": "numeric-display",
	"version": "0.1",
	"releaseType": "beta",
	"author": "yadoms team",
	"url": "http://www.yadoms.com/wiki/widgets/numeric-display.html",
	"credits": "",
        "hasTitle": true,
	"dimensions": {
		"min": {
			"x": 1,
			"y": 1
		},
		"max": {
			"x": 2,
			"y": 1
		},
		"default": {
			"x": 1,
			"y": 1
		}
	},
	"configurationSchema": {
		...
	}
}

• type: typename of your widget
• version: version of your widget. The versionning must follow Versioning process
• releaseType: release type of your widget. The release type must follow Versioning process
• author: You !
• url: Url of your documentation or your widget page
• credits: contains credits informations about used libraries, etc. this field supports mardown.
• hasTitle: indicates if the user could define a tiltle to the widget in the configuration (default: false)
• dimensions: This section contains all dimensions information. All dimensions are in blocks units
  • min: It contains x and y min dimension of your widget. By default, min dimensions are 1 x 1 blocks
  • max: It contains x and y max dimension of your widget. By default, max dimensions are not constraint
  • default: It contains x and y default dimension of your widget. By default, it takes the slower dimension as possible
• configurationSchema: It follows Configuration documentation