Pular para o conteúdo
Feedback

Result

/componentes/result.mdmarkdown cru, para quem lê com agent em vez de olho

Pedido confirmado, com o resumo

Confirmado · há instantes

Pedido confirmado

Enviamos o comprovante para o seu e-mail. A entrega sai amanhã.

Pedido
#20481
Entrega
Rua das Flores, 120
Total
R$ 189,90

Tons

Consulta agendada

O lembrete chega por e-mail e por SMS um dia antes.

Inscrição em análise

Respondemos em até dois dias úteis, por e-mail.

Importação parcial

38 de 40 contatos entraram. Os dois que faltam estão sem e-mail.

Recusado · 14:35

Pagamento recusado

Nada foi cobrado. Confira os dados do cartão ou tente outro.

No lugar do formulário

Página inteira de erro

Erro 500 · 14:32:08

Não conseguimos abrir esta página

A falha foi no nosso servidor, e não em algo que você fez. Sua última alteração ficou salva às 14h31.

Código do atendimento
RC-7F3A-91C2

Página que não existe, e sem permissão

Página 404 · /produto/cafe-1kg

Não encontramos esta página

O endereço pode ter mudado, ou o link veio incompleto. O seu carrinho continua do jeito que estava.

Acesso restrito · Relatório financeiro

Esta página existe, mas sua conta não abre ela

Você entrou como ana@exemplo.com.br, no papel Recepção. O relatório é dos papéis Gestão e Administração.

Importar
import { Result } from '@rivocode/ui'

Quando usar

O desfecho de um fluxo: o fim do checkout, o cadastro concluído, o pagamento confirmado, o formulário longo enviado, ou a falha em qualquer um deles. Ele toma o lugar do que a pessoa acabou de preencher e diz três coisas, nesta ordem: o que aconteceu, o que isso quer dizer, e para onde ir agora.

<Result
  meta="Confirmado · há instantes"
  title="Pedido confirmado"
  description="Enviamos o comprovante para o seu e-mail. A entrega sai amanhã."
  actions={
    <>
      <Button>Acompanhar pedido</Button>
      <Button variant="ghost">Continuar comprando</Button>
    </>
  }
>
  <DescriptionList variant="boxed">
    <DescriptionItem label="Pedido">#20481</DescriptionItem>
    <DescriptionItem label="Total">R$ 189,90</DescriptionItem>
  </DescriptionList>
</Result>

title é obrigatório e diz o fato em uma frase. description é o detalhe, e children é o miolo: o resumo em linhas, o protocolo. Os botões do próximo passo vão em actions, o principal primeiro. Um desfecho sem saída deixa a pessoa olhando para uma tela que já acabou.

meta é a linha de contexto acima do título, em fonte mono e tom discreto: a situação e a hora ("Confirmado · há instantes"), o código de um erro ("Erro 500 · 14:32"). Diz o que o título não diz. O resumo vai num DescriptionList com variant="boxed", que põe as linhas na própria caixa; não há peça de resumo à parte, porque rótulo e valor já são o DescriptionList.

Tons

tone escolhe o desfecho, e o símbolo muda junto com a cor, porque cor nunca é o único sinal: success (o padrão) desenha o check, info o i, warning a exclamação e danger o xis.

  • success: deu certo, e não há nada pendente.
  • info: deu certo, mas o resultado final depende de outra pessoa ("cadastro em análise").
  • warning: deu certo em parte. Diga o que faltou e onde está.
  • danger: não deu. Diga se algo foi cobrado ou salvo, que é a primeira pergunta de quem lê uma falha, e ofereça o caminho de tentar de novo.

Página inteira de erro

layout="page" é a tela inteira de 404, de sem permissão, de fora do ar ou de manutenção: alinhado ao início numa coluna de leitura, com título maior e o desenho no topo. illustration troca o disco do símbolo pelo desenho, e as nove do @rivocode/ui/illustrations foram feitas para isso:

import { ServerError } from '@rivocode/ui/illustrations'

<Result
  layout="page"
  titleAs="h1"
  tone="danger"
  illustration={<ServerError size="lg" />}
  meta="Erro 500 · 14:32:08"
  title="Não conseguimos abrir esta página"
  description="A falha foi no nosso servidor. Sua última alteração ficou salva às 14h31."
  actions={
    <>
      <Button>Tentar de novo</Button>
      <Button variant="secondary">Ir para o início</Button>
    </>
  }
>
  <DescriptionList variant="boxed">
    <DescriptionItem label="Código do atendimento">RC-7F3A-91C2</DescriptionItem>
  </DescriptionList>
</Result>

O desenho sai aria-hidden e o tone continua no data-tone, sem pintar nada. Não há peça ErrorPage à parte: a página de erro é o Result com layout="page". O código técnico (o 404, o identificador da requisição) vai no meta ou no resumo, para quem vai abrir chamado, e nunca no título.

Cada situação pede uma coisa, e a página diz o que aconteceu com o trabalho da pessoa:

  • 404: a culpa é nossa ("Não encontramos"), nunca "você digitou errado". Ofereça a busca e os atalhos das tarefas principais.
  • 500: diga se o que ela fazia foi salvo, ofereça tentar de novo e o código para o suporte. Sem piada: ela pode ter perdido trabalho.
  • 403: diga com qual conta ela entrou e quem pode abrir a página.
  • Sem internet: diga o que continua funcionando e o que sobe sozinho quando a conexão voltar.
  • Manutenção: um horário concreto de volta, e o que acontece com o que tem prazo. No servidor, a resposta é 503 com Retry-After.

Os blocos em /blocos têm as cinco montadas.

Movimento

Na montagem o disco cresce do centro (animate-pop) e, no success, o círculo se traça e o check se desenha por cima (animate-draw e animate-draw-late), em pouco mais de meio segundo. Os outros tons só crescem: falha e pendência não se comemoram. As durações são os tokens --rc-duration-slow e --rc-duration-effects, então com "reduzir movimento" o símbolo nasce pronto. animated={false} desliga numa instância.

Acessibilidade

O Result costuma aparecer porque a pessoa apertou "Concluir", e o botão que tinha o foco sumiu junto com o formulário. Por isso o foco vai para o título na montagem, e o leitor de tela lê o título e a descrição. O título sai num h2 com tabIndex={-1}: recebe foco por código e não entra na ordem do Tab. titleAs troca o nível, e h1 cabe quando o Result é a página inteira.

Não é role="status", de propósito: uma região viva que já nasce com o texto dentro costuma não ser lida, e o foco ficaria perdido no corpo da página.

focusOnMount={false} desliga, e é o certo quando há mais de um na tela ou quando ele não é a resposta a uma ação da pessoa: uma vitrine, uma página de documentação, o estado que já estava lá quando a tela abriu.

Partes

classNames alcança cada nó pelo nome: icon (o disco do símbolo, ou a caixa da illustration), meta, title, description, content (a caixa do children) e actions.

Quando não usar

  • Ação pequena (salvar um campo, copiar uma chave, arquivar uma linha) é Toast, pelo useToast e o ToastViewport. O Toast passa e a pessoa continua onde estava; o Result toma a tela e encerra o fluxo.
  • Falta de dado é EmptyState. O EmptyState olha para o que ainda não existe e oferece criar; o Result olha para o que acabou de acontecer.
  • Erro ao carregar uma lista é QueryBoundary. Ele cuida do carregando, do erro com "Tentar de novo" e do vazio de uma consulta; o Result com danger é para o fluxo que a pessoa conduziu e que falhou no fim.
  • Aviso dentro da página é Alert. O Alert mora junto do conteúdo e deixa trabalhar; o Result é o conteúdo.

No React Native

Traduz com os mesmos tons, o mesmo layout, o mesmo actions e as mesmas seis partes de classNames: icon, meta, title, description, content e actions. title, description e meta são string, porque moram dentro de um Text, e o meta entra no anúncio depois do título. No layout="page" as ações continuam na largura toda, que é o alvo de toque do celular.

O foco no título vira anúncio. No web o título recebe o foco ao montar; no celular o caminho que funciona igual no iOS e no Android é falar, então announceOnMount (padrão true) lê o título e a descrição uma vez, quando o Result aparece. Desligue quando há mais de um na tela, como o focusOnMount do web. O título sai como cabeçalho, sem titleAs: o leitor de tela do celular não anuncia nível.

O símbolo não se traça, cresce. É o ícone do lucide-react-native de cada tom (CircleCheck, Info, CircleAlert e CircleX) sobre o disco, e a animação é a do react-native-reanimated, que já é peer: o disco cresce do centro em slow, e no success o check cresce por cima logo depois, com o atraso de effects. Com "reduzir movimento", ou animated={false}, nasce pronto.

API

PropTipoPadrão
titleobrigatória

O que aconteceu, em uma frase: "Pedido confirmado", "Pagamento recusado".

ReactNodesem padrão
actions

Os botoes do proximo passo, embaixo de tudo: centrados no `inline`, no inicio no `page`.

ReactNodesem padrão
animated

Anima o simbolo na montagem: o disco cresce do centro e, no `success`, o circulo e o check se tracam por cima, em pouco mais de meio segundo.

booleantrue
classNames

Classe por parte: `icon` (o disco do simbolo, ou a caixa da `illustration`), `meta`, `title`, `description`, `content` (a caixa do `children`) e `actions`.

Partial<Record<"actions" | "content" | "description" | "icon" | "meta" | "title", string>>sem padrão
description

O detalhe e o que fazer a seguir.

ReactNodesem padrão
focusOnMount

Leva o foco ao titulo na montagem, e o leitor de tela le o titulo e a descricao.

booleantrue
illustration

Desenho no lugar do disco do simbolo, para a pagina inteira de erro ou de estado: o 404, o sem permissao, o fora do ar.

ReactNodesem padrão
layout

`inline` toma o lugar de um formulario ou de um cartao: centrado, com o simbolo do tom.

ResultLayout"inline"
meta

A linha de contexto acima do titulo, em fonte mono e tom discreto: a situacao e a hora ("Confirmado - ha instantes"), o codigo do erro ("Erro 500 - 14:32").

ReactNodesem padrão
titleAs

Em que nivel o titulo sai.

"h1""h2""h3""h2"
tone

O desfecho, e a cor e o simbolo que saem dele: `success` desenha o check, `info` o i, `warning` a exclamacao e `danger` o xis.

ResultTone"success"

Além destas, a peça aceita className, style, id e children, repassados ao elemento de baixo.

@rivocode/ui, 149 peças no catálogo. Esta página é gerada dos mesmos arquivos que alimentam o design system, então ela não envelhece sozinha.

Feito por RivoCode.