Category: Food and drink. Tags: Restaurants and cafes, Stores, Prices and rates, Countdowns and timers, QR codes.
Previews
Views and forms
Views: canvas, corner, chip. Canvas forms: landscape, portrait, square, strip.
Card views, themes and publishing. Browse the gallery.
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 |
|---|---|---|---|---|
currency | string | "$" | maxLength: 3 | |
unit | string | "" | maxLength: 8 | Shown after the price, for example /lb or each. |
layout | string | "split" | "split", "framed", "full" | split: the photo bleeds off one side. framed: the photo sits in the theme's frame. full: the photo fills the card under a veil. |
timeZone | string, null | null |
Dynamic properties
| Name | Type | Default | Values and limits | Description |
|---|---|---|---|---|
headline | string | "Smoky double stack" | maxLength: 120 | The item or offer, large. |
subline | string | "Two beef patties, melted cheddar and our house sauce." | maxLength: 200 | |
badge | string | "Limited time" | maxLength: 24 | |
price | number, null | null | minimum: 0 | Leave empty for a promo without a price. |
was | number, null | null | minimum: 0 | The old price, struck through; the saving is worked out. |
image | string | "" | maxLength: 200 | The photo: a project media reference (media:<id>). Empty shows the theme's tile. |
ends | string, null | null | ISO 8601 with an offset, or local YYYY-MM-DDTHH:MM in timeZone. Shows an ends-in countdown. | |
qr | string | "" | maxLength: 2000 | The address the QR code opens. Empty shows no code. |
cta | string | "Scan to order" | maxLength: 80 | The line beside the QR code. |
Canvas example
Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.
{
"id": "promo",
"primitive": "card",
"card": "promo",
"major": 1,
"params": {
"theme": "neomustard"
},
"rect": {
"x": 0,
"y": 0,
"width": 1920,
"height": 1080
},
"layer": 0,
"content_fit": "fill",
"data": "promo-main"
}Write live data
Create this document before showing the card, then replace it to update the screen without republishing. Use the same project as the playlist. Supply your API authorization through the environment; see API authentication.
curl --request PUT "https://api.screenrig.ai/api/card-data/promo-main" \
--header "Authorization: Bearer $SCREENRIG_TOKEN" \
--header "ScreenRig-Project: $SCREENRIG_PROJECT" \
--header "Content-Type: application/json" \
--data '{"document":{"headline":"Smoky double stack","subline":"Two beef patties, melted cheddar and our house sauce.","badge":"Limited time","price":null,"was":null,"image":"","ends":null,"qr":"","cta":"Scan to order"}}'