Pular para o conteúdo
Feedback

Alert

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

Com ícone

Prazo alterado

A entrega passou de 12/09 para 19/09.

Consulta confirmada

O lembrete foi enviado para o e-mail do paciente.

Que a pessoa dispensa

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

Quando usar

Aviso que fica na tela.

Compõe com AlertTitle e AlertDescription.

O papel de acessibilidade vem do tom: danger e warning interrompem o leitor de tela, success e info esperam a pessoa terminar a frase. Interromper alguém para dizer "salvo com sucesso" é falta de educação com quem depende do leitor.

O ícone tem lugar próprio

Cor nunca é o único sinal. Sem ícone, os quatro tons são quatro caixas idênticas de forma, separadas só pelo matiz. E quem não distingue vermelho de verde é uma fatia grande de qualquer base de usuários, sem contar a impressão em preto e branco.

O ícone do tom sai sozinho, na cor do tom, numa coluna própria antes do texto e alinhado com a primeira linha. O título e a descrição ficam em fg e fg-muted: o tom aparece no fundo e no ícone, e não no texto. Para trocar o símbolo, passe a prop icon; para nenhum, icon={null}:

<Alert tone="warning">
  <AlertTitle>Cartão vence em 8 dias</AlertTitle>
  <AlertDescription>Atualize antes de 01/09 para não interromper a assinatura.</AlertDescription>
</Alert>

O par canônico do lucide, o mesmo da tabela de ícones da casa: Info para info, CheckCircle2 para success, TriangleAlert para warning, CircleX para danger. Ele sai aria-hidden: o texto ao lado já diz o que ele desenha, e o role da raiz já diz a urgência. Anunciá-lo de novo seria dizer a mesma coisa duas vezes.

Que a pessoa dispensa

onDismiss liga o xis no canto direito, com nome acessível ("Fechar aviso", ou o que labels.dismiss disser).

Quem some com o aviso é quem chamou. A peça não guarda estado nenhum, pelo mesmo motivo de ela não ter open: um aviso que se apaga sozinho é Toast, e o Alert existe justamente para o que fica na tela.

const [open, setOpen] = useState(true)

{open && (
  <Alert tone="warning" icon={<TriangleAlert />} onDismiss={() => setOpen(false)}>
    <AlertTitle>Cartão vence em 8 dias</AlertTitle>
    <AlertDescription>Atualize antes de 01/09.</AlertDescription>
  </Alert>
)}

Sem onDismiss não há botão, que continua sendo o padrão: aviso que a pessoa pode dispensar é o caso, e não a regra. O que bloqueia uma ação não se dispensa. Tirá-lo da tela é resolver o que ele aponta.

Movimento

O aviso entra na montagem: esmaece e sobe 4px em --rc-duration-base (animate-enter). É o que faz o aviso que chega depois de uma ação ser visto chegando. Roda uma vez, e não repete a cada re-render; com "reduzir movimento", aparece parado. className="animate-none" desliga numa instância.

Quando não usar

Para a confirmação do que acabou de acontecer (consulta confirmada, arquivo enviado), use useToast(). O aviso de toast passa; este fica. Um "salvo com sucesso" que mora no fluxo da página ainda está lá quando a pessoa volta dez minutos depois, e ela lê aquilo como o estado de agora.

O contrário também vale, e é o erro mais caro dos dois: informação que a pessoa precisa ter na tela enquanto trabalha (o motivo de um campo estar bloqueado, a pendência que impede matricular) não pode ser um toast, porque ele some antes de ela chegar na parte em que aquilo importa.

E erro de campo não é nenhum dos dois: pertence ao campo que errou, via FieldError, onde a pessoa está olhando e pode corrigir.

No React Native

Traduz: o @rivocode/ui-native exporta Alert - title é prop e o corpo é filho: texto sai embrulhado, e outro nó (o Button de ação) entra como está; sem AlertTitle/AlertDescription; icon, onDismiss e labels como no web, e o ícone também entra por função, na cor do tom. Sem ícone padrão, porque o pacote não traz biblioteca de ícone, e por isso o título continua na cor do tom: sem ele, a cor seria o único sinal. A API não é a mesma do web (no nativo tudo é controlado), e a tabela de paridade diz o que muda peça a peça.

API

PropTipo
icon

O simbolo a esquerda do texto, na cor do tom.

ReactNode
labels

Os textos da peca, para trocar o idioma: `dismiss` e o nome do xis, "Fechar aviso" sem ele.

Partial<AlertLabels>
onDismiss

Liga o xis que fecha o aviso, no canto direito.

(() => void)
tone0.4.0"danger""info""success""warning"null

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

Partes

Alert se monta com estas peças. Todas vivem nesta página, porque separar cada uma num endereço obrigaria a abrir seis abas para montar uma tela.

AlertDescription

/alert-description.md

O detalhe abaixo do título: o que fazer a respeito.

Usa texto de apoio, um degrau abaixo do título. Aviso que só repete o título com outras palavras não precisa dela.

Sem prop própria: repassa ao elemento de baixo o que você mandar.

AlertTitle

/alert-title.md

A primeira linha do aviso: o que aconteceu, em uma frase.

Sai como <p> e não como <h*> de propósito, um aviso no meio da tela não entra no sumário da página, e um heading fora de ordem atrapalha quem navega por headings no leitor de tela.

Sem prop própria: repassa ao elemento de baixo o que você mandar.

@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.