Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A default Blueriq index page is injected with a template context that features the following properties:

Variable TypeDescription
context.sessionId
string
Blueriq Session ID of the current Blueriq session
context.theme
string
Current theme of the Blueriq session
context.webResourcesBasePath
string

Location from root where web-resources are located

context.apiBasePath
string

Relative path of API endpoints, always "../api/"

context.currentPage
{ [elementKey: string]: Element }
Full pageModel, see REST Page Models
context.developmentMode
boolean
Indicates if developmentMode is active or not
context.sessionTimeout
integer
Session timeout in seconds

Creating the index file

The index file is the starting point of a custom theme and is a StringTemplate template that follows a certain structure. For full details on the StringTemplate syntax and usage please check the official documentation. The purpose of the initial page is to load all the required resources (e.g. JavaScript or CSS files) and to provide a base layout.

...