Cartão de almoço escolar

Refeição escolar de hoje com marcas de alérgenos e os dias seguintes: prato principal em destaque, acompanhamentos listados, uma chave para as marcas.

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: Escolas e campi, Restaurantes e cafés.

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

Feed: screenrig.lunch/v1.

Documentos do feed carregam atribuição da fonte. O Player fornece o feed para o 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: 40Vazio lê Almoço escolar (Café da manhã escolar, Lanche escolar).
schoolstring""maxLength: 60Mostrado ao lado do título. O nome da escola do feed o preenche quando vazio.
mealstring"lunch""breakfast", "lunch", "snack"
countinteger4mínimo: 1; máximo: 6Dias listados após o dia em destaque.
showAllergensbooleantrueMarcas de alérgenos e dietas e sua chave.
timeZonestring, nulonull
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
daysarray[]minItems: 0; maxItems: 31O cardápio por dia. Um feed (screenrig.lunch/v1) prevalece quando presente; o armazenamento de dados fornece as mesmas linhas caso contrário.
days[].datestringmaxLength: 10; ObrigatórioYYYY-MM-DD na zona da tela.
days[].closedbooleanfalseSem refeição neste dia (feriado, sem aula).
days[].notestringmaxLength: 80Mostrado no dia: Dia da pizza, ou por que não há aula.
days[].itemsarraymaxItems: 12A refeição em ordem; o primeiro item é o prato principal.
days[].items[].namestringminLength: 1; maxLength: 60; Obrigatório
days[].items[].allergensarraymaxItems: 10leite, ovo, peixe, crustáceos, nozes, amendoim, trigo, soja, gergelim. Cada um aparece como uma marca de duas letras.
days[].items[].dietstring"vegetarian", "vegan"Mostra uma marca V ou VG.
days[].mealsarraymaxItems: 4As refeições de um feed para o dia; o cartão escolhe uma refeição. Sem refeições, são usados os itens do dia.
days[].meals[].kindstring"breakfast", "lunch", "snack"; Obrigatório
days[].meals[].itemsarraymaxItems: 12; Obrigatório
days[].meals[].items[].namestringminLength: 1; maxLength: 60; Obrigatório
days[].meals[].items[].allergensarraymaxItems: 10leite, ovo, peixe, crustáceos, nozes, amendoim, trigo, soja, gergelim. Cada um aparece como uma marca de duas letras.
days[].meals[].items[].dietstring"vegetarian", "vegan"Mostra uma marca V ou VG.

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 school-lunch --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": "school-lunch",
  "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:

{
  "days": []
}
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":{"days":[]}}'