Ir para o conteúdo principal
WBC - GovBR-DS
Copiar página como Markdown para IA

Tooltip

Componente estável e recomendada para novos projetos.
Anatomia, uso, comportamento visual e recomendações conceituais são mantidos pelo Padrão Digital de Governo. Esta página documenta a implementação Web Components e sua API executável.

Visão Geral

Para a documentação completa, incluindo diretrizes de uso, acessibilidade e exemplos visuais, consulte o Design System do GovBR.

Exemplo(s)

Desktop (100%)
Tablet - 768px
iPhone (iOS) - 390x844
Android - 360x800
Compartilhar URL
Mudar fundo
Abrir no StackBlitz
Tela cheia
HTML
Controles
JS
CSS
Console
Angular (Somente leitura)
React (Somente leitura)
Vue (Somente leitura)
Acessibilidade
Recolher controles e código
Formatar código
Resetar código para o estado inicial
Copiar para a área de transferência

Fluxo e sobreposição

O tooltip nunca participa do fluxo da página. Quando a Popover API está disponível, seu conteúdo entra na top layer; nos demais ambientes usa position: fixed e a camada flutuante 1. A posição é aplicada antes do primeiro cálculo assíncrono para não provocar reflow.

Tooltips externos são fechados quando um bloqueador abre. Tooltips contidos no diálogo permanecem utilizáveis e, com Popover API, são pintados acima dele pela própria plataforma.

Propriedades

ariaLabel

Atributoaria-label
DescriçãoNome acessível do popover. Quando omitido, usa o rótulo derivado do estado visual.
Tipostring
Valor padrãonull

customId

Atributocustom-id
DescriçãoIdentificador único do componente.
Quando omitido, um valor é gerado automaticamente.

> Padrão: valor único gerado por generateUniqueId().
Tipostring
Valor padrãogenerateUniqueId()

density

Atributodensity
DescriçãoDefine a densidade visual do componente.

- small: Alta densidade (componente menor, mais compacto e com menos espaçamento).
- medium: Densidade intermediária, padrão recomendado para a maioria dos casos.
- large: Baixa densidade (componente maior, mais espaçamento e altura).
Tipo"large" | "medium" | "small"
Valor padrão'medium'

hideDelay

Atributohide-delay
DescriçãoAtraso em milissegundos antes de ocultar.
Tiponumber
Valor padrãonull

interaction

Atributointeraction
DescriçãoModo de interação para exibição do tooltip: 'hover' ou 'click'.
Tipo"click" | "hover"
Valor padrão'hover'

isAutoVisible

Atributois-auto-visible
DescriçãoExibe automaticamente sem interação quando true; caso contrário, depende do acionador.
Tipoboolean
Valor padrãofalse

position

Atributoposition
DescriçãoPosição do tooltip em relação ao acionador.
Tipo"bottom" | "left" | "right" | "top"
Valor padrão'top'

showDelay

Atributoshow-delay
DescriçãoAtraso em milissegundos antes de exibir.
Tiponumber
Valor padrãonull

state

Atributostate
DescriçãoEstado visual do tooltip: 'info', 'warning', 'error', 'danger' ou 'success'.
Tipo"danger" | "error" | "info" | "success" | "warning"
Valor padrão'info'

type

Atributotype
DescriçãoTipo do tooltip: 'standard' (simples) ou 'popover' (mais rico, com fechamento por interação).
Tipo"popover" | "standard"
Valor padrão'standard'

Slots

NomeDescrição
"content"Slot para o conteúdo exibido no tooltip.
"trigger"Slot para o elemento que aciona a exibição do tooltip.

Eventos

EventoDescriçãoDepreciaçãoPropagação
brDidCloseEmitido quando o tooltip fecha.---true
brDidOpenEmitido quando o tooltip abre.---true

Métodos

hide

DescriçãoOculta o tooltip programaticamente (alias para hideTooltip).
Assinaturahide() => Promise<void>
Parâmetros---

hideTooltip

DescriçãoOculta o tooltip programaticamente.
AssinaturahideTooltip() => Promise<void>
Parâmetros---

setTriggerElement

DescriçãoDefine um trigger externo para o tooltip.
AssinaturasetTriggerElement(element: HTMLElement | null) => Promise<void>
Parâmetroselement:

show

DescriçãoExibe o tooltip programaticamente (alias para showTooltip).
Assinaturashow() => Promise<void>
Parâmetros---

showTooltip

DescriçãoExibe o tooltip programaticamente.
AssinaturashowTooltip() => Promise<void>
Parâmetros---

CSS Shadow Parts

NomeDescrição
"arrow"Seta indicativa do tooltip.
"container"Wrapper principal do tooltip.
"content"Área de conteúdo do tooltip.
"trigger"Área do acionador do tooltip.

Dependências

Usado por

Depende de

Gráfico