Displays: UI & Theming

UI & Theming

Configure the visual appearance of the HTML5 Display client, including window decorations, toolbar visibility, menu triggers, dark mode, floating elements, and browser title bar content. These query parameters are passed to the display client endpoint to customize the user interface for kiosks, dashboards, and embedded scenarios.

Access Display Client

`GET /api/v1/display/`

Serves the HTML5 Display client web interface with optional URL-based configuration. Use this endpoint for RESTful API compliance, versioned client access, and API gateway integrations.

curl -G "https://domain.com/api/v1/display/" \
  --data-urlencode "decorations=false" \
  --data-urlencode "toolbar=true" \
  --data-urlencode "menu=true" \
  --data-urlencode "dark_mode=true" \
  --data-urlencode "floating_menu=true" \
  --data-urlencode "clock=true" \
  --data-urlencode "title_show_hoody=true" \
  --data-urlencode "title_show_display_id=true"

const result = await client.display.accessClient({
  decorations: false,
  toolbar: true,
  menu: true,
  dark_mode: true,
  floating_menu: true,
  clock: true,
  title_show_hoody: true,
  title_show_display_id: true
});

<!DOCTYPE html>
<html>
<head><title>Hoody Display Client</title></head>
<body>
  <!-- Display HTML5 client interface -->
</body>
</html>

Parameters

Name	In	Type	Required	Description
`decorations`	query	boolean	No	Show window decorations (title bar with close/minimize/maximize buttons). Set to `false` for headless/kiosk mode. Default: `true`
`toolbar`	query	boolean	No	Show entire toolbar/menu area (menu trigger + menu). Set to `false` to hide all menu UI elements. Takes precedence over the `menu` parameter. Default: `true`
`menu`	query	boolean	No	Show Hoody menu trigger icon. Set to `false` to hide menu completely. Note: `toolbar` parameter takes precedence over this. Default: `true`
`dark_mode`	query	boolean	No	Enable dark mode theme. Default: `false`
`floating_menu`	query	boolean	No	Show floating menu. Default: `true`
`clock`	query	boolean	No	Show server clock. Default: `true`
`title_show_hoody`	query	boolean	No	Show “Hoody” in browser title. Default: `true`
`title_show_display_id`	query	boolean	No	Show display ID in browser title. Default: `true`

Response

<!DOCTYPE html>
<html>
<head><title>Hoody Display Client</title></head>
<body>
  <!-- Display HTML5 client interface -->
</body>
</html>

The HTML5 Display client interface is returned as text/html content.