Cartão de etapas

Mostrar instruções numeradas com uma ação clara a seguir e um destaque sincronizado em andamento.

Lidere com a instrução atual e mantenha a sequência completa visível. Defina um passo diretamente pelo armazenamento de dados ou deixe o destaque percorrer a sequência em um relógio compartilhado.

Cartão ao vivo

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

Categoria: Mensagens. Etiquetas: Saguões e recepção, Escritórios e locais de trabalho, Orientação e diretórios.

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"How it works"maxLength: 60
startsAtstring""maxLength: 40Instante ISO que ancora o ciclo automático. Vazio ou inválido usa a época Unix, para que as telas fiquem sincronizadas.
stepSecondsinteger12mínimo: 5; máximo: 120
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
stepsarray[]minItems: 0; maxItems: 8
steps[].titlestringminLength: 1; maxLength: 80; Obrigatório
steps[].bodystring""maxLength: 240
activeStepinteger0mínimo: 0; máximo: 8Destaque manual baseado em um; zero percorre a lista no relógio compartilhado. Um valor além da lista seleciona o último passo.
changedAtstring""maxLength: 40Instante ISO para uma mudança manual de passo. Seu breve destaque Primetime nunca é reproduzido ao carregar.
footerstring""maxLength: 120

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 steps --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": "steps",
  "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:

{
  "steps": [],
  "activeStep": 0,
  "changedAt": "",
  "footer": ""
}
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":{"steps":[],"activeStep":0,"changedAt":"","footer":""}}'