Text card

An optional eyebrow and title sit above the main body with a quiet footer below, in a clear order that reads easily from across a room. It fills the screen, sits in the middle, tucks into a corner, shrinks to one line in a corner or runs as a band along an edge, with only the body left at the smallest size. You set the eyebrow, the title, the main body and the footer, and you choose whether the words sit at the start or in the middle.

Live card

This card is drawn in your browser by the same code the Players run, with sample data.

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, 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

Name	Type	Default	Values and limits	Description
`align`	string	`"start"`	`"start"`, `"center"`	Where the text sits across the box.

Dynamic properties

Name	Type	Default	Values and limits	Description
`eyebrow`	string	`""`	maxLength: `40`	A short label above the title, in the theme's tag.
`title`	string	`""`	maxLength: `120`
`body`	string	`""`	maxLength: `400`	The main text. At chip size it is all that is left.
`footer`	string	`""`	maxLength: `120`	A quiet line at the foot: a source, a date, a credit.
`active`	boolean	`true`		False lowers the card: it leaves and draws nothing until it is raised again.
`since`	string, null	`null`		ISO 8601 instant `active` last changed. Raised, the card waits for it when it is still ahead; lowered, the card stays up for a few seconds after it.

Canvas example

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

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

{
  "eyebrow": "",
  "title": "",
  "body": "",
  "footer": "",
  "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":{"eyebrow":"","title":"","body":"","footer":"","active":true,"since":null}}'