Image

A static or synced image display. Can show SF Symbols, remote URLs, or synced image URLs.

Type

"image"

Relevant Fields

Inherits all Control Definition. Key fields:

Field Type Default Description
systemName string — SF Symbol name (fallback/placeholder)
url string — Static remote image URL
style string — "rounded" for rounded corners, "circle" for circular clipping
imageCornerRadius number — Custom corner radius
aspectRatio string — "fit" (scale to fit) or "fill" (scale to fill, may crop)
hideBackground bool false Remove glass background

Examples

SF Symbol placeholder (e.g., for camera feed)

{
  "type": "image",
  "id": "cam-front",
  "position": [0, 0],
  "span": [1, 2],
  "systemName": "video.fill"
}

Synced album artwork

{
  "type": "image",
  "id": "album-art",
  "position": [0, 0],
  "span": [3, 2],
  "systemName": "music.note.list",
  "style": "rounded",
  "imageCornerRadius": 8,
  "hideBackground": true,
  "sync": [{ "method": "meshsocket", "type": "listen", "event": "broadcast", "filter": { "msg_type": "player_state" }, "valuePath": "artwork_url" }]
}

Behavior

  • When synced, receives a URL string and loads the image from that URL
  • systemName renders as SF Symbol when no URL is available
  • Supports long-press groups for detail views