Displays: UI & Theming

Use these query parameters with the Display client endpoint to control the user interface: window decorations, toolbar visibility, menu trigger, dark mode, floating menu, clock display, and the browser title bar composition. These settings are useful for kiosk deployments, read-only dashboards, branded client experiences, and clean demo setups.

Access the HTML5 Display client interface

`GET /api/v1/display/`

Serves the HTML5 Display client web interface with optional URL-based configuration. This is the standardized API version of the root client endpoint. The parameters documented here control UI surface and theming only; connection, encoding, input, and debugging parameters are covered on separate pages.

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. The `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`

curl -G "https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com/api/v1/display/" \
  --data-urlencode "decorations=false" \
  --data-urlencode "toolbar=false" \
  --data-urlencode "dark_mode=true" \
  --data-urlencode "floating_menu=false" \
  --data-urlencode "clock=false" \
  --data-urlencode "title_show_hoody=false" \
  --data-urlencode "title_show_display_id=false"

import { HoodyClient } from 'hoody-sdk';

const client = new HoodyClient({ baseURL: 'https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com', token: process.env.HOODY_TOKEN });

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

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