Skip to main content

Start Config

The start configuration is the starting point for the app. It tells the app which display type, layout, client template and named style to use on the app start.

Start configuration files​

Start configuration files are located in the ./start_config directory of the app configuration.

By default, the app will use the default.json file located in the ./start_config directory, but additional start configurations for different cases can be created, e.g. a configuration named onboarding.json for an app introduction.

Each start configuration file must have the following data structure, where name should be the same as the file name, while content has to be an object of simple key-value pairs.

Example of a default.json start configuration file​

{
  "name": "default",
  "content": {
    "type": "layered",
    "layout": "c_home",
    "template": "home",
    "templateIsNode": true,
    "namedStyle": "main"
  }
}

The following example contains the following fields:

  • name: The name of the start configuration (must be the same as the file name).
  • content: An object that contains the configuration itself.
    • type: Type of the displayed view.
      • layered - To display layered views.
      • tab - To display tab views.
    • layout: The name of the layout to be used.
    • template: The name of the client template to be used.
    • namedStyle: The name of the named style to be used (Default will be used if not provided).

Screenshot of the final start configuration file structure:

Start configuration file structure

Switching between start configurations​

If there are several start configurations in the app that can be switched between, this can be achieved by using a setCustomStart action.

{
  "type": "setCustomStart",
    "params": {
    "startConfig": "onboarding",
    "switchToCustomStart": true
  }
}