/** * @license * Copyright Google LLC All Rights Reserved. * * Use of this source code is governed by an MIT-style license that can be * found in the LICENSE file at https://angular.io/license */ import { AnimationEvent } from '@angular/animations'; import { AriaDescriber, FocusMonitor } from '@angular/cdk/a11y'; import { Directionality } from '@angular/cdk/bidi'; import { BooleanInput, NumberInput } from '@angular/cdk/coercion'; import { BreakpointObserver, BreakpointState } from '@angular/cdk/layout'; import { ConnectedPosition, OriginConnectionPosition, Overlay, OverlayConnectionPosition, OverlayRef, ScrollStrategy } from '@angular/cdk/overlay'; import { Platform } from '@angular/cdk/platform'; import { ComponentType } from '@angular/cdk/portal'; import { ScrollDispatcher } from '@angular/cdk/scrolling'; import { ChangeDetectorRef, ElementRef, InjectionToken, NgZone, OnDestroy, ViewContainerRef, AfterViewInit } from '@angular/core'; import { Observable } from 'rxjs'; /** Possible positions for a tooltip. */ export declare type TooltipPosition = 'left' | 'right' | 'above' | 'below' | 'before' | 'after'; /** * Options for how the tooltip trigger should handle touch gestures. * See `MatTooltip.touchGestures` for more information. */ export declare type TooltipTouchGestures = 'auto' | 'on' | 'off'; /** Possible visibility states of a tooltip. */ export declare type TooltipVisibility = 'initial' | 'visible' | 'hidden'; /** Time in ms to throttle repositioning after scroll events. */ export declare const SCROLL_THROTTLE_MS = 20; /** * CSS class that will be attached to the overlay panel. * @deprecated * @breaking-change 13.0.0 remove this variable */ export declare const TOOLTIP_PANEL_CLASS = "mat-tooltip-panel"; /** * Creates an error to be thrown if the user supplied an invalid tooltip position. * @docs-private */ export declare function getMatTooltipInvalidPositionError(position: string): Error; /** Injection token that determines the scroll handling while a tooltip is visible. */ export declare const MAT_TOOLTIP_SCROLL_STRATEGY: InjectionToken<() => ScrollStrategy>; /** @docs-private */ export declare function MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY(overlay: Overlay): () => ScrollStrategy; /** @docs-private */ export declare const MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY_PROVIDER: { provide: InjectionToken<() => ScrollStrategy>; deps: (typeof Overlay)[]; useFactory: typeof MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY; }; /** Default `matTooltip` options that can be overridden. */ export interface MatTooltipDefaultOptions { showDelay: number; hideDelay: number; touchendHideDelay: number; touchGestures?: TooltipTouchGestures; position?: TooltipPosition; } /** Injection token to be used to override the default options for `matTooltip`. */ export declare const MAT_TOOLTIP_DEFAULT_OPTIONS: InjectionToken; /** @docs-private */ export declare function MAT_TOOLTIP_DEFAULT_OPTIONS_FACTORY(): MatTooltipDefaultOptions; export declare abstract class _MatTooltipBase implements OnDestroy, AfterViewInit { private _overlay; private _elementRef; private _scrollDispatcher; private _viewContainerRef; private _ngZone; private _platform; private _ariaDescriber; private _focusMonitor; protected _dir: Directionality; private _defaultOptions; _overlayRef: OverlayRef | null; _tooltipInstance: T | null; private _portal; private _position; private _disabled; private _tooltipClass; private _scrollStrategy; private _viewInitialized; private _pointerExitEventsInitialized; protected abstract readonly _tooltipComponent: ComponentType; protected _viewportMargin: number; private _currentPosition; protected readonly _cssClassPrefix: string; /** Allows the user to define the position of the tooltip relative to the parent element */ get position(): TooltipPosition; set position(value: TooltipPosition); /** Disables the display of the tooltip. */ get disabled(): boolean; set disabled(value: boolean); /** The default delay in ms before showing the tooltip after show is called */ showDelay: number; /** The default delay in ms before hiding the tooltip after hide is called */ hideDelay: number; /** * How touch gestures should be handled by the tooltip. On touch devices the tooltip directive * uses a long press gesture to show and hide, however it can conflict with the native browser * gestures. To work around the conflict, Angular Material disables native gestures on the * trigger, but that might not be desirable on particular elements (e.g. inputs and draggable * elements). The different values for this option configure the touch event handling as follows: * - `auto` - Enables touch gestures for all elements, but tries to avoid conflicts with native * browser gestures on particular elements. In particular, it allows text selection on inputs * and textareas, and preserves the native browser dragging on elements marked as `draggable`. * - `on` - Enables touch gestures for all elements and disables native * browser gestures with no exceptions. * - `off` - Disables touch gestures. Note that this will prevent the tooltip from * showing on touch devices. */ touchGestures: TooltipTouchGestures; /** The message to be displayed in the tooltip */ get message(): string; set message(value: string); private _message; /** Classes to be passed to the tooltip. Supports the same syntax as `ngClass`. */ get tooltipClass(): string | string[] | Set | { [key: string]: any; }; set tooltipClass(value: string | string[] | Set | { [key: string]: any; }); /** Manually-bound passive event listeners. */ private readonly _passiveListeners; /** Reference to the current document. */ private _document; /** Timer started at the last `touchstart` event. */ private _touchstartTimeout; /** Emits when the component is destroyed. */ private readonly _destroyed; constructor(_overlay: Overlay, _elementRef: ElementRef, _scrollDispatcher: ScrollDispatcher, _viewContainerRef: ViewContainerRef, _ngZone: NgZone, _platform: Platform, _ariaDescriber: AriaDescriber, _focusMonitor: FocusMonitor, scrollStrategy: any, _dir: Directionality, _defaultOptions: MatTooltipDefaultOptions, _document: any); ngAfterViewInit(): void; /** * Dispose the tooltip when destroyed. */ ngOnDestroy(): void; /** Shows the tooltip after the delay in ms, defaults to tooltip-delay-show or 0ms if no input */ show(delay?: number): void; /** Hides the tooltip after the delay in ms, defaults to tooltip-delay-hide or 0ms if no input */ hide(delay?: number): void; /** Shows/hides the tooltip */ toggle(): void; /** Returns true if the tooltip is currently visible to the user */ _isTooltipVisible(): boolean; /** * Handles the keydown events on the host element. * Needs to be an arrow function so that we can use it in addEventListener. */ private _handleKeydown; /** Create the overlay config and position strategy */ private _createOverlay; /** Detaches the currently-attached tooltip. */ private _detach; /** Updates the position of the current tooltip. */ private _updatePosition; /** Adds the configured offset to a position. Used as a hook for child classes. */ protected _addOffset(position: ConnectedPosition): ConnectedPosition; /** * Returns the origin position and a fallback position based on the user's position preference. * The fallback position is the inverse of the origin (e.g. `'below' -> 'above'`). */ _getOrigin(): { main: OriginConnectionPosition; fallback: OriginConnectionPosition; }; /** Returns the overlay position and a fallback position based on the user's preference */ _getOverlayPosition(): { main: OverlayConnectionPosition; fallback: OverlayConnectionPosition; }; /** Updates the tooltip message and repositions the overlay according to the new message length */ private _updateTooltipMessage; /** Updates the tooltip class */ private _setTooltipClass; /** Inverts an overlay position. */ private _invertPosition; /** Updates the class on the overlay panel based on the current position of the tooltip. */ private _updateCurrentPositionClass; /** Binds the pointer events to the tooltip trigger. */ private _setupPointerEnterEventsIfNeeded; private _setupPointerExitEventsIfNeeded; private _addListeners; private _platformSupportsMouseEvents; /** Listener for the `wheel` event on the element. */ private _wheelListener; /** Disables the native browser gestures, based on how the tooltip has been configured. */ private _disableNativeGesturesIfNecessary; static ngAcceptInputType_disabled: BooleanInput; static ngAcceptInputType_hideDelay: NumberInput; static ngAcceptInputType_showDelay: NumberInput; } /** * Directive that attaches a material design tooltip to the host element. Animates the showing and * hiding of a tooltip provided position (defaults to below the element). * * https://material.io/design/components/tooltips.html */ export declare class MatTooltip extends _MatTooltipBase { protected readonly _tooltipComponent: typeof TooltipComponent; constructor(overlay: Overlay, elementRef: ElementRef, scrollDispatcher: ScrollDispatcher, viewContainerRef: ViewContainerRef, ngZone: NgZone, platform: Platform, ariaDescriber: AriaDescriber, focusMonitor: FocusMonitor, scrollStrategy: any, dir: Directionality, defaultOptions: MatTooltipDefaultOptions, _document: any); } export declare abstract class _TooltipComponentBase implements OnDestroy { private _changeDetectorRef; /** Message to display in the tooltip */ message: string; /** Classes to be added to the tooltip. Supports the same syntax as `ngClass`. */ tooltipClass: string | string[] | Set | { [key: string]: any; }; /** The timeout ID of any current timer set to show the tooltip */ _showTimeoutId: number | undefined; /** The timeout ID of any current timer set to hide the tooltip */ _hideTimeoutId: number | undefined; /** Property watched by the animation framework to show or hide the tooltip */ _visibility: TooltipVisibility; /** Whether interactions on the page should close the tooltip */ private _closeOnInteraction; /** Subject for notifying that the tooltip has been hidden from the view */ private readonly _onHide; constructor(_changeDetectorRef: ChangeDetectorRef); /** * Shows the tooltip with an animation originating from the provided origin * @param delay Amount of milliseconds to the delay showing the tooltip. */ show(delay: number): void; /** * Begins the animation to hide the tooltip after the provided delay in ms. * @param delay Amount of milliseconds to delay showing the tooltip. */ hide(delay: number): void; /** Returns an observable that notifies when the tooltip has been hidden from view. */ afterHidden(): Observable; /** Whether the tooltip is being displayed. */ isVisible(): boolean; ngOnDestroy(): void; _animationStart(): void; _animationDone(event: AnimationEvent): void; /** * Interactions on the HTML body should close the tooltip immediately as defined in the * material design spec. * https://material.io/design/components/tooltips.html#behavior */ _handleBodyInteraction(): void; /** * Marks that the tooltip needs to be checked in the next change detection run. * Mainly used for rendering the initial text before positioning a tooltip, which * can be problematic in components with OnPush change detection. */ _markForCheck(): void; /** * Callback for when the timeout in this.show() gets completed. * This method is only needed by the mdc-tooltip, and so it is only implemented * in the mdc-tooltip, not here. */ protected _onShow(): void; } /** * Internal component that wraps the tooltip's content. * @docs-private */ export declare class TooltipComponent extends _TooltipComponentBase { private _breakpointObserver; /** Stream that emits whether the user has a handset-sized display. */ _isHandset: Observable; constructor(changeDetectorRef: ChangeDetectorRef, _breakpointObserver: BreakpointObserver); }