Callouts
Saiba como usar os componentes Note, Tip, Warning, Danger, Check e Callout personalizado para destacar informações importantes na sua documentação.
Use Callouts para destacar contexto importante, como avisos, dicas ou requisitos, sem interromper o fluxo de leitura.
Avisos disponíveis
Note: Contexto útil ou informações adicionais.
Info: Informações neutras ou fatos. Use para detalhes complementares.
Tip: Abordagens recomendadas ou otimizações.
Warning: Ressalvas ou requisitos importantes. Use quando ignorar algo puder causar problemas.
Danger: Avisos críticos. Use para ações que possam causar perda de dados ou problemas de segurança.
Check: Confirmações de sucesso. Use para confirmar comportamento correto ou conclusão bem-sucedida.
Uso
<Note>
This is helpful context for the reader.
</Note>
<Warning>
This could cause issues if you skip this step.
</Warning>
<Danger>
This action cannot be undone. Proceed with caution.
</Danger>
Com títulos
Adicione um título personalizado a qualquer callout:
<Note title="Did you know?">
You can use **Markdown** inside callouts, including `code` and [links](/introduction).
</Note>
Você pode usar Markdown dentro de callouts, incluindo code e links.
Com blocos de código
Callouts podem conter código:
A assinatura da função getData() mudou:
// Before (v1.x)
getData(id)
// After (v2.0)
getData({ id, options })Práticas recomendadas
Callouts em excesso diluem seu impacto. Procure usar no máximo 1 a 2 por página.
Reserve os callouts para informações que o leitor não pode deixar passar.
| Cenário | Callout |
|---|---|
| Dica útil | <Tip> |
| Contexto extra | <Note> ou <Info> |
| Possível armadilha | <Warning> |
| Ação irreversível | <Danger> |
| Confirmação | <Check> |
| Identidade visual personalizada | <Callout> |
Mantenha os callouts fáceis de escanear. Use um Accordion para vários parágrafos.
Bom: Uma ou duas frases Evite: Vários parágrafos de texto
Coloque os callouts:
- Antes de código que tenha requisitos
- Depois de instruções com ressalvas importantes
- Perto do conteúdo a que se referem
Propriedades
Todo callout aceita estas props:
stringTítulo personalizado (substitui o padrão).
Acessibilidade
Os callouts usam HTML semântico e roles ARIA:
- Leitores de tela anunciam o tipo do callout
- A cor não é o único indicador (ícones estão incluídos)
- Contraste de cor suficiente no modo escuro
Aviso personalizado
Defina um ícone e uma cor personalizados com o componente Callout:
Custom: Use qualquer ícone e cor para combinar com seu conteúdo.
Publique suas alterações com confiança usando nosso pipeline de CI/CD.
Use prefixos de estilo de ícone como regular/, light/ ou duotone/ para diferentes espessuras.
Uso de avisos personalizados
<Callout icon="key" color="#FFC107">
This callout uses a key icon with amber color.
</Callout>
<Callout icon="rocket" color="#9333EA">
This callout uses a rocket icon with purple color.
</Callout>
<Callout icon="regular/star" color="#EC4899">
Use style prefixes for different icon weights.
</Callout>
Propriedades de avisos personalizados
stringdefault: circle-infoNome do ícone (veja Ícones).
stringCódigo de cor hexadecimal (ex.: #FFC107). O padrão é a cor de destaque.
Prefixos de estilo de ícone: Adicione um prefixo para mudar a espessura do ícone:
solid/- Ícones preenchidos (padrão)regular/- Ícones com contornolight/- Ícones com contorno finoduotone/- Ícones de dois tons
