Pular para o conteúdo
Sobreposição

Tooltip

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

Em botão de ícone

Fechada

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

Quando usar

Dica curta, para botão que só tem ícone.

Compõe com TooltipTrigger e TooltipContent.

Não guarde informação essencial aqui: dica não aparece no toque e não é lida em todo contexto. O aria-label do botão continua obrigatório.

Para o caso mais comum, a dica que repete o nome de um botão só com ícone, use IconButton com tooltip: ele monta a dica com o label e não a amarra por aria-describedby, então o leitor de tela não ouve a mesma frase duas vezes.

Quando não usar

Para conteúdo com ação dentro (um link, um botão, um formulário curto), use Popover: a dica some ao sair e não leva nada clicável. A prévia que se lê com calma ao pousar num link (quem é o cliente, o resumo do pedido) é PreviewCard.

E o que a pessoa precisa saber para não errar vai na tela, como FieldDescription embaixo do campo: no toque a dica não existe. O passeio guiado pela tela no primeiro acesso é Tour.

No React Native

Não porta, e não há substituto: a dica aparece ao pousar o ponteiro, e no toque não existe pousar. O que no web era um ícone com dica vira, no celular, um ícone com rótulo escrito ao lado, ou um accessibilityLabel, que resolve para o leitor de tela e não resolve para quem enxerga.

API

PropTipoPadrão
actionsRef0.4.0

Uma ref para as ações imperativas.

RefObject<TooltipRootActions | null>sem padrão
defaultOpen0.4.0

Se a dica começa aberta.

booleanfalse
defaultTriggerId0.4.0

ID do gatilho ao qual a dica está associada.

string | nullsem padrão
disabled0.4.0

Se a dica está desabilitada.

booleanfalse
disableHoverablePopup0.4.0

Se o ponteiro pode passar sobre o conteúdo da dica sem fechá-la.

booleanfalse
handle0.4.0

Um elo para associar a dica a um gatilho.

TooltipHandle<Payload>sem padrão
onOpenChange0.4.0

Chamado quando a dica abre ou fecha.

((open: boolean, eventDetails: TooltipRootChangeEventDetails) => void)sem padrão
onOpenChangeComplete0.4.0

Chamado depois que as animações terminam, quando a dica abre ou fecha.

((open: boolean) => void)sem padrão
open0.4.0

Se a dica está aberta agora.

booleansem padrão
trackCursorAxis0.4.0

Em que eixo a dica acompanha o cursor.

"both""none""x""y""none"
triggerId0.4.0

ID do gatilho ao qual a dica está associada.

string | nullsem padrão

Partes

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

TooltipContent

/tooltip-content.md

O balão da dica.

side diz o lado preferido, align o alinhamento no eixo dele e sideOffset a distância até o gatilho (as mesmas três props das outras peças que flutuam, com a mesma folga padrão de 6px). A Base UI vira sozinha quando não cabe.

Texto curto, uma dica que precisa de duas frases é uma FieldDescription no lugar errado.

PropTipo
align

Alinhamento no eixo do lado escolhido.

Align
render0.4.0

Troca o elemento HTML da peça por outra tag, ou a compõe com outro componente.

ComponentRenderFn<HTMLProps, TooltipPopupState> | ReactElement<unknown, string | JSXElementConstructor<any>>
side0.4.0

Lado preferido do gatilho.

Side
sideOffset

Distancia entre o gatilho e o painel, em pixels.

number | OffsetFunction

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

TooltipTrigger

/tooltip-trigger.md

O que mostra a dica ao receber foco ou o ponteiro.

Envolve o elemento por render. Dica não substitui rótulo: no celular não existe hover, e quem navega por toque nunca a vê.

PropTipoPadrão
closeDelay0.4.0

Quanto esperar antes de fechar a dica.

number0
closeOnClick0.4.0

Se a dica fecha quando este gatilho é clicado.

booleantrue
delay0.4.0

Quanto esperar antes de abrir a dica pelo passar do ponteiro.

number600
disabled0.4.0

Com `true`, a dica não abre na interação com este gatilho.

booleanfalse
handle0.4.0

Um elo para associar o gatilho a uma dica.

TooltipHandle<Payload>sem padrão
payload0.4.0

Um dado a entregar à dica quando ela abre.

Payloadsem padrão
render0.4.0

Troca o elemento HTML da peça por outra tag, ou a compõe com outro componente.

ComponentRenderFn<HTMLProps, TooltipTriggerState> | ReactElement<unknown, string | JSXElementConstructor<any>>sem padrão

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

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