Web Client

The web client is the web UI in the browser with panel list, panels, and singled out slots. If you open the URL of a Boomack Server in the browser, you see the panel list. From there you can navigate to the panels. From a panel you can navigate back to the panel list with the home button in the panel header. Additionally, you can single-out a slot with the single-out button, if its toolbar is visible. That opens the slot in a new browser tab without the panel header or other slots.

Web Client URLs ↑

• Panel List: /
  The homepage with the panel list.
• Panel: /panels/<panel ID>
  A single panel.
• Slot: /panels/<panel ID>/slots/<slot ID>
  A singled-out slot.
• Panel Export: /panels/<panel ID>/export.zip
  A ZIP file with a single panel exported as static HTML web site.

Query Parameters ↑

When creating bookmarks or opening a Boomack panel/slot with a script, you can add query parameters to the URLs to adjust the appearance and behavior of the panel/slot.

Theme ↑

The color theme.

• Parameter: theme
• Type: string
• Values: A theme ID like default, or dark
• Application: Panel List, Panel, Slot, Panel Export

Example: http://127.0.0.1:3000/panels/default?theme=iron

Zoom ↑

A page wide CSS scale transformation.

• Parameter: zoom
• Type: number
• Values: 1.0 for 100%
• Application: Panel, Slot, Panel Export

Example: http://127.0.0.1:3000/panels/default?zoom=1.5

Header ↑

A switch to hide the panel header. Can not show the header, if it is hidden in the panel layout.

• Parameter: header
• Type: boolean
• Value: 0, 1, true, false
• Application: Panel, Panel Export

Example: http://127.0.0.1:3000/panels/default?header=0

Logo ↑

A switch to hide the logo in the panel header. Can not show the logo, if it is hidden in the panel layout.

• Parameter: logo
• Type: boolean
• Value: 0, 1, true, false
• Application: Panel, Panel Export

Example: http://127.0.0.1:3000/panels/default?logo=0

Header Tools ↑

A switch to hide the toolbar in the panel header. Can not show the tools, if they are hidden in the panel layout.

• Parameter: header-tools
• Type: boolean
• Value: 0, 1, true, false
• Application: Panel

Example: http://127.0.0.1:3000/panels/default?header-tools=0

Slot Toolbars ↑

A switch to hide all slot toolbars in a panel. Can not show toolbars, which are hidden in the slot definition.

• Parameter: toolbars
• Type: boolean
• Value: 0, 1, true, false
• Application: Panel, Panel Export

Example: http://127.0.0.1:3000/panels/default?toolbars=0

A switch to hide the toolbar of an individual slot. Can not show the toolbar, if it is hidden in the slot definition.

• Parameter: toolbar
• Type: boolean
• Value: 0, 1, true, false
• Application: Slot

Example: http://127.0.0.1:3000/panels/default/slots/main?toolbar=0

Slot Tools ↑

A switch to hide all tool buttons from the slot toolbars.

• Parameter: tools
• Type: boolean
• Value: 0, 1, true, false
• Application: Panel, Slot, Panel Export

Example: http://127.0.0.1:3000/panels/default?tools=0

Update Mode ↑

The update mode for a panel or slot.

• Parameter: update
• Type: string
• Values: always, auto, or never
• Application: Panel, Slot

The modes have the following meaning:

• always
  The web client updates the slots content automatically. If the browser window or tab is hidden, the display commands are queued by the browser in memory and are processed when the panel is visible again. This can lead to high memory consumption by the browser.
• auto
  The web client updates the slots content automatically as long as the panel is visible. The web client stops the updates when the browser window or tab is hidden. If it is visible again, the web client requests the latests content for the slots and starts updating automatically again. This mode is helpful when updates are frequent and possibly contain large amounts of embedded data, like embedded images.
• never
  The web client does not update the slots content.

Example: http://127.0.0.1:3000/panels/default/slots/default?update=always

Offline ↑

Simulate rendering for export. Deactivates all interactive tools and the connection to the Boomack Server.

• Parameter: offline
• Type: boolean
• Value: 0, 1, true, false
• Application: Panel, Slot

Example: http://127.0.0.1:3000/panels/default?offline=1