153 lines
5.9 KiB
TypeScript
153 lines
5.9 KiB
TypeScript
import { ApplicationRef, ChangeDetectorRef, ElementRef, EventEmitter, Injector, NgZone, OnChanges, OnDestroy, OnInit, Renderer2, SimpleChanges, TemplateRef, ViewContainerRef } from '@angular/core';
|
|
import { PlacementArray } from '../util/positioning';
|
|
import { Options } from '@popperjs/core';
|
|
import { NgbTooltipConfig } from './tooltip-config';
|
|
import * as i0 from "@angular/core";
|
|
export declare class NgbTooltipWindow {
|
|
animation: boolean;
|
|
id: string;
|
|
tooltipClass: string;
|
|
static ɵfac: i0.ɵɵFactoryDeclaration<NgbTooltipWindow, never>;
|
|
static ɵcmp: i0.ɵɵComponentDeclaration<NgbTooltipWindow, "ngb-tooltip-window", never, { "animation": "animation"; "id": "id"; "tooltipClass": "tooltipClass"; }, {}, never, ["*"], true, never>;
|
|
}
|
|
/**
|
|
* A lightweight and extensible directive for fancy tooltip creation.
|
|
*/
|
|
export declare class NgbTooltip implements OnInit, OnDestroy, OnChanges {
|
|
private _elementRef;
|
|
private _renderer;
|
|
private _ngZone;
|
|
private _document;
|
|
private _changeDetector;
|
|
static ngAcceptInputType_autoClose: boolean | string;
|
|
/**
|
|
* If `true`, tooltip opening and closing will be animated.
|
|
*
|
|
* @since 8.0.0
|
|
*/
|
|
animation: boolean;
|
|
/**
|
|
* Indicates whether the tooltip should be closed on `Escape` key and inside/outside clicks:
|
|
*
|
|
* * `true` - closes on both outside and inside clicks as well as `Escape` presses
|
|
* * `false` - disables the autoClose feature (NB: triggers still apply)
|
|
* * `"inside"` - closes on inside clicks as well as Escape presses
|
|
* * `"outside"` - closes on outside clicks (sometimes also achievable through triggers)
|
|
* as well as `Escape` presses
|
|
*
|
|
* @since 3.0.0
|
|
*/
|
|
autoClose: boolean | 'inside' | 'outside';
|
|
/**
|
|
* The preferred placement of the tooltip, among the [possible values](#/guides/positioning#api).
|
|
*
|
|
* The default order of preference is `"auto"`.
|
|
*
|
|
* Please see the [positioning overview](#/positioning) for more details.
|
|
*/
|
|
placement: PlacementArray;
|
|
/**
|
|
* Allows to change default Popper options when positioning the tooltip.
|
|
* Receives current popper options and returns modified ones.
|
|
*
|
|
* @since 13.1.0
|
|
*/
|
|
popperOptions: (options: Partial<Options>) => Partial<Options>;
|
|
/**
|
|
* Specifies events that should trigger the tooltip.
|
|
*
|
|
* Supports a space separated list of event names.
|
|
* For more details see the [triggers demo](#/components/tooltip/examples#triggers).
|
|
*/
|
|
triggers: string;
|
|
/**
|
|
* A css selector or html element specifying the element the tooltip should be positioned against.
|
|
* By default, the element `ngbTooltip` directive is applied to will be set as a target.
|
|
*
|
|
* @since 13.1.0
|
|
*/
|
|
positionTarget?: string | HTMLElement;
|
|
/**
|
|
* A selector specifying the element the tooltip should be appended to.
|
|
*
|
|
* Currently only supports `"body"`.
|
|
*/
|
|
container: string;
|
|
/**
|
|
* If `true`, tooltip is disabled and won't be displayed.
|
|
*
|
|
* @since 1.1.0
|
|
*/
|
|
disableTooltip: boolean;
|
|
/**
|
|
* An optional class applied to the tooltip window element.
|
|
*
|
|
* @since 3.2.0
|
|
*/
|
|
tooltipClass: string;
|
|
/**
|
|
* The opening delay in ms. Works only for "non-manual" opening triggers defined by the `triggers` input.
|
|
*
|
|
* @since 4.1.0
|
|
*/
|
|
openDelay: number;
|
|
/**
|
|
* The closing delay in ms. Works only for "non-manual" opening triggers defined by the `triggers` input.
|
|
*
|
|
* @since 4.1.0
|
|
*/
|
|
closeDelay: number;
|
|
/**
|
|
* An event emitted when the tooltip opening animation has finished. Contains no payload.
|
|
*/
|
|
shown: EventEmitter<any>;
|
|
/**
|
|
* An event emitted when the tooltip closing animation has finished. Contains no payload.
|
|
*/
|
|
hidden: EventEmitter<any>;
|
|
private _ngbTooltip;
|
|
private _ngbTooltipWindowId;
|
|
private _popupService;
|
|
private _windowRef;
|
|
private _unregisterListenersFn;
|
|
private _positioning;
|
|
private _zoneSubscription;
|
|
constructor(_elementRef: ElementRef<HTMLElement>, _renderer: Renderer2, injector: Injector, viewContainerRef: ViewContainerRef, config: NgbTooltipConfig, _ngZone: NgZone, _document: any, _changeDetector: ChangeDetectorRef, applicationRef: ApplicationRef);
|
|
/**
|
|
* The string content or a `TemplateRef` for the content to be displayed in the tooltip.
|
|
*
|
|
* If the content if falsy, the tooltip won't open.
|
|
*/
|
|
set ngbTooltip(value: string | TemplateRef<any> | null | undefined);
|
|
get ngbTooltip(): string | TemplateRef<any> | null | undefined;
|
|
/**
|
|
* Opens the tooltip.
|
|
*
|
|
* This is considered to be a "manual" triggering.
|
|
* The `context` is an optional value to be injected into the tooltip template when it is created.
|
|
*/
|
|
open(context?: any): void;
|
|
/**
|
|
* Closes the tooltip.
|
|
*
|
|
* This is considered to be a "manual" triggering of the tooltip.
|
|
*/
|
|
close(animation?: boolean): void;
|
|
/**
|
|
* Toggles the tooltip.
|
|
*
|
|
* This is considered to be a "manual" triggering of the tooltip.
|
|
*/
|
|
toggle(): void;
|
|
/**
|
|
* Returns `true`, if the popover is currently shown.
|
|
*/
|
|
isOpen(): boolean;
|
|
ngOnInit(): void;
|
|
ngOnChanges({ tooltipClass }: SimpleChanges): void;
|
|
ngOnDestroy(): void;
|
|
private _getPositionTargetElement;
|
|
static ɵfac: i0.ɵɵFactoryDeclaration<NgbTooltip, never>;
|
|
static ɵdir: i0.ɵɵDirectiveDeclaration<NgbTooltip, "[ngbTooltip]", ["ngbTooltip"], { "animation": "animation"; "autoClose": "autoClose"; "placement": "placement"; "popperOptions": "popperOptions"; "triggers": "triggers"; "positionTarget": "positionTarget"; "container": "container"; "disableTooltip": "disableTooltip"; "tooltipClass": "tooltipClass"; "openDelay": "openDelay"; "closeDelay": "closeDelay"; "ngbTooltip": "ngbTooltip"; }, { "shown": "shown"; "hidden": "hidden"; }, never, never, true, never>;
|
|
}
|