Cartão do quadro de menu

Um cardápio que se ajusta sozinho: seções, preços com linhas finas, marcas dietéticas e itens esgotados, fluindo em quantas colunas forem necessárias.

Divida em seções de pratos, cada uma com um preço ou um rótulo como MP, uma descrição opcional, etiquetas dietéticas e uma indicação de esgotado. O quadro define o maior tipo que cabe: um menu curto fica grande e centralizado, três pratos ou menos são destacados, e um menu longo flui em colunas e muda de página sozinho, cada seção contínua mantendo seu nome. Nomes e descrições quebram nas palavras, preços alinham-se em uma coluna à direita, e uma nota de rodapé traz as letras miúdas.

Cartão ao vivo

Este cartão é desenhado no seu navegador pelo mesmo código que os Players executam, com dados de exemplo.

Categoria: Alimentação e bebida. Etiquetas: Restaurantes e cafés, Preços e tarifas, Escolas e campi, Bares e pubs.

Layouts

Este cartão em tela cheia preenche toda a tela em paisagem ou retrato e não é colocado como canto, chip ou faixa.

Layouts: cheio. Formas: paisagem, retrato.

Layouts, temas e publicação de cartões. Veja os cartões.

Dados e privacidade

Este cartão usa suas propriedades configuradas e dados ao vivo do cartão.

Propriedades

Para tema, fundo, destaque e posição, veja Propriedades comuns.

Defina as propriedades estáticas nos params do cartão ao criá-lo. O documento de dados dele contém apenas propriedades dinâmicas. Linhas aninhadas descrevem o conteúdo da propriedade pai.

Propriedades estáticas

NomeTipoPadrãoValores e limitesDescrição
titlestring""maxLength: 60
currencystring"$"maxLength: 4
decimalsnúmero, string"auto""auto", 0, 1, 2auto mostra preços inteiros sem decimais quando todos os preços são inteiros, caso contrário dois.
columnsnúmero, string"auto""auto", 1, 2, 3
specialLabelstring"Today's special"maxLength: 30Mantido para compatibilidade; a visualização completa não exibe introdução.
pageSecondsinteger12mínimo: 5; máximo: 120Quando o menu precisa de mais de uma página, as páginas viram no relógio de parede.
backgroundColorstring, nulonullpadrão: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"Substitui o fundo e a placa do cartão por uma cor plana ordenada por CSS. #RRGGBBAA fornece opacidade. background none tem precedência.
textColorstring, nulonullpadrão: "^#[0-9A-Fa-f]{6}([0-9A-Fa-f]{2})?$"Substitui as cores do texto principal e secundário. As cores de destaque e status semântico mantêm seus papéis.

Propriedades dinâmicas

NomeTipoPadrãoValores e limitesDescrição
sectionsarrayminItems: 1; maxItems: 8; Obrigatório
sections[].namestringmaxLength: 40; Obrigatório
sections[].notestring""maxLength: 80
sections[].itemsarrayminItems: 1; maxItems: 24; Obrigatório
sections[].items[].namestringmaxLength: 60; Obrigatório
sections[].items[].descriptionstring""maxLength: 120
sections[].items[].pricenúmero, nulonullmínimo: 0
sections[].items[].priceLabelstring""maxLength: 12Mostrado em vez do preço, por exemplo MP.
sections[].items[].tagsarray[]maxItems: 6
sections[].items[].soldOutbooleanfalse
footnotestring""maxLength: 140

Exemplo de tela

Salve as propriedades estáticas como params.json e crie o cartão. O resultado traz o id crd_ dele.

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

Adicione este item aos primitives de uma página da playlist, com esse id no lugar do id do exemplo. Publique a playlist e atribua uma tela.

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

Escrever dados ao vivo

Escreva o documento no cartão depois de criá-lo e depois substitua-o para atualizar a tela sem republicar. O cartão verifica cada gravação contra suas propriedades dinâmicas e recusa um documento que ele rejeita. Use o mesmo projeto da playlist.

Salve o documento como card-data.json. O CLI lê o documento em si, sem invólucro:

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

Ou chame a API diretamente. A API envolve o mesmo documento em um campo document. Um token de agente já nomeia seu projeto, então nenhum cabeçalho de projeto é enviado; se você enviar ScreenRig-Project, ele deve corresponder ao projeto do token. Forneça sua autorização de API pelo ambiente; veja Autenticação da 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":""}}'