Meta information (main.json) Cloud On-Premises

This file must contain a single JavaScript object with following structure:

• String type - (optional) Type of plugin. If present must have one of the values:
  • "gateway" - plugin that adds a new payment option to store cart and/or payment gateway button for immediate purchases;
  • "map" - plugin that adds a new map type;
  • "video" - plugin that adds a new video player type;
  • "ui" - plugin that replaces default Site.pro builder UI with its own (since v3.7.301);
  • "generic" - any other element that does not have any of the above mentioned functionality (used by default).
• Boolean requireStoreModule - (optional) Must be set to true if plugin uses store module functionality. This also forces store module to be published along with plugin element even if website has no store or cart element on any page. Defaults to false.
• Boolean requireBillingInfo - (optional) Must be set to true if payment gateway added by plugin requires billing information to be entered by customer. Defaults to false.
• Boolean fixedHeight - (optional) When set to true custom element added by plugin will have a fixed height when publishing with auto-layout enabled. Defaults to false.
• Array of String requireJsLibs - (optional) A list of JavaScript libraries from store module that must be included in published website.
• Array of String loadModules - (optional) A list of modules that must be loaded (code executed) when plugin is loaded. Typically this option is used when plugin is written entirely in TypeScript language, which encapsulates all transpiled code into modules. Internally builder calls a JavaScript require function with the list of given modules to execute their code. This array may be empty (or omitted) if you have no modules declared in main.js or main.min.js. This option is available since v3.7.301.
• Boolean admin - (optional) Set this to true if plugin should load only when builder is opened in administration (template creation) mode. This can be used to prevent plugin from getting loaded into production environment while it is being developed. Defaults to false.

Example of main.json

{
	"type": "gateway",
	"requireStoreModule": true,
	"requireBillingInfo": true
}