List card

Rows in order sit under an optional heading, each with a mark or icon and any value aligned on the right, so it reads at a glance from across a room. It fills the whole screen, fits any rectangle, sits in the middle, tucks into a corner, shows one row at a time on one line in a corner, or crawls as a band along an edge. You choose the heading, the rows with their text, values and icons, the mark before each row as a dot, dash, number, check box or nothing and whether a checked row is done, how long each page or single row stays, and whether the card is raised or lowered.

Live card

Category: Messages. Tags: Offices and workplaces, Lobbies and reception.

Layouts

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

Layouts: full, free, center, corner, chip, strip. Forms: landscape, portrait, square, strip.

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

Dynamic properties

Canvas example

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

{
  "id": "list",
  "primitive": "card",
  "card": "list",
  "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:

{
  "title": "",
  "rows": [],
  "active": true,
  "since": null
}

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":{"title":"","rows":[],"active":true,"since":null}}'