Skip to main content

eWizard.js: Module settings

Learn about the settings of the module scaffolding template

eWizard Team avatar
Written by eWizard Team
Updated over 2 years ago

The settings.json file in the project root directory stores the module template settings. When you initialize a module, this is the default configuration of the settings.json file:

// ./settings.json

{
   "name": "modules",
   "id": "415dfe94-4508-42dd-b3d3-e0431a593229",
   "localization": {
      "current": "eng",
      "original": "",
      "langs": [
         "eng"
      ]
   },
   "browserslist": ["last 2 versions"]
}

Field

Description

name

The module template name. By default, it's the same as the module project directory name.

id

The unique ID of the created module.

localization

Information about the current localization and available languages for the module template.

browserslist

Define the supported browsers for demonstrating your module. This configuration is applicable in prefixing the CSS rules and polyfilling JS. For more information, see the Browserslist configuration syntax.

Archive the module project and upload it to eWizard. In eWizard Editor, add a module from the Veeva Vault or NaviGate services. When you download the project after adding the module, the settings.json file has the following structure:

{
  "name": "modules",
  "id": "853c1c13-23c5-4a50-9f02-fbf11d2cee68",
  "localization": {
    "current": "eng",
    "original": "",
    "langs": [
      "",
      "eng"
    ]
  },
  "targetCLM": {
    "name": "",
    "code": ""
  },
  "writeFrameworkVersion": true,
  "fonts": {
    "alternative": "",
    "external": []
  },
  "browserslist": [
    "last 2 versions"
  ],
  "content": {
    "automaticLink": false
  },
  "targetDevices": [],
  "frameworkVersion": "5.19.0"
}

In addition to the default fields, you can find the following ones:

Field

Description

targetCLM

Information about the target system of the module template.

writeFrameworkVersion

Set to true to add the framework version to the resulting HTML file when export the email using the eWizard platform. The default value is true. For more information, see Write framework version in the email settings.

fonts

The settings for the custom fonts available in the eWizard Editor text properties. Use the external field for adding your custom font name and fontFamily values. For more information, see Custom fonts.

automaticLink

Set to true to make all numbers clickable in the resulting HTML after export the email using the eWizard platform. The default value is false. In this case, eWizard.js applies the fix so the numbers aren't converted to clickable links.

targetDevices

Lists the groups of devices that support the aspect ratio you select when you initialize the e-Detailer.

frameworkVersion

The eWizard.js framework version the module was created in.

Did this answer your question?