Skip to content
@ng-doc/ui-kit / Class

NgDocTooltipDirective

Shows its content in a tooltip while the pointer rests on the host.

Decorators
@Directive
Selectors
[ngDocTooltip]
Implements
AfterViewInitOnDestroy
DeclarationTypeScript
@Directive({ … })
export class NgDocTooltipDirective implements AfterViewInit, OnDestroy { … }

Members

Properties

18
afterClose: OutputEmitterRef<void>
readonly output()

Emits when the tooltip has closed.

afterOpen: OutputEmitterRef<void>
readonly output()

Emits when the open animation has finished.

beforeClose: OutputEmitterRef<void>
readonly output()

Emits when the tooltip starts closing.

beforeOpen: OutputEmitterRef<void>
readonly output()

Emits when the tooltip starts opening.

canOpen: InputSignal<boolean>
readonly input()

Whether hovering opens the tooltip.

readonly input()

What the tooltip renders: a string, a template or a component.

delay: InputSignal<number>
readonly input()

Milliseconds the pointer rests on the host before the tooltip opens.

displayOrigin: InputSignal<BaseElement<HTMLElement> | undefined>
readonly input()

The element the tooltip points at; the host by default.

height: InputSignal<string | number>
readonly input()
—
maxHeight: InputSignal<string | number>
readonly input()
—
maxWidth: InputSignal<string | number>
readonly input()
—
minHeight: InputSignal<string | number>
readonly input()
—
minWidth: InputSignal<string | number>
readonly input()
—
overlayRef: NgDocOverlayRef<unknown> | null
—
panelClass: InputSignal<string | string[]>
readonly input()
—
pointerOrigin: InputSignal<BaseElement<HTMLElement> | undefined>
readonly input()

The element whose hover opens the tooltip; the host by default. Read once, after the view.

readonly input()
—
width: InputSignal<string | number>
readonly input()
—

Accessors

1
get isOpened: boolean
—

Methods

4
(): void
—
(): void
implements AfterViewInit
—
(): void
implements OnDestroy
—
(): void
—
Symbol
Kind
Class
Decorators
@Directive
Selectors
[ngDocTooltip]
Implements
AfterViewInitOnDestroy
Scope
@ng-doc/ui-kit
Edit this page