Class: FyzTooltipService

@flyze/lib-core-angular 1.0.0-alpha.34· latest

Defined in: projects/lib-core-angular/src/lib/directives/fyz-tooltip/fyz-tooltip.service.ts:61

Constructors

Constructor

new FyzTooltipService(overlay, positionBuilder, injector, zone): FyzTooltipService

Defined in: projects/lib-core-angular/src/lib/directives/fyz-tooltip/fyz-tooltip.service.ts:70

Parameters

overlay

Overlay

positionBuilder

OverlayPositionBuilder

injector

Injector

zone

NgZone

Returns

FyzTooltipService

Methods

attach()

attach(hostOrRef, optionsOrFactory): () => void

Defined in: projects/lib-core-angular/src/lib/directives/fyz-tooltip/fyz-tooltip.service.ts:271

Wire hover behaviour onto a host and get back the teardown for it.

This is the method to reach for. show() and hide() are the primitives underneath, and a consumer wiring them up by hand writes the same forty lines every time - two listeners, an empty-text guard, and a teardown that has to remember to remove the listeners and dispose a panel that may still be on screen. Forgetting the last part is the regression in commit 0dd3d62e, “tooltip was stuck if the button is destroyed”.

Pass a factory rather than a fixed object whenever the text or the delays depend on state that changes after this call: it is re-read on every hover, so there is nothing to keep in sync and no listener to re-register when the answer changes. Returning nullish, or options whose text is empty, suppresses that hover.

Parameters

hostOrRef

FyzTooltipHost

optionsOrFactory

FyzTooltipOptions | FyzTooltipOptionsFactory

Returns

An idempotent stop function. Call it from ngOnDestroy; calling it twice is safe.

() => void

hide()

hide(hostOrRef, hideDelay?): void

Defined in: projects/lib-core-angular/src/lib/directives/fyz-tooltip/fyz-tooltip.service.ts:188

Hide the tooltip on a given host element, running the exit animation.

Parameters

hostOrRef

FyzTooltipHost

hideDelay?

number

Milliseconds to wait before starting the exit animation. Omit to use the hideDelay the panel was shown with, which is the usual case - the caller hiding a tooltip is rarely the one that configured it. Pass a number to override it for this call only; pass 0 for no delay.

Returns

void

hideAll()

hideAll(): void

Defined in: projects/lib-core-angular/src/lib/directives/fyz-tooltip/fyz-tooltip.service.ts:232

Hide every open tooltip, running each exit animation but honouring no delay.

The escape hatch for a consumer that lost track of its anchors - a route change, say - so it overrides the configured hideDelay: waiting a second and a half per panel while the page has already moved on is not what any caller of this wants.

Returns

void

hideImmediately()

hideImmediately(hostOrRef): void

Defined in: projects/lib-core-angular/src/lib/directives/fyz-tooltip/fyz-tooltip.service.ts:215

Remove the tooltip on a given host element at once, with no exit animation and no delay.

For teardown paths. hide() is the wrong call there once a hideDelay is in play: it would leave the panel on screen for the length of the delay after its anchor is already gone.

Parameters

hostOrRef

FyzTooltipHost

Returns

void

isOpen()

isOpen(hostOrRef): boolean

Defined in: projects/lib-core-angular/src/lib/directives/fyz-tooltip/fyz-tooltip.service.ts:251

Whether a panel exists for this host.

The query a consumer holding nothing but an HTMLElement has no other way to answer, and the reason it is here: without it, anything driving show()/hide() from its own events has to keep a parallel boolean in sync with this service by hand, and gets it wrong the first time a panel closes by any route it did not initiate - hideAll(), a teardown, a pointer leaving the host.

True from the moment show() attaches an overlay, so it covers a panel that is still inside its showDelay and not on screen yet. That is deliberate: the caller asking is deciding whether to open or close, and a pending panel must count as open or it opens a second one. Distinct from the panel’s own isVisible, which only flips when the entry animation starts.