Displays: UI and Theming

Configure the visual chrome of the HTML5 Display client through URL query parameters. Use these parameters to hide decorations, toggle the menu and toolbar, switch to dark mode, control the floating menu and clock, and customize the browser title bar. All parameters are passed in the query string when accessing the client.

Access Display Client with UI settings

`GET /api/v1/display/`

Serves the HTML5 Display client web interface. The query parameters below control window decorations, menu and toolbar visibility, dark mode, the floating menu, the clock, and the browser title bar.

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 or kiosk mode. Default: `true`
`toolbar`	query	boolean	No	Show entire toolbar and menu area (menu trigger plus menu). Set to `false` to hide all menu UI elements. Takes precedence over `menu`. Default: `true`
`menu`	query	boolean	No	Show Hoody menu trigger icon. Set to `false` to hide the menu completely. Note: `toolbar` takes precedence over this parameter. 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

The HTML5 Display client interface is loaded successfully.

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

curl "https://{projectId}-{containerId}-display-1.{server}.containers.hoody.com/api/v1/display/?decorations=false&toolbar=false&menu=false&dark_mode=true&title_show_hoody=true&title_show_display_id=false"

import { HoodyClient } from 'hoody-sdk';

const hoody = await HoodyClient.login('https://api.hoody.com', { username, password });
const box = await hoody.withContainer(containerId);

// Builds the URL of display 1; nothing is fetched. Open it in a browser or a frame.
const url = box.embeds.display.client(undefined, {
  index: 1,
  params: { decorations: false, toolbar: false, menu: false, dark_mode: true, title_show_hoody: true, title_show_display_id: false },
});