Icon card

A large symbol from the toolkit set appears on screen with an optional label, big and clear enough to read at a glance from across a room. It tucks into a corner or runs as one line. You choose the symbol from the toolkit set, the short label beside or under it, the colour tone, and a status signal such as ok or open, watch, alarm or information.

Live card

Category: Operations. Tags: Wayfinding and directories, Lobbies and reception.

Layouts

This core card fits every layout: full screen, center, corner, chip, strip, or any free rectangle.

Layouts: corner, chip. Forms: square.

Card layouts, themes and publishing. Browse the cards.

Data and privacy

This card uses its configured properties and live card data.

Properties

For theme, background, accent and position, see Common properties.

Set static properties in params. Bind data to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in params. Nested rows describe the contents of their parent property.

Static properties

This card has no static properties.

Dynamic properties

Canvas example

Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.

{
  "id": "icon",
  "primitive": "card",
  "card": "icon",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "example-key"
}

Write live data

The canvas example binds its data field to example-key. That value is a data key: a name this canvas item chooses, not the name of the card. Give each canvas item its own key when items should show different data, or share one key when they should show the same data. Keys are scoped to the project, follow the K/V key grammar, and cannot start with feed:.

Create this document before showing the card, then replace it to update the screen without republishing. Writes to a key that live canvas items bind are checked against each bound card’s dynamic properties. Use the same project as the playlist.

Save the document as card-data.json. The CLI reads the document itself, with no wrapper:

{
  "icon": "information-circle",
  "label": "",
  "tone": "text"
}

screenrig card-data put example-key --file card-data.json

Or call the API directly. The API wraps the same document in a document field. An agent token already names its project, so no project header is sent; if you send ScreenRig-Project, it must match the token’s project. Supply your API authorization through the environment; see API authentication.

curl --request PUT "https://api.screenrig.ai/api/card-data/example-key" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"icon":"information-circle","label":"","tone":"text"}}'