Tooltip

Mantenedor:
amje
GitHub
placement

Un consejo de texto sencillo que usa su nodo secundario como ancla. Este componente solo acepta contenido de texto y puede ser excelente alternativa al title atributo del navegador con su tamaño pequeño y su largo retraso de aparición.

Uso

import {Tooltip} from '@gravity-ui/uikit';

<Tooltip content="Content">
  <div tabIndex={0}>Anchor</div>
</Tooltip>;

Ancla

Para poder Tooltip trabajar, debe aprobar un documento válido ReactElement como niño que acepte ref propiedades para HTMLElement y otras propiedades para HTMLElement.

Alternativamente, puede pasar la función como elemento secundario para proporcionar referencias y accesorios manualmente a sus componentes subyacentes:

import {Tooltip} from '@gravity-ui/uikit';

<Tooltip content="Content">
  {(props, ref) => <MyCustomButton buttonProps={props} buttonRef={ref} />}
</Tooltip>;

Estado controlado

De forma predeterminada, Tooltip se abre y se oculta al colocar el cursor sobre el ancla. Puede cambiar este comportamiento para establecer manualmente el estado de apertura. Pasa tu estado al open utilero y cámbialo por onOpenChange callback. onOpenChange la devolución de llamada tiene la siguiente firma: (open: boolean, event? : Evento, motivo: «flotar» | 'enfoque') => vacío.

Rol

Tooltip acepta la role propiedad, lo que cambia la forma en que debe actuar en términos de accesibilidad. tooltip el rol debe usarse cuando el ancla tiene su propio texto y el label rol en caso contrario (por ejemplo, en el botón del icono).

Propiedades

NombreDescripciónTipoPredeterminado
niñosElemento de anclaje para TooltipReact.ReactElement Function
classNameclass Atributo HTMLstring
closeDelayNúmero de ms para retrasar la ocultación Tooltip después de que finalice el desplazamientonumber0
contenidoContenido que se mostrará en el TooltipReact.ReactNode
inhabilitadoImpedir que Tooltip se abranboolean
compensarTooltip desplazado desde su anclanumber4
onOpenChangeLlamada para gestionar el cambio de estado abiertoFunction
abiertoEstado abierto controladoboolean
openDelayNúmero de ms de retraso que se muestran Tooltip después de que comience el desplazamientonumber1000
colocaciónTooltip posición relativa a su anclaPopupPlacementbottom
qadata-qa Atributo HTML, usado para realizar pruebasstring
papelEl rol Tooltip se usa para"tooltip" "label""tooltip"
estrategiaEl tipo de propiedad de posición CSS que se va a utilizar.absolute fixedabsolute
estilostyle Atributo HTMLReact.CSSProperties
desencadenarTipo de evento que debería activar la apertura. De forma predeterminada, tanto el puntero del ratón como el enfoque lo hacen."focus"

API CSS

NombreDescripción
--g-tooltip-text-colorColor del texto
--g-tooltip-background-colorColor de fondo
--g-tooltip-paddingAcolchado
--g-tooltip-border-radiusRadio de borde
--g-tooltip-box-shadowSombra