Skip to main content

Create a branding package

📁 webapp2
↳ 📁 plugins
  ↳ 📁 <name>
    ↳ 📄 <name>.plugin.js
    ↳ 📄 <name>.plugin.package.json
    ↳ 📁 assets
      ↳ 📁 css
      ↳ 📁 images
        ↳ 📄 buttonImage.svg
      ↳ 📁 js
↳ 📄 manifest.json
↳ 📄 settings.json

manifest.json​

This file is used to define at least the following parameters:

  • brandingID : It's an numerical ID that it's used for detecting changes in the branding. This way you will avoid any troubles with the client's browser cache.

  • isSettingsBranded: If this value is true, the webapp will read the settings.json file with your custom configuration.

{
  "brandingID": "10000000",
  "isSettingsBranded": true
}

settings.json​

This file can contain a lot of configuration parameters. In this case you will use it for defining all of your plugins. You can also activate or deactivate the plugins by changing the value of the enabled parameter.

{
  "plugins": [
    {
      "id": "<name>-plugin-1.0",
      "srcURL": "plugins/<name>/<name>.plugin.package.json",
      "enabled": true
    }
  ]
}