ngx-bootstrap/tooltip/index.d.ts

Angular Bootstrap

import * as i0 from '@angular/core';
import { AfterViewInit, OnInit, OnDestroy, TemplateRef, EventEmitter, ViewContainerRef, ElementRef, Renderer2, ModuleWithProviders } from '@angular/core';
import { IBsVersion } from 'ngx-bootstrap/utils';
import { ComponentLoaderFactory } from 'ngx-bootstrap/component-loader';
import { AvailableBSPositions, PositioningService } from 'ngx-bootstrap/positioning';
import * as i1 from '@angular/common';

/** Default values provider for tooltip */
declare class TooltipConfig {
    /** sets disable adaptive position */
    adaptivePosition: boolean;
    /** tooltip placement, supported positions: 'top', 'bottom', 'left', 'right' */
    placement: string;
    /** array of event names which triggers tooltip opening */
    triggers: string;
    /** a selector specifying the element the tooltip should be appended to. */
    container?: string;
    /** delay before showing the tooltip */
    delay: number;
    static ɵfac: i0.ɵɵFactoryDeclaration<TooltipConfig, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<TooltipConfig>;
}

declare class TooltipContainerComponent implements AfterViewInit {
    classMap?: {
        [key: string]: boolean;
    };
    placement?: string;
    containerClass?: string;
    animation?: boolean;
    id?: string;
    get _bsVersions(): IBsVersion;
    constructor(config: TooltipConfig);
    ngAfterViewInit(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<TooltipContainerComponent, never>;
    static ɵcmp: i0.ɵɵComponentDeclaration<TooltipContainerComponent, "bs-tooltip-container", never, {}, {}, never, ["*"], true, never>;
}

declare class TooltipDirective implements OnInit, OnDestroy {
    private _elementRef;
    private _renderer;
    private _positionService;
    tooltipId: number;
    /** sets disable adaptive position */
    adaptivePosition: boolean;
    /**
     * Content to be displayed as tooltip.
     */
    tooltip?: string | TemplateRef<unknown>;
    /** Fired when tooltip content changes */
    tooltipChange: EventEmitter<string | TemplateRef<unknown>>;
    /**
     * Placement of a tooltip. Accepts: "top", "bottom", "left", "right"
     */
    placement: AvailableBSPositions;
    /**
     * Specifies events that should trigger. Supports a space separated list of
     * event names.
     */
    triggers: string;
    /**
     * A selector specifying the element the tooltip should be appended to.
     */
    container?: string;
    /**
     * Css class for tooltip container
     */
    containerClass: string;
    boundariesElement?: 'viewport' | 'scrollParent' | 'window';
    /**
     * Returns whether or not the tooltip is currently being shown
     */
    get isOpen(): boolean;
    set isOpen(value: boolean);
    /**
     * Allows to disable tooltip
     */
    isDisabled: boolean;
    /**
     * Delay before showing the tooltip
     */
    delay: number;
    /**
     * Emits an event when the tooltip is shown
     */
    onShown: EventEmitter<unknown>;
    /**
     * Emits an event when the tooltip is hidden
     */
    onHidden: EventEmitter<unknown>;
    /** @deprecated - please use `tooltip` instead */
    set htmlContent(value: string | TemplateRef<unknown>);
    /** @deprecated - please use `placement` instead */
    set _placement(value: AvailableBSPositions);
    /** @deprecated - please use `isOpen` instead */
    set _isOpen(value: boolean);
    get _isOpen(): boolean;
    /** @deprecated - please use `isDisabled` instead */
    set _enable(value: boolean);
    get _enable(): boolean;
    /** @deprecated - please use `container="body"` instead */
    set _appendToBody(value: boolean);
    get _appendToBody(): boolean;
    /** @deprecated - removed, will be added to configuration */
    tooltipAnimation: boolean;
    /** @deprecated - will replaced with customClass */
    set _popupClass(value: string);
    /** @deprecated - removed */
    set _tooltipContext(value: undefined);
    /** @deprecated */
    set _tooltipPopupDelay(value: number);
    /** @deprecated */
    tooltipFadeDuration: number;
    /** @deprecated -  please use `triggers` instead */
    get _tooltipTrigger(): string | string[];
    set _tooltipTrigger(value: string | string[]);
    /** @deprecated */
    tooltipStateChanged: EventEmitter<boolean>;
    protected _delayTimeoutId?: number;
    protected _tooltipCancelShowFn?: () => void;
    private _tooltip;
    private _delaySubscription?;
    private _ariaDescribedby?;
    constructor(_viewContainerRef: ViewContainerRef, cis: ComponentLoaderFactory, config: TooltipConfig, _elementRef: ElementRef, _renderer: Renderer2, _positionService: PositioningService);
    ngOnInit(): void;
    setAriaDescribedBy(): void;
    /**
     * Toggles an element’s tooltip. This is considered a “manual” triggering of
     * the tooltip.
     */
    toggle(): void;
    /**
     * Opens an element’s tooltip. This is considered a “manual” triggering of
     * the tooltip.
     */
    show(): void;
    /**
     * Closes an element’s tooltip. This is considered a “manual” triggering of
     * the tooltip.
     */
    hide(): void;
    ngOnDestroy(): void;
    static ɵfac: i0.ɵɵFactoryDeclaration<TooltipDirective, never>;
    static ɵdir: i0.ɵɵDirectiveDeclaration<TooltipDirective, "[tooltip], [tooltipHtml]", ["bs-tooltip"], { "adaptivePosition": { "alias": "adaptivePosition"; "required": false; }; "tooltip": { "alias": "tooltip"; "required": false; }; "placement": { "alias": "placement"; "required": false; }; "triggers": { "alias": "triggers"; "required": false; }; "container": { "alias": "container"; "required": false; }; "containerClass": { "alias": "containerClass"; "required": false; }; "boundariesElement": { "alias": "boundariesElement"; "required": false; }; "isOpen": { "alias": "isOpen"; "required": false; }; "isDisabled": { "alias": "isDisabled"; "required": false; }; "delay": { "alias": "delay"; "required": false; }; "htmlContent": { "alias": "tooltipHtml"; "required": false; }; "_placement": { "alias": "tooltipPlacement"; "required": false; }; "_isOpen": { "alias": "tooltipIsOpen"; "required": false; }; "_enable": { "alias": "tooltipEnable"; "required": false; }; "_appendToBody": { "alias": "tooltipAppendToBody"; "required": false; }; "tooltipAnimation": { "alias": "tooltipAnimation"; "required": false; }; "_popupClass": { "alias": "tooltipClass"; "required": false; }; "_tooltipContext": { "alias": "tooltipContext"; "required": false; }; "_tooltipPopupDelay": { "alias": "tooltipPopupDelay"; "required": false; }; "tooltipFadeDuration": { "alias": "tooltipFadeDuration"; "required": false; }; "_tooltipTrigger": { "alias": "tooltipTrigger"; "required": false; }; }, { "tooltipChange": "tooltipChange"; "onShown": "onShown"; "onHidden": "onHidden"; "tooltipStateChanged": "tooltipStateChanged"; }, never, never, true, never>;
}

declare class TooltipModule {
    static forRoot(): ModuleWithProviders<TooltipModule>;
    static ɵfac: i0.ɵɵFactoryDeclaration<TooltipModule, never>;
    static ɵmod: i0.ɵɵNgModuleDeclaration<TooltipModule, never, [typeof i1.CommonModule, typeof TooltipDirective, typeof TooltipContainerComponent], [typeof TooltipDirective]>;
    static ɵinj: i0.ɵɵInjectorDeclaration<TooltipModule>;
}

export { TooltipConfig, TooltipContainerComponent, TooltipDirective, TooltipModule };