Smash card

One to four huge words blast onto the screen for a sale, an opening or a big moment.

One to four words in capitals fill the screen and hang there, breathing. Style picks the entry: slam crashes letters in, whip whips bars in, burst pops a starburst, and cut smash-cuts from word to word. For a sale or a doors-open call, set at for an exact moment so screens blast together, and use | to join a phrase (GRAND OPENING|THIS SATURDAY). It fills landscape, portrait, square and strips in nine themes, its text changes live, and reduced motion shows the still frame.

Live card

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

Category: Messages. Tags: Stores, Lobbies and reception, Events and venues.

Layouts

This fullscreen card fills the whole screen in landscape or portrait and is not placed as a corner, chip, or strip.

Layouts: full. 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

NameTypeDefaultValues and limitsDescription
stylestring"slam""slam", "whip", "burst", "cut"How the words arrive: slam crashes them in letter by letter, whip drives each word in on its own bar, burst pops them out of a starburst, cut smash-cuts from word to word. They then hang, breathing, until the page ends.

Dynamic properties

NameTypeDefaultValues and limitsDescription
textstring"SMASH"maxLength: 80One to four words, set in capitals. Separate phrases with | to keep words together.
atstring, nullnullmaxLength: 40An ISO instant. Every screen plays the blast at that instant, together; without it the blast plays when the card appears.

Canvas example

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

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

{
  "text": "SMASH",
  "at": 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":{"text":"SMASH","at":null}}'