Versions Compared

Old Version 34

changes.mady.by.user Unknown User (l.van.zeeland)

Saved on

compared with

New Version 35

changes.mady.by.user Joost Koehoorn

Saved on

Key

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

A custom MVC UI theme can be created if the use of default Blueriq themes is not desired. This could be the case if for example you want to create your own client application and Extending themes is not sufficient.

Introduction

The MVC UI has two default themes (bootstrap3 and bootcards) and has support for custom made themes. A theme is basically a set of files and some configuration that consists of the following components:

...

A default Blueriq index page is injected with a template context that features properties, the properties can be found here Configuration When creating a custom theme you need to provide a StringTemplate index file.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 "../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.

...