菜单板卡片

自动设置的菜单板:分区、带细线规则的价格、饮食标记和售罄项目,流式布局至所需列数。

为菜品分区,每个区带有价格或如 MP 的标签、可选描述、饮食标签和售罄标志。看板设置最大适配字体:短菜单居中且字体大,三道菜或更少作为特色展示,长菜单则分栏显示并自动翻页,每个延续的分区保留其名称。名称和描述按词换行,价格右对齐,脚注显示小字说明。

直播卡片

此卡由浏览器绘制,使用与播放器相同的代码,带示例数据。

类别:食品和饮料。标签:餐厅和咖啡馆,价格和费率,学校和校园,酒吧和酒馆。

布局

此全屏卡在横屏或竖屏时填满整个屏幕,不作为角落、芯片或条带放置。

布局:全屏。表单:横向,纵向。

卡片布局、主题和发布。浏览卡片。

数据与隐私

此卡使用其配置的属性和实时卡数据。

属性

有关主题、背景、强调色和位置,请参见通用属性。

创建卡片时,在卡片的params中设置静态属性。其数据文档仅包含动态属性。嵌套行描述其父属性的内容。

静态属性

名称类型默认数值和限制描述
titlestring""maxLength:60
currencystring"$"maxLength:4
decimals数字,字符串"auto""auto", 0, 1, 2当所有价格均为整数时,自动显示整数价格,否则显示两位小数。
columns数字,字符串"auto""auto", 1, 2, 3
specialLabelstring"Today's special"maxLength:30为兼容性保留;全视图不绘制引导。
pageSecondsinteger12最小值:5;最大值:120菜单需要多页时,按挂钟时间翻页。
backgroundColor字符串,空值null模式:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"用纯色 CSS 顺序覆盖卡片背景和底板。#RRGGBBAA 提供透明度。背景无则优先。
textColor字符串,空值null模式:"^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"覆盖主文本和次要文本颜色。强调色和语义状态色保持原有功能。

动态属性

名称类型默认数值和限制描述
sectionsarrayminItems:1;maxItems:8;必填
sections[].namestringmaxLength:40;必填
sections[].notestring""maxLength:80
sections[].itemsarrayminItems:1;maxItems:24;必填
sections[].items[].namestringmaxLength:60;必填
sections[].items[].descriptionstring""maxLength:120
sections[].items[].price数字,空值null最小值:0
sections[].items[].priceLabelstring""maxLength:12存在时替代价格显示,例如 MP。
sections[].items[].tagsarray[]maxItems:6
sections[].items[].soldOutbooleanfalse
footnotestring""maxLength:140

画布示例

将静态属性保存为 params.json 并创建卡片。结果中包含它的 crd_ ID。

{
  "theme": "neomustard"
}
screenrig card create --type menu --major 1 --file params.json

将此项目添加到播放列表页面的primitives中,并用该 ID 替换示例中的 ID。发布播放列表并分配屏幕。

{
  "id": "menu",
  "primitive": "card",
  "card": "crd_01EXAMPLECARD000000000",
  "layout": "full",
  "content_fit": "fill"
}

写入实时数据

创建卡片后向其写入文档,之后替换该文档即可更新屏幕,无需重新发布。卡片会按其动态属性检查每次写入,并拒绝它不接受的文档。请使用与播放列表相同的项目。

将文档保存为card-data.json。CLI直接读取文档,无需包装:

{
  "sections": [
    {
      "name": "Example",
      "items": [
        {
          "name": "Example"
        }
      ]
    }
  ],
  "footnote": ""
}
screenrig card data put crd_01EXAMPLECARD000000000 --file card-data.json

或直接调用 API。API 将相同文档包装在 document 字段中。智能体令牌已指定其项目,因此不发送项目头;若发送 ScreenRig-Project,必须与令牌项目匹配。通过环境提供 API 授权;详见 API 认证。

curl --request PUT "https://api.screenrig.ai/api/cards/crd_01EXAMPLECARD000000000/data" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"sections":[{"name":"Example","items":[{"name":"Example"}]}],"footnote":""}}'