index.api.md

API Report File for "@angular/material_tooltip"

Do not edit this file. It is a report generated by API Extractor.

import { AfterViewInit } from '@angular/core';
import { BooleanInput } from '@angular/cdk/coercion';
import { ConnectedPosition } from '@angular/cdk/overlay';
import { Directionality } from '@angular/cdk/bidi';
import { ElementRef } from '@angular/core';
import * as i0 from '@angular/core';
import * as i1 from '@angular/cdk/a11y';
import * as i1_2 from '@angular/cdk/bidi';
import * as i2 from '@angular/cdk/overlay';
import * as i5 from '@angular/cdk/scrolling';
import { InjectionToken } from '@angular/core';
import { NumberInput } from '@angular/cdk/coercion';
import { Observable } from 'rxjs';
import { OnDestroy } from '@angular/core';
import { OriginConnectionPosition } from '@angular/cdk/overlay';
import { Overlay } from '@angular/cdk/overlay';
import { OverlayConnectionPosition } from '@angular/cdk/overlay';
import { OverlayRef } from '@angular/cdk/overlay';
import { ScrollStrategy } from '@angular/cdk/overlay';

// @public
export function getMatTooltipInvalidPositionError(position: string): Error;

// @public
export const MAT_TOOLTIP_DEFAULT_OPTIONS: InjectionToken<MatTooltipDefaultOptions>;

// @public @deprecated
export function MAT_TOOLTIP_DEFAULT_OPTIONS_FACTORY(): MatTooltipDefaultOptions;

// @public
export const MAT_TOOLTIP_SCROLL_STRATEGY: InjectionToken<() => ScrollStrategy>;

// @public @deprecated
export function MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY(overlay: Overlay): () => ScrollStrategy;

// @public @deprecated
export const MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY_PROVIDER: {
    provide: InjectionToken<() => ScrollStrategy>;
    deps: (typeof Overlay)[];
    useFactory: typeof MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY;
};

// @public
export class MatTooltip implements OnDestroy, AfterViewInit {
    constructor(...args: unknown[]);
    protected _addOffset(position: ConnectedPosition): ConnectedPosition;
    // (undocumented)
    protected _dir: Directionality;
    get disabled(): boolean;
    set disabled(value: BooleanInput);
    _getOrigin(): {
        main: OriginConnectionPosition;
        fallback: OriginConnectionPosition;
    };
    _getOverlayPosition(): {
        main: OverlayConnectionPosition;
        fallback: OverlayConnectionPosition;
    };
    hide(delay?: number): void;
    get hideDelay(): number;
    set hideDelay(value: NumberInput);
    _isTooltipVisible(): boolean;
    get message(): string;
    set message(value: string | null | undefined);
    // (undocumented)
    ngAfterViewInit(): void;
    ngOnDestroy(): void;
    // (undocumented)
    _overlayRef: OverlayRef | null;
    get position(): TooltipPosition;
    set position(value: TooltipPosition);
    get positionAtOrigin(): boolean;
    set positionAtOrigin(value: BooleanInput);
    show(delay?: number, origin?: {
        x: number;
        y: number;
    }): void;
    get showDelay(): number;
    set showDelay(value: NumberInput);
    toggle(origin?: {
        x: number;
        y: number;
    }): void;
    get tooltipClass(): string | string[] | Set<string> | {
        [key: string]: unknown;
    };
    set tooltipClass(value: string | string[] | Set<string> | {
        [key: string]: unknown;
    });
    // (undocumented)
    _tooltipInstance: TooltipComponent | null;
    touchGestures: TooltipTouchGestures;
    // (undocumented)
    static ɵdir: i0.ɵɵDirectiveDeclaration<MatTooltip, "[matTooltip]", ["matTooltip"], { "position": { "alias": "matTooltipPosition"; "required": false; }; "positionAtOrigin": { "alias": "matTooltipPositionAtOrigin"; "required": false; }; "disabled": { "alias": "matTooltipDisabled"; "required": false; }; "showDelay": { "alias": "matTooltipShowDelay"; "required": false; }; "hideDelay": { "alias": "matTooltipHideDelay"; "required": false; }; "touchGestures": { "alias": "matTooltipTouchGestures"; "required": false; }; "message": { "alias": "matTooltip"; "required": false; }; "tooltipClass": { "alias": "matTooltipClass"; "required": false; }; }, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatTooltip, never>;
}

// @public @deprecated
export const matTooltipAnimations: {
    readonly tooltipState: any;
};

// @public
export interface MatTooltipDefaultOptions {
    disableTooltipInteractivity?: boolean;
    hideDelay: number;
    position?: TooltipPosition;
    positionAtOrigin?: boolean;
    showDelay: number;
    tooltipClass?: string | string[];
    touchendHideDelay: number;
    touchGestures?: TooltipTouchGestures;
    touchLongPressShowDelay?: number;
}

// @public (undocumented)
export class MatTooltipModule {
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<MatTooltipModule, never>;
    // (undocumented)
    static ɵinj: i0.ɵɵInjectorDeclaration<MatTooltipModule>;
    // (undocumented)
    static ɵmod: i0.ɵɵNgModuleDeclaration<MatTooltipModule, never, [typeof i1.A11yModule, typeof i2.OverlayModule, typeof MatCommonModule, typeof MatTooltip, typeof TooltipComponent], [typeof MatTooltip, typeof TooltipComponent, typeof MatCommonModule, typeof i5.CdkScrollableModule]>;
}

// @public
export const SCROLL_THROTTLE_MS = 20;

// @public @deprecated
export const TOOLTIP_PANEL_CLASS = "mat-mdc-tooltip-panel";

// @public
export class TooltipComponent implements OnDestroy {
    constructor(...args: unknown[]);
    afterHidden(): Observable<void>;
    _cancelPendingAnimations(): void;
    // (undocumented)
    protected _elementRef: ElementRef<HTMLElement>;
    _handleAnimationEnd({ animationName }: AnimationEvent): void;
    _handleBodyInteraction(): void;
    // (undocumented)
    _handleMouseLeave({ relatedTarget }: MouseEvent): void;
    hide(delay: number): void;
    // (undocumented)
    _isMultiline: boolean;
    isVisible(): boolean;
    _markForCheck(): void;
    message: string;
    _mouseLeaveHideDelay: number;
    // (undocumented)
    ngOnDestroy(): void;
    protected _onShow(): void;
    show(delay: number): void;
    _tooltip: ElementRef<HTMLElement>;
    tooltipClass: string | string[] | Set<string> | {
        [key: string]: unknown;
    };
    _triggerElement: HTMLElement;
    // (undocumented)
    static ɵcmp: i0.ɵɵComponentDeclaration<TooltipComponent, "mat-tooltip-component", never, {}, {}, never, never, true, never>;
    // (undocumented)
    static ɵfac: i0.ɵɵFactoryDeclaration<TooltipComponent, never>;
}

// @public
export type TooltipPosition = 'left' | 'right' | 'above' | 'below' | 'before' | 'after';

// @public
export type TooltipTouchGestures = 'auto' | 'on' | 'off';

// @public
export type TooltipVisibility = 'initial' | 'visible' | 'hidden';

// (No @packageDocumentation comment for this package)