Jamdesk Documentation logo

Tooltip

Muestra definiciones y contexto al pasar el cursor. Define términos, explica acrónimos o enlaza a contenido relacionado sin sobrecargar la página.

Añade texto emergente para definir términos, explicar acrónimos o enlazar a páginas relacionadas sin sobrecargar el contenido principal.

Usa Tooltips cuando:

  • Definir términos de forma inline sin interrumpir el flujo de lectura
  • Explicar acrónimos que algunos lectores pueden no conocer
  • Proporcionar contexto que es útil pero no esencial
  • Enlazar a contenido relacionado con una llamada a la acción

Tooltip básico

Pasa el cursor sobre API para ver la definición.

<Tooltip tip="A set of protocols for software applications to communicate.">
  API
</Tooltip>

Con titular

Añade un titular encima del texto del tooltip:

Pasa el cursor sobre API para ver la definición con un titular.

<Tooltip
  headline="API"
  tip="Application Programming Interface: a set of protocols for software applications to communicate."
>
  API
</Tooltip>

Con enlace de llamada a la acción

Incluye un enlace para que los usuarios puedan saber más:

Aprende sobre APIs en nuestra documentación.

<Tooltip
  headline="API"
  tip="Application Programming Interface: a set of protocols..."
  cta="Learn more"
  href="/components/overview"
>
  API
</Tooltip>

Uso inline

Los Tooltips funcionan inline con el texto. Puedes explicar términos de HTML, CSS o JS de forma inline.

Explain <Tooltip tip="HyperText Markup Language">HTML</Tooltip>,
<Tooltip tip="Cascading Style Sheets">CSS</Tooltip>, or
<Tooltip tip="JavaScript">JS</Tooltip> terms inline.

Tooltips frente a otros componentes

NecesidadComponente
Definir un término inlineTooltip
Explicar un concepto en detalleExpandable o sección separada
Advertir sobre algo importanteCallout (Note, Warning)
Mostrar código contextualCodeGroup o código inline

Regla general: Los Tooltips son para definiciones rápidas (1-2 frases). Las explicaciones más largas pertenecen al contenido principal o a un Expandable.

Props

stringrequired

El texto del tooltip que se muestra al pasar el cursor.

string

Texto que se muestra encima del tip.

string

Texto del enlace de llamada a la acción.

string

URL para la llamada a la acción (requerida con cta).

ReactNode

El texto que activa el tooltip.

Accesibilidad

  • Los Tooltips son accesibles mediante teclado (Tab para enfocar, se muestra al enfocar)
  • Usa role="tooltip" para lectores de pantalla
  • El texto desencadenador tiene un subrayado discontinuo para indicar interactividad

¿Qué sigue?

Resumen de componentes

Explora todos los componentes disponibles

Conceptos básicos de MDX

Aprende a usar componentes en MDX