Kiosk mode

Kiosk mode hides the toolbar at the top of the interface so that a dashboard uses the whole screen. It is meant for screens that display a dashboard permanently, often combined with a playlist.

Entering and leaving kiosk mode

The Cycle kiosk mode button of the toolbar turns kiosk mode on and off. Once kiosk mode is on, a message recalls that pressing Esc brings the toolbar back.

The state chosen with the button is kept by the browser and restored the next time a dashboard is opened on it. It also takes precedence over the defaultViewport attribute described below.

Kiosk mode for a dedicated user

A user can open every dashboard in kiosk mode with the defaultViewport attribute set to fullscreen. This is the recommended setup for a screen that has its own user. It is done in either users.keycloak or on Keycloak itself.

{
  "enabled": true,
  "username": "display",
  "attributes": {
    "defaultViewport": "fullscreen"
  }
}

The attribute is applied as long as the Cycle kiosk mode button has never been used on the browser of the screen. From the first use of the button, or of Esc, the choice of the browser wins.

Kiosk mode from the URL

A dashboard URL can carry the kiosk parameter to decide of the mode for that dashboard.

?kiosk opens the dashboard with the toolbar hidden
?kiosk=false, or ?kiosk=0, opens the dashboard with the toolbar displayed, whatever the browser and the user attribute define

https://<host>/<dashboard-id>?kiosk
https://<host>/<dashboard-id>?kiosk=false

The parameter applies to the load it is given on and is not kept. A browser that follows a kiosk link once is therefore not left in kiosk mode afterwards.

Warning

The parameter belongs to the query part of the URL, which comes before the # of the widget parameters.

https://<host>/<dashboard-id>?kiosk#<widget-id>.<param-name>=<param-value>

Note

A screen that opens such a URL while it is not authenticated is redirected to the login page, and the parameter is dropped on the way back. Use the defaultViewport attribute for a screen that authenticates when it starts.