You are viewing the documentation for Blueriq 17. Documentation for other versions is available in our documentation directory.

Deprecated

MVC UI is deprecated from Blueriq 11.0. The alternative for the MVC UI support is to only use the UI REST API  endpoints.


Introduction

The front end of a Blueriq application is defined by the theme that is selected at startup. This page gives a short overview of different themes and their configuration.

Themes

Currently there are different themes that can be used, which are:

  • Bootstrap3 (default)
  • Bootcards
  • Dashboard (deprecated)
  • Forms (deprecated)

In the following paragraphs more information will be given on the mentioned themes.

Bootstrap3

This is the default theme for all (desktop) projects. Bootstrap3 is part of version 2 of the MVC UI styling.

Description

This theme supports multiple sessions: it consists of a main session (the actual dashboard) and a session per widget. A widget can be added by the use of the  Container type: AQ_Dashboard_FlowWidget. The dashboard session is the main session which renders the initial page. The main session creates a subscription to the SessionService, and for each of the widgets a new Blueriq session is created and registered to that same subscription. Whenever a page event is triggered on any of the sessions, all page events for all sessions will be returned to the client and distributed to the corresponding widget viewmodels. The widget models then process the page events and that causes the update to the widgets. Widgets can communicate with each other through the message bus. The message bus is available both server and client side: The server side message bus can be used for business logic while the client side message bus can be used for technical solutions (such as refreshing a widget on a particular event).

Configuration

Add the following to application.properties. Note that mvc.themes can contain a list of comma separated themes.

blueriq.mvc.development-mode=false
blueriq.mvc.themes.bootstrap3.template-group-file=UI/mvc/v2/bootstrap3.stg
blueriq.mvc.themes.bootstrap3.template-name=main
blueriq.mvc.active-themes=bootstrap3
 

Bootcards

This is the theme for mobile applications. Bootcards is part of version 2 of the MVC UI styling.

Description

The bootcards theme is designed specifically for mobile applications, but it runs on desktops as well. More information on this theme can be found at bootcards.org. See also Blueriq App Builder for more information on how to model a Blueriq mobile application and use this theme.

Configuration

Add the following to application.properties. Note that mvc.themes can contain a list of comma separated themes.

blueriq.mvc.development-mode=false
blueriq.mvc.themes.bootcards.template-group-file=UI/mvc/v2/bootcards.stg
blueriq.mvc.themes.bootcards.template-name=main
blueriq.mvc.active-themes=bootcards

Dashboard (deprecated)

The dashboard is the former default theme. It is part of version 1 of the MVC UI styling.

Description

To create an application, a modeler previously had to choose which theme to use: either the dashboard or forms theme. The dashboard theme had been the default theme. Bootstrap3 has replaced these two themes.

The Blueriq dashboard theme is built on top of the default forms components used in the forms theme. The difference with the forms theme is that the dashboard theme supports multiple sessions: it consists out of a main session (the actual dashboard) and a session per widget. A widget can be added by the use of the Container type: AQ_Dashboard_FlowWidget.

For using this theme the Dashboard component is required.

Sessions and widgets

The dashboard session is the main session and is the session rendering the initial page. The main session creates a subscription to the SessionService, and for each of the widgets a new Blueriq session is created and registered to that same subscription. Whenever a page event is triggered on any of the sessions, all page events for all sessions will be returned to the client and distributed to the corresponding widget viewmodels. The widget models then process the page events and that causes the update to the widgets. Widgets can communicate with each other through the message bus.

Configuration

Add the following to application.properties. Note that mvc.themes can contain a list of comma separated themes.

blueriq.mvc.developmentMode=false
blueriq.mvc.versionUsed=v1
blueriq.mvc.themes=dashboard

blueriq.mvc.dashboard.templateGroupFile=UI/mvc/v1/dashboard.stg
blueriq.mvc.dashboard.templateName=main

Forms (deprecated)

The theme 'forms' had been the standard for MVC UI.

Description

This theme contains all default Blueriq UI components and standard functionality for e.g. flowing and refreshes. Note that this theme does not support dashboard styling.

Configuration

Add the following to application.properties. Note that mvc.themes can contain a list of comma separated themes.

blueriq.mvc.developmentMode=false
blueriq.mvc.versionUsed=v1
blueriq.mvc.themes=forms

blueriq.mvc.forms.templateGroupFile=UI/mvc/v1/forms.stg
blueriq.mvc.forms.templateName=main