Tooltip
Exiba definições e contexto ao passar o mouse. Defina termos, explique siglas ou link para conteúdo relacionado sem poluir a página.
Adicione texto ao passar o mouse para definir termos, explicar siglas ou linkar para páginas relacionadas sem poluir o conteúdo principal.
Use Tooltips quando:
- Definir termos inline sem interromper a leitura
- Explicar siglas que alguns leitores podem não conhecer
- Fornecer contexto útil, mas não essencial
- Linkar para conteúdo relacionado com uma chamada para ação
Tooltip básico
Passe o mouse sobre APIUm conjunto de protocolos para que aplicações de software se comuniquem. para ver a definição.
<Tooltip tip="A set of protocols for software applications to communicate.">
API
</Tooltip>
Com título
Adicione um título acima do texto da dica:
Passe o mouse sobre APIAPIApplication Programming Interface: um conjunto de protocolos para que aplicações de software se comuniquem. para ver a definição com um título.
<Tooltip
headline="API"
tip="Application Programming Interface: a set of protocols for software applications to communicate."
>
API
</Tooltip>
Com link de chamada para ação
Adicione um link para mais detalhes:
Saiba mais sobre APIsAPIApplication Programming Interface: um conjunto de protocolos para que aplicações de software se comuniquem.Saiba mais → em nossa documentação.
<Tooltip
headline="API"
tip="Application Programming Interface: a set of protocols..."
cta="Learn more"
href="/components/overview"
>
API
</Tooltip>
Uso em linha
Tooltips funcionam inline com o texto. Você pode explicar termos como HTMLHyperText Markup Language, CSSCascading Style Sheets ou JSJavaScript diretamente no texto.
Explain <Tooltip tip="HyperText Markup Language">HTML</Tooltip>,
<Tooltip tip="Cascading Style Sheets">CSS</Tooltip>, or
<Tooltip tip="JavaScript">JS</Tooltip> terms inline.
Tooltips versus outros componentes
| Necessidade | Componente |
|---|---|
| Definir um termo inline | Tooltip |
| Explicar um conceito em detalhes | Expandable ou seção separada |
| Alertar sobre algo importante | Callout (Note, Warning) |
| Mostrar código contextual | CodeGroup ou código inline |
Regra prática: Tooltips são para definições rápidas (1-2 frases). Explicações mais longas pertencem ao conteúdo principal ou a um Expandable.
Props
stringrequiredO texto do tooltip exibido ao passar o mouse.
stringTexto exibido acima da dica.
stringTexto do link de chamada para ação.
stringURL para a chamada para ação (obrigatório com cta).
ReactNodeO texto que aciona o tooltip.
Acessibilidade
- Tooltips são acessíveis por teclado (Tab para focar, exibe ao focar)
- Usa
role="tooltip"para leitores de tela - O texto de acionamento tem um sublinhado tracejado para indicar interatividade
