Painéis Informativos

Os alertas permitem destacar informações importantes dentro dos artigos da Base de Conhecimento, tornando a leitura mais clara e organizada.

Existem cinco tipos de alertas disponíveis:

  • info — Informação
  • note — Observação
  • warning — Atenção
  • success — Sucesso
  • error — Erro

Como inserir um alerta

Para criar um alerta, utilize uma tag <div> contendo o atributo data-tt-type.

Opcionalmente, é possível informar um título através do atributo data-tt-title.

<div
    data-tt-type="warning"
    data-tt-title="Atenção"
>
    Esta alteração pode afetar integrações existentes.
</div>

Durante a exibição do artigo, este elemento será automaticamente convertido em um alerta visual com ícone, cores e formatação apropriadas.


Tipos disponíveis

TipoDescrição
infoInformações gerais sobre um recurso.
noteObservações e dicas adicionais.
warningAvisos importantes que exigem atenção.
successConfirmações de sucesso ou conclusão.
errorErros, limitações ou problemas conhecidos.

Exemplos

Informação

<div
    data-tt-type="info"
    data-tt-title="Informação"
>
    Este recurso está disponível para todos os planos.
</div>

Observação

<div
    data-tt-type="note"
    data-tt-title="Observação"
>
    A atualização pode levar alguns minutos para ser concluída.
</div>

Atenção

<div
    data-tt-type="warning"
    data-tt-title="Atenção"
>
    Esta alteração pode afetar integrações existentes.
</div>

Sucesso

<div
    data-tt-type="success"
    data-tt-title="Sucesso"
>
    A configuração foi concluída corretamente.
</div>

Erro

<div
    data-tt-type="error"
    data-tt-title="Erro"
>
    Não foi possível concluir a operação.
</div>

Título opcional

O atributo data-tt-title é opcional.

Quando ele não for informado, apenas o conteúdo do alerta será exibido.

<div data-tt-type="warning">
    Faça um backup antes de continuar.
</div>

Atributos suportados

AtributoObrigatórioDescrição
data-tt-typeSimDefine o tipo do alerta (info, note, warning, success ou error).
data-tt-titleNãoTítulo exibido no topo do alerta.

Boas práticas

  • Utilize Informação para explicar recursos.
  • Utilize Observação para dicas e recomendações.
  • Utilize Atenção para alertar sobre impactos ou cuidados.
  • Utilize Sucesso para informar resultados positivos.
  • Utilize Erro para limitações, falhas ou situações que impeçam a operação.

Este artigo foi útil?  
Agradecemos sua avaliação.