Search

Find components, guides, and documentation

Tooltip: API Table

class: LionTooltip, lion-tooltip

Fields

NamePrivacyTypeDefaultDescriptionInherited From
configpublicPartial<OverlayConfig>{}Configure the many options of the `OverlayController`OverlayMixin
hasArrowpublicbooleanfalseWhether an arrow should be displayed
invokerRelationpublic'label'|'description''description'Decides whether the tooltip invoker text should be considered a description (sets aria-describedby) or a label (sets aria-labelledby).
openedpublicbooleanfalseIf you add the opened attribute a dialog will be opened on page load. The invoker can be left out in case the user does not need to be able to reopen the dialog.OverlayMixin
_overlayBackdropNodeprotectedOverlayMixin
_overlayContentNodeprotectedOverlayMixin
_overlayContentWrapperNodeprotectedOverlayMixin
_overlayInvokerNodeprotectedThe node that opens/closes this overlay. Resolved in a stable, declarative way (independent of the exact DOM order) by looking, in order, for: 1. a child with `[slot=“invoker”]` 2. any element in the same root that opts in via `[data-invoker]` and references this host by id (`for=“<id>”`) 3. a preceding sibling that opts in via `[data-invoker]`OverlayMixin
_overlayReferenceNodeprotectedOverlayMixin

Methods

NamePrivacyDescriptionParametersReturnInherited From
closepublicHides the overlayOverlayMixin
openpublicShows the overlayOverlayMixin
repositionOverlaypublicSometimes it’s needed to recompute Popper position of an overlay, for instance when we have an opened combobox and the surrounding context changes (the space consumed by the textbox increases vertically)OverlayMixin
togglepublicToggles the overlayOverlayMixin
_defineOverlayprotected{ contentNode, invokerNode, referenceNode, backdropNode, contentWrapperNode }, config: DefineOverlayConfigOverlayControllerOverlayMixin
_defineOverlayConfigprotectedOverlayConfigOverlayMixin
_getInvokerNodeprotectedElement|nullOverlayMixin
_isPermanentlyDisconnectedprotectedWhen we’re moving around in dom, disconnectedCallback gets called. Before we decide to teardown, let’s wait to see if we were not just moving nodes around.Promise<boolean>OverlayMixin
_setOpenedWithoutPropertyEffectsprotectedWhen the opened state is changed by an Application Developer,cthe OverlayController is requested to show/hide. It might happen that this request is not honoured (intercepted in before-hide for instance), so that we need to sync the controller state to this webcomponent again, preventing eternal loops.newOpened: booleanOverlayMixin
_setupOpenCloseListenersprotectedOverlayMixin
_setupOverlayCtrlprotectedOverlayMixin
_teardownOpenCloseListenersprotectedOverlayMixin
_teardownOverlayCtrlprotectedOverlayMixin

Events

NameTypeDescriptionInherited From
opened-changedCustomEventOverlayMixin

Attributes

NameFieldInherited From
invoker-relationinvokerRelation
openedopenedOverlayMixin