Reference Source
import {Tooltip} from '@adobe/coral-spectrum'
public class | source

Tooltip

Extends:

HTMLElementOverlay → Tooltip

A Tooltip component that can be attached to any element and may be displayed immediately or on hovering the target element.

See:

Example:

Markup
<coral-tooltip></coral-tooltip>
JS constructor
new Coral.Tooltip();

Static Member Summary

Static Public Members
public static

Returns Tooltip variants.

Member Summary

Public Members
public

The Tooltip content element.

public

The amount of time in miliseconds to wait before showing the tooltip when the target is interacted with.

public

Inherited from Overlay#interaction.

public

open: *

Inherited from Overlay#open.

public

target: *

Inherited from Overlay#target.

public

The variant of tooltip.

Inherited Summary

From class Overlay
public static
this member was deprecated. Returns {@link Overlay} align options.
public static

Returns Overlay collision options.

public static

Returns Overlay interaction options.

public static

Returns Overlay placement options.

public static

Returns Overlay target options.

public
this member was deprecated.

The point on the target we should anchor to when positioning.

public
this member was deprecated.

The point on the overlay we should anchor from when positioning.

public

The distance the overlay should be from its target along the breadth axis.

public

The collision handling strategy when positioning the overlay relative to a target.

public

Whether the overlay flows toward the inner of the target element.

public

Whether keyboard interaction is enabled.

public

The distance the overlay should be from its target along the length axis.

public

The distance the overlay should be from its target.

public

open: *

Inherited from BaseOverlay#open.

public

The placement of the overlay.

public

Whether the overlay is allowed to change its DOM position for better positioning based on its context.

public

The element the overlay should position relative to.

public

The bounding element for the overlay.

public

Amount of pixel used to define a minimum distance between the boundaries and the overlay.

public

reposition(forceReposition: Boolean)

Re-position the overlay if it's currently open.

Static Public Members

public static variant: TooltipVariantEnum: * source

Returns Tooltip variants.

Public Members

public content: TooltipContent source

The Tooltip content element.

  • content-zone

public delay: Number source

The amount of time in miliseconds to wait before showing the tooltip when the target is interacted with.

  • 500 by default.

public interaction: * source

Inherited from Overlay#interaction.

Override:

Overlay#interaction

public open: * source

Inherited from Overlay#open.

Override:

Overlay#open

public target: * source

Inherited from Overlay#target.

Override:

Overlay#target

public variant: String source

The variant of tooltip. See TooltipVariantEnum.

  • TooltipVariantEnum.DEFAULT by default.
  • reflected