@angular/material
Version:
Angular Material
1,148 lines (1,141 loc) • 39.9 kB
JavaScript
import { Overlay, OverlayModule } from '@angular/cdk/overlay';
import { AriaDescriber, FocusMonitor, A11yModule } from '@angular/cdk/a11y';
import { CommonModule } from '@angular/common';
import { InjectionToken, Directive, ElementRef, ViewContainerRef, NgZone, Inject, Optional, Input, Component, ViewEncapsulation, ChangeDetectionStrategy, ChangeDetectorRef, NgModule } from '@angular/core';
import { MatCommonModule } from '@angular/material/core';
import { Directionality } from '@angular/cdk/bidi';
import { coerceBooleanProperty } from '@angular/cdk/coercion';
import { ESCAPE, hasModifierKey } from '@angular/cdk/keycodes';
import { Breakpoints, BreakpointObserver } from '@angular/cdk/layout';
import { normalizePassiveListenerOptions, Platform } from '@angular/cdk/platform';
import { ComponentPortal } from '@angular/cdk/portal';
import { ScrollDispatcher } from '@angular/cdk/scrolling';
import { Subject } from 'rxjs';
import { takeUntil, take } from 'rxjs/operators';
import { trigger, state, style, transition, animate, keyframes } from '@angular/animations';
/**
* @fileoverview added by tsickle
* Generated from: src/material/tooltip/tooltip-animations.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* Animations used by MatTooltip.
* \@docs-private
* @type {?}
*/
const matTooltipAnimations = {
/**
* Animation that transitions a tooltip in and out.
*/
tooltipState: trigger('state', [
state('initial, void, hidden', style({ opacity: 0, transform: 'scale(0)' })),
state('visible', style({ transform: 'scale(1)' })),
transition('* => visible', animate('200ms cubic-bezier(0, 0, 0.2, 1)', keyframes([
style({ opacity: 0, transform: 'scale(0)', offset: 0 }),
style({ opacity: 0.5, transform: 'scale(0.99)', offset: 0.5 }),
style({ opacity: 1, transform: 'scale(1)', offset: 1 })
]))),
transition('* => hidden', animate('100ms cubic-bezier(0, 0, 0.2, 1)', style({ opacity: 0 }))),
])
};
/**
* @fileoverview added by tsickle
* Generated from: src/material/tooltip/tooltip.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* Time in ms to throttle repositioning after scroll events.
* @type {?}
*/
const SCROLL_THROTTLE_MS = 20;
/**
* CSS class that will be attached to the overlay panel.
* @type {?}
*/
const TOOLTIP_PANEL_CLASS = 'mat-tooltip-panel';
/**
* Options used to bind passive event listeners.
* @type {?}
*/
const passiveListenerOptions = normalizePassiveListenerOptions({ passive: true });
/**
* Time between the user putting the pointer on a tooltip
* trigger and the long press event being fired.
* @type {?}
*/
const LONGPRESS_DELAY = 500;
/**
* Creates an error to be thrown if the user supplied an invalid tooltip position.
* \@docs-private
* @param {?} position
* @return {?}
*/
function getMatTooltipInvalidPositionError(position) {
return Error(`Tooltip position "${position}" is invalid.`);
}
/**
* Injection token that determines the scroll handling while a tooltip is visible.
* @type {?}
*/
const MAT_TOOLTIP_SCROLL_STRATEGY = new InjectionToken('mat-tooltip-scroll-strategy');
/**
* \@docs-private
* @param {?} overlay
* @return {?}
*/
function MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY(overlay) {
return (/**
* @return {?}
*/
() => overlay.scrollStrategies.reposition({ scrollThrottle: SCROLL_THROTTLE_MS }));
}
/**
* \@docs-private
* @type {?}
*/
const MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY_PROVIDER = {
provide: MAT_TOOLTIP_SCROLL_STRATEGY,
deps: [Overlay],
useFactory: MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY,
};
/**
* Default `matTooltip` options that can be overridden.
* @record
*/
function MatTooltipDefaultOptions() { }
if (false) {
/** @type {?} */
MatTooltipDefaultOptions.prototype.showDelay;
/** @type {?} */
MatTooltipDefaultOptions.prototype.hideDelay;
/** @type {?} */
MatTooltipDefaultOptions.prototype.touchendHideDelay;
/** @type {?|undefined} */
MatTooltipDefaultOptions.prototype.touchGestures;
/** @type {?|undefined} */
MatTooltipDefaultOptions.prototype.position;
}
/**
* Injection token to be used to override the default options for `matTooltip`.
* @type {?}
*/
const MAT_TOOLTIP_DEFAULT_OPTIONS = new InjectionToken('mat-tooltip-default-options', {
providedIn: 'root',
factory: MAT_TOOLTIP_DEFAULT_OPTIONS_FACTORY
});
/**
* \@docs-private
* @return {?}
*/
function MAT_TOOLTIP_DEFAULT_OPTIONS_FACTORY() {
return {
showDelay: 0,
hideDelay: 0,
touchendHideDelay: 1500,
};
}
/**
* 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
*/
class MatTooltip {
/**
* @param {?} _overlay
* @param {?} _elementRef
* @param {?} _scrollDispatcher
* @param {?} _viewContainerRef
* @param {?} _ngZone
* @param {?} _platform
* @param {?} _ariaDescriber
* @param {?} _focusMonitor
* @param {?} scrollStrategy
* @param {?} _dir
* @param {?} _defaultOptions
* @param {?=} _hammerLoader
*/
constructor(_overlay, _elementRef, _scrollDispatcher, _viewContainerRef, _ngZone, _platform, _ariaDescriber, _focusMonitor, scrollStrategy, _dir, _defaultOptions,
/**
* @deprecated _hammerLoader parameter to be removed.
* @breaking-change 9.0.0
*/
// Note that we need to give Angular something to inject here so it doesn't throw.
_hammerLoader) {
this._overlay = _overlay;
this._elementRef = _elementRef;
this._scrollDispatcher = _scrollDispatcher;
this._viewContainerRef = _viewContainerRef;
this._ngZone = _ngZone;
this._platform = _platform;
this._ariaDescriber = _ariaDescriber;
this._focusMonitor = _focusMonitor;
this._dir = _dir;
this._defaultOptions = _defaultOptions;
this._position = 'below';
this._disabled = false;
/**
* The default delay in ms before showing the tooltip after show is called
*/
this.showDelay = this._defaultOptions.showDelay;
/**
* The default delay in ms before hiding the tooltip after hide is called
*/
this.hideDelay = this._defaultOptions.hideDelay;
/**
* 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.
*/
this.touchGestures = 'auto';
this._message = '';
/**
* Manually-bound passive event listeners.
*/
this._passiveListeners = new Map();
/**
* Emits when the component is destroyed.
*/
this._destroyed = new Subject();
/**
* Handles the keydown events on the host element.
* Needs to be an arrow function so that we can use it in addEventListener.
*/
this._handleKeydown = (/**
* @param {?} event
* @return {?}
*/
(event) => {
if (this._isTooltipVisible() && event.keyCode === ESCAPE && !hasModifierKey(event)) {
event.preventDefault();
event.stopPropagation();
this._ngZone.run((/**
* @return {?}
*/
() => this.hide(0)));
}
});
this._scrollStrategy = scrollStrategy;
if (_defaultOptions) {
if (_defaultOptions.position) {
this.position = _defaultOptions.position;
}
if (_defaultOptions.touchGestures) {
this.touchGestures = _defaultOptions.touchGestures;
}
}
_focusMonitor.monitor(_elementRef)
.pipe(takeUntil(this._destroyed))
.subscribe((/**
* @param {?} origin
* @return {?}
*/
origin => {
// Note that the focus monitor runs outside the Angular zone.
if (!origin) {
_ngZone.run((/**
* @return {?}
*/
() => this.hide(0)));
}
else if (origin === 'keyboard') {
_ngZone.run((/**
* @return {?}
*/
() => this.show()));
}
}));
_ngZone.runOutsideAngular((/**
* @return {?}
*/
() => {
_elementRef.nativeElement.addEventListener('keydown', this._handleKeydown);
}));
}
/**
* Allows the user to define the position of the tooltip relative to the parent element
* @return {?}
*/
get position() { return this._position; }
/**
* @param {?} value
* @return {?}
*/
set position(value) {
if (value !== this._position) {
this._position = value;
if (this._overlayRef) {
this._updatePosition();
if (this._tooltipInstance) {
(/** @type {?} */ (this._tooltipInstance)).show(0);
}
this._overlayRef.updatePosition();
}
}
}
/**
* Disables the display of the tooltip.
* @return {?}
*/
get disabled() { return this._disabled; }
/**
* @param {?} value
* @return {?}
*/
set disabled(value) {
this._disabled = coerceBooleanProperty(value);
// If tooltip is disabled, hide immediately.
if (this._disabled) {
this.hide(0);
}
}
/**
* The message to be displayed in the tooltip
* @return {?}
*/
get message() { return this._message; }
/**
* @param {?} value
* @return {?}
*/
set message(value) {
this._ariaDescriber.removeDescription(this._elementRef.nativeElement, this._message);
// If the message is not a string (e.g. number), convert it to a string and trim it.
this._message = value != null ? `${value}`.trim() : '';
if (!this._message && this._isTooltipVisible()) {
this.hide(0);
}
else {
this._updateTooltipMessage();
this._ngZone.runOutsideAngular((/**
* @return {?}
*/
() => {
// The `AriaDescriber` has some functionality that avoids adding a description if it's the
// same as the `aria-label` of an element, however we can't know whether the tooltip trigger
// has a data-bound `aria-label` or when it'll be set for the first time. We can avoid the
// issue by deferring the description by a tick so Angular has time to set the `aria-label`.
Promise.resolve().then((/**
* @return {?}
*/
() => {
this._ariaDescriber.describe(this._elementRef.nativeElement, this.message);
}));
}));
}
}
/**
* Classes to be passed to the tooltip. Supports the same syntax as `ngClass`.
* @return {?}
*/
get tooltipClass() { return this._tooltipClass; }
/**
* @param {?} value
* @return {?}
*/
set tooltipClass(value) {
this._tooltipClass = value;
if (this._tooltipInstance) {
this._setTooltipClass(this._tooltipClass);
}
}
/**
* Setup styling-specific things
* @return {?}
*/
ngOnInit() {
// This needs to happen in `ngOnInit` so the initial values for all inputs have been set.
this._setupPointerEvents();
}
/**
* Dispose the tooltip when destroyed.
* @return {?}
*/
ngOnDestroy() {
/** @type {?} */
const nativeElement = this._elementRef.nativeElement;
clearTimeout(this._touchstartTimeout);
if (this._overlayRef) {
this._overlayRef.dispose();
this._tooltipInstance = null;
}
// Clean up the event listeners set in the constructor
nativeElement.removeEventListener('keydown', this._handleKeydown);
this._passiveListeners.forEach((/**
* @param {?} listener
* @param {?} event
* @return {?}
*/
(listener, event) => {
nativeElement.removeEventListener(event, listener, passiveListenerOptions);
}));
this._passiveListeners.clear();
this._destroyed.next();
this._destroyed.complete();
this._ariaDescriber.removeDescription(nativeElement, this.message);
this._focusMonitor.stopMonitoring(nativeElement);
}
/**
* Shows the tooltip after the delay in ms, defaults to tooltip-delay-show or 0ms if no input
* @param {?=} delay
* @return {?}
*/
show(delay = this.showDelay) {
if (this.disabled || !this.message || (this._isTooltipVisible() &&
!(/** @type {?} */ (this._tooltipInstance))._showTimeoutId && !(/** @type {?} */ (this._tooltipInstance))._hideTimeoutId)) {
return;
}
/** @type {?} */
const overlayRef = this._createOverlay();
this._detach();
this._portal = this._portal || new ComponentPortal(TooltipComponent, this._viewContainerRef);
this._tooltipInstance = overlayRef.attach(this._portal).instance;
this._tooltipInstance.afterHidden()
.pipe(takeUntil(this._destroyed))
.subscribe((/**
* @return {?}
*/
() => this._detach()));
this._setTooltipClass(this._tooltipClass);
this._updateTooltipMessage();
(/** @type {?} */ (this._tooltipInstance)).show(delay);
}
/**
* Hides the tooltip after the delay in ms, defaults to tooltip-delay-hide or 0ms if no input
* @param {?=} delay
* @return {?}
*/
hide(delay = this.hideDelay) {
if (this._tooltipInstance) {
this._tooltipInstance.hide(delay);
}
}
/**
* Shows/hides the tooltip
* @return {?}
*/
toggle() {
this._isTooltipVisible() ? this.hide() : this.show();
}
/**
* Returns true if the tooltip is currently visible to the user
* @return {?}
*/
_isTooltipVisible() {
return !!this._tooltipInstance && this._tooltipInstance.isVisible();
}
/**
* Create the overlay config and position strategy
* @private
* @return {?}
*/
_createOverlay() {
if (this._overlayRef) {
return this._overlayRef;
}
/** @type {?} */
const scrollableAncestors = this._scrollDispatcher.getAncestorScrollContainers(this._elementRef);
// Create connected position strategy that listens for scroll events to reposition.
/** @type {?} */
const strategy = this._overlay.position()
.flexibleConnectedTo(this._elementRef)
.withTransformOriginOn('.mat-tooltip')
.withFlexibleDimensions(false)
.withViewportMargin(8)
.withScrollableContainers(scrollableAncestors);
strategy.positionChanges.pipe(takeUntil(this._destroyed)).subscribe((/**
* @param {?} change
* @return {?}
*/
change => {
if (this._tooltipInstance) {
if (change.scrollableViewProperties.isOverlayClipped && this._tooltipInstance.isVisible()) {
// After position changes occur and the overlay is clipped by
// a parent scrollable then close the tooltip.
this._ngZone.run((/**
* @return {?}
*/
() => this.hide(0)));
}
}
}));
this._overlayRef = this._overlay.create({
direction: this._dir,
positionStrategy: strategy,
panelClass: TOOLTIP_PANEL_CLASS,
scrollStrategy: this._scrollStrategy()
});
this._updatePosition();
this._overlayRef.detachments()
.pipe(takeUntil(this._destroyed))
.subscribe((/**
* @return {?}
*/
() => this._detach()));
return this._overlayRef;
}
/**
* Detaches the currently-attached tooltip.
* @private
* @return {?}
*/
_detach() {
if (this._overlayRef && this._overlayRef.hasAttached()) {
this._overlayRef.detach();
}
this._tooltipInstance = null;
}
/**
* Updates the position of the current tooltip.
* @private
* @return {?}
*/
_updatePosition() {
/** @type {?} */
const position = (/** @type {?} */ ((/** @type {?} */ (this._overlayRef)).getConfig().positionStrategy));
/** @type {?} */
const origin = this._getOrigin();
/** @type {?} */
const overlay = this._getOverlayPosition();
position.withPositions([
Object.assign(Object.assign({}, origin.main), overlay.main),
Object.assign(Object.assign({}, origin.fallback), overlay.fallback)
]);
}
/**
* 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'`).
* @return {?}
*/
_getOrigin() {
/** @type {?} */
const isLtr = !this._dir || this._dir.value == 'ltr';
/** @type {?} */
const position = this.position;
/** @type {?} */
let originPosition;
if (position == 'above' || position == 'below') {
originPosition = { originX: 'center', originY: position == 'above' ? 'top' : 'bottom' };
}
else if (position == 'before' ||
(position == 'left' && isLtr) ||
(position == 'right' && !isLtr)) {
originPosition = { originX: 'start', originY: 'center' };
}
else if (position == 'after' ||
(position == 'right' && isLtr) ||
(position == 'left' && !isLtr)) {
originPosition = { originX: 'end', originY: 'center' };
}
else {
throw getMatTooltipInvalidPositionError(position);
}
const { x, y } = this._invertPosition(originPosition.originX, originPosition.originY);
return {
main: originPosition,
fallback: { originX: x, originY: y }
};
}
/**
* Returns the overlay position and a fallback position based on the user's preference
* @return {?}
*/
_getOverlayPosition() {
/** @type {?} */
const isLtr = !this._dir || this._dir.value == 'ltr';
/** @type {?} */
const position = this.position;
/** @type {?} */
let overlayPosition;
if (position == 'above') {
overlayPosition = { overlayX: 'center', overlayY: 'bottom' };
}
else if (position == 'below') {
overlayPosition = { overlayX: 'center', overlayY: 'top' };
}
else if (position == 'before' ||
(position == 'left' && isLtr) ||
(position == 'right' && !isLtr)) {
overlayPosition = { overlayX: 'end', overlayY: 'center' };
}
else if (position == 'after' ||
(position == 'right' && isLtr) ||
(position == 'left' && !isLtr)) {
overlayPosition = { overlayX: 'start', overlayY: 'center' };
}
else {
throw getMatTooltipInvalidPositionError(position);
}
const { x, y } = this._invertPosition(overlayPosition.overlayX, overlayPosition.overlayY);
return {
main: overlayPosition,
fallback: { overlayX: x, overlayY: y }
};
}
/**
* Updates the tooltip message and repositions the overlay according to the new message length
* @private
* @return {?}
*/
_updateTooltipMessage() {
// Must wait for the message to be painted to the tooltip so that the overlay can properly
// calculate the correct positioning based on the size of the text.
if (this._tooltipInstance) {
this._tooltipInstance.message = this.message;
this._tooltipInstance._markForCheck();
this._ngZone.onMicrotaskEmpty.asObservable().pipe(take(1), takeUntil(this._destroyed)).subscribe((/**
* @return {?}
*/
() => {
if (this._tooltipInstance) {
(/** @type {?} */ (this._overlayRef)).updatePosition();
}
}));
}
}
/**
* Updates the tooltip class
* @private
* @param {?} tooltipClass
* @return {?}
*/
_setTooltipClass(tooltipClass) {
if (this._tooltipInstance) {
this._tooltipInstance.tooltipClass = tooltipClass;
this._tooltipInstance._markForCheck();
}
}
/**
* Inverts an overlay position.
* @private
* @param {?} x
* @param {?} y
* @return {?}
*/
_invertPosition(x, y) {
if (this.position === 'above' || this.position === 'below') {
if (y === 'top') {
y = 'bottom';
}
else if (y === 'bottom') {
y = 'top';
}
}
else {
if (x === 'end') {
x = 'start';
}
else if (x === 'start') {
x = 'end';
}
}
return { x, y };
}
/**
* Binds the pointer events to the tooltip trigger.
* @private
* @return {?}
*/
_setupPointerEvents() {
// The mouse events shouldn't be bound on mobile devices, because they can prevent the
// first tap from firing its click event or can cause the tooltip to open for clicks.
if (!this._platform.IOS && !this._platform.ANDROID) {
this._passiveListeners
.set('mouseenter', (/**
* @return {?}
*/
() => this.show()))
.set('mouseleave', (/**
* @return {?}
*/
() => this.hide()));
}
else if (this.touchGestures !== 'off') {
this._disableNativeGesturesIfNecessary();
/** @type {?} */
const touchendListener = (/**
* @return {?}
*/
() => {
clearTimeout(this._touchstartTimeout);
this.hide(this._defaultOptions.touchendHideDelay);
});
this._passiveListeners
.set('touchend', touchendListener)
.set('touchcancel', touchendListener)
.set('touchstart', (/**
* @return {?}
*/
() => {
// Note that it's important that we don't `preventDefault` here,
// because it can prevent click events from firing on the element.
clearTimeout(this._touchstartTimeout);
this._touchstartTimeout = setTimeout((/**
* @return {?}
*/
() => this.show()), LONGPRESS_DELAY);
}));
}
this._passiveListeners.forEach((/**
* @param {?} listener
* @param {?} event
* @return {?}
*/
(listener, event) => {
this._elementRef.nativeElement.addEventListener(event, listener, passiveListenerOptions);
}));
}
/**
* Disables the native browser gestures, based on how the tooltip has been configured.
* @private
* @return {?}
*/
_disableNativeGesturesIfNecessary() {
/** @type {?} */
const element = this._elementRef.nativeElement;
/** @type {?} */
const style = element.style;
/** @type {?} */
const gestures = this.touchGestures;
if (gestures !== 'off') {
// If gestures are set to `auto`, we don't disable text selection on inputs and
// textareas, because it prevents the user from typing into them on iOS Safari.
if (gestures === 'on' || (element.nodeName !== 'INPUT' && element.nodeName !== 'TEXTAREA')) {
style.userSelect = style.msUserSelect = style.webkitUserSelect =
((/** @type {?} */ (style))).MozUserSelect = 'none';
}
// If we have `auto` gestures and the element uses native HTML dragging,
// we don't set `-webkit-user-drag` because it prevents the native behavior.
if (gestures === 'on' || !element.draggable) {
((/** @type {?} */ (style))).webkitUserDrag = 'none';
}
style.touchAction = 'none';
style.webkitTapHighlightColor = 'transparent';
}
}
}
MatTooltip.decorators = [
{ type: Directive, args: [{
selector: '[matTooltip]',
exportAs: 'matTooltip',
},] }
];
/** @nocollapse */
MatTooltip.ctorParameters = () => [
{ type: Overlay },
{ type: ElementRef },
{ type: ScrollDispatcher },
{ type: ViewContainerRef },
{ type: NgZone },
{ type: Platform },
{ type: AriaDescriber },
{ type: FocusMonitor },
{ type: undefined, decorators: [{ type: Inject, args: [MAT_TOOLTIP_SCROLL_STRATEGY,] }] },
{ type: Directionality, decorators: [{ type: Optional }] },
{ type: undefined, decorators: [{ type: Optional }, { type: Inject, args: [MAT_TOOLTIP_DEFAULT_OPTIONS,] }] },
{ type: undefined, decorators: [{ type: Inject, args: [ElementRef,] }] }
];
MatTooltip.propDecorators = {
position: [{ type: Input, args: ['matTooltipPosition',] }],
disabled: [{ type: Input, args: ['matTooltipDisabled',] }],
showDelay: [{ type: Input, args: ['matTooltipShowDelay',] }],
hideDelay: [{ type: Input, args: ['matTooltipHideDelay',] }],
touchGestures: [{ type: Input, args: ['matTooltipTouchGestures',] }],
message: [{ type: Input, args: ['matTooltip',] }],
tooltipClass: [{ type: Input, args: ['matTooltipClass',] }]
};
if (false) {
/** @type {?} */
MatTooltip.ngAcceptInputType_disabled;
/** @type {?} */
MatTooltip.ngAcceptInputType_hideDelay;
/** @type {?} */
MatTooltip.ngAcceptInputType_showDelay;
/** @type {?} */
MatTooltip.prototype._overlayRef;
/** @type {?} */
MatTooltip.prototype._tooltipInstance;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._portal;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._position;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._disabled;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._tooltipClass;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._scrollStrategy;
/**
* The default delay in ms before showing the tooltip after show is called
* @type {?}
*/
MatTooltip.prototype.showDelay;
/**
* The default delay in ms before hiding the tooltip after hide is called
* @type {?}
*/
MatTooltip.prototype.hideDelay;
/**
* 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.
* @type {?}
*/
MatTooltip.prototype.touchGestures;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._message;
/**
* Manually-bound passive event listeners.
* @type {?}
* @private
*/
MatTooltip.prototype._passiveListeners;
/**
* Timer started at the last `touchstart` event.
* @type {?}
* @private
*/
MatTooltip.prototype._touchstartTimeout;
/**
* Emits when the component is destroyed.
* @type {?}
* @private
*/
MatTooltip.prototype._destroyed;
/**
* Handles the keydown events on the host element.
* Needs to be an arrow function so that we can use it in addEventListener.
* @type {?}
* @private
*/
MatTooltip.prototype._handleKeydown;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._overlay;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._elementRef;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._scrollDispatcher;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._viewContainerRef;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._ngZone;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._platform;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._ariaDescriber;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._focusMonitor;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._dir;
/**
* @type {?}
* @private
*/
MatTooltip.prototype._defaultOptions;
}
/**
* Internal component that wraps the tooltip's content.
* \@docs-private
*/
class TooltipComponent {
/**
* @param {?} _changeDetectorRef
* @param {?} _breakpointObserver
*/
constructor(_changeDetectorRef, _breakpointObserver) {
this._changeDetectorRef = _changeDetectorRef;
this._breakpointObserver = _breakpointObserver;
/**
* Property watched by the animation framework to show or hide the tooltip
*/
this._visibility = 'initial';
/**
* Whether interactions on the page should close the tooltip
*/
this._closeOnInteraction = false;
/**
* Subject for notifying that the tooltip has been hidden from the view
*/
this._onHide = new Subject();
/**
* Stream that emits whether the user has a handset-sized display.
*/
this._isHandset = this._breakpointObserver.observe(Breakpoints.Handset);
}
/**
* Shows the tooltip with an animation originating from the provided origin
* @param {?} delay Amount of milliseconds to the delay showing the tooltip.
* @return {?}
*/
show(delay) {
// Cancel the delayed hide if it is scheduled
if (this._hideTimeoutId) {
clearTimeout(this._hideTimeoutId);
this._hideTimeoutId = null;
}
// Body interactions should cancel the tooltip if there is a delay in showing.
this._closeOnInteraction = true;
this._showTimeoutId = setTimeout((/**
* @return {?}
*/
() => {
this._visibility = 'visible';
this._showTimeoutId = null;
// Mark for check so if any parent component has set the
// ChangeDetectionStrategy to OnPush it will be checked anyways
this._markForCheck();
}), delay);
}
/**
* Begins the animation to hide the tooltip after the provided delay in ms.
* @param {?} delay Amount of milliseconds to delay showing the tooltip.
* @return {?}
*/
hide(delay) {
// Cancel the delayed show if it is scheduled
if (this._showTimeoutId) {
clearTimeout(this._showTimeoutId);
this._showTimeoutId = null;
}
this._hideTimeoutId = setTimeout((/**
* @return {?}
*/
() => {
this._visibility = 'hidden';
this._hideTimeoutId = null;
// Mark for check so if any parent component has set the
// ChangeDetectionStrategy to OnPush it will be checked anyways
this._markForCheck();
}), delay);
}
/**
* Returns an observable that notifies when the tooltip has been hidden from view.
* @return {?}
*/
afterHidden() {
return this._onHide.asObservable();
}
/**
* Whether the tooltip is being displayed.
* @return {?}
*/
isVisible() {
return this._visibility === 'visible';
}
/**
* @return {?}
*/
ngOnDestroy() {
this._onHide.complete();
}
/**
* @return {?}
*/
_animationStart() {
this._closeOnInteraction = false;
}
/**
* @param {?} event
* @return {?}
*/
_animationDone(event) {
/** @type {?} */
const toState = (/** @type {?} */ (event.toState));
if (toState === 'hidden' && !this.isVisible()) {
this._onHide.next();
}
if (toState === 'visible' || toState === 'hidden') {
this._closeOnInteraction = true;
}
}
/**
* 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
* @return {?}
*/
_handleBodyInteraction() {
if (this._closeOnInteraction) {
this.hide(0);
}
}
/**
* 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.
* @return {?}
*/
_markForCheck() {
this._changeDetectorRef.markForCheck();
}
}
TooltipComponent.decorators = [
{ type: Component, args: [{
selector: 'mat-tooltip-component',
template: "<div class=\"mat-tooltip\"\n [ngClass]=\"tooltipClass\"\n [class.mat-tooltip-handset]=\"(_isHandset | async)?.matches\"\n [@state]=\"_visibility\"\n (@state.start)=\"_animationStart()\"\n (@state.done)=\"_animationDone($event)\">{{message}}</div>\n",
encapsulation: ViewEncapsulation.None,
changeDetection: ChangeDetectionStrategy.OnPush,
animations: [matTooltipAnimations.tooltipState],
host: {
// Forces the element to have a layout in IE and Edge. This fixes issues where the element
// won't be rendered if the animations are disabled or there is no web animations polyfill.
'[style.zoom]': '_visibility === "visible" ? 1 : null',
'(body:click)': 'this._handleBodyInteraction()',
'aria-hidden': 'true',
},
styles: [".mat-tooltip-panel{pointer-events:none !important}.mat-tooltip{color:#fff;border-radius:4px;margin:14px;max-width:250px;padding-left:8px;padding-right:8px;overflow:hidden;text-overflow:ellipsis}.cdk-high-contrast-active .mat-tooltip{outline:solid 1px}.mat-tooltip-handset{margin:24px;padding-left:16px;padding-right:16px}\n"]
}] }
];
/** @nocollapse */
TooltipComponent.ctorParameters = () => [
{ type: ChangeDetectorRef },
{ type: BreakpointObserver }
];
if (false) {
/**
* Message to display in the tooltip
* @type {?}
*/
TooltipComponent.prototype.message;
/**
* Classes to be added to the tooltip. Supports the same syntax as `ngClass`.
* @type {?}
*/
TooltipComponent.prototype.tooltipClass;
/**
* The timeout ID of any current timer set to show the tooltip
* @type {?}
*/
TooltipComponent.prototype._showTimeoutId;
/**
* The timeout ID of any current timer set to hide the tooltip
* @type {?}
*/
TooltipComponent.prototype._hideTimeoutId;
/**
* Property watched by the animation framework to show or hide the tooltip
* @type {?}
*/
TooltipComponent.prototype._visibility;
/**
* Whether interactions on the page should close the tooltip
* @type {?}
* @private
*/
TooltipComponent.prototype._closeOnInteraction;
/**
* Subject for notifying that the tooltip has been hidden from the view
* @type {?}
* @private
*/
TooltipComponent.prototype._onHide;
/**
* Stream that emits whether the user has a handset-sized display.
* @type {?}
*/
TooltipComponent.prototype._isHandset;
/**
* @type {?}
* @private
*/
TooltipComponent.prototype._changeDetectorRef;
/**
* @type {?}
* @private
*/
TooltipComponent.prototype._breakpointObserver;
}
/**
* @fileoverview added by tsickle
* Generated from: src/material/tooltip/tooltip-module.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
class MatTooltipModule {
}
MatTooltipModule.decorators = [
{ type: NgModule, args: [{
imports: [
A11yModule,
CommonModule,
OverlayModule,
MatCommonModule,
],
exports: [MatTooltip, TooltipComponent, MatCommonModule],
declarations: [MatTooltip, TooltipComponent],
entryComponents: [TooltipComponent],
providers: [MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY_PROVIDER]
},] }
];
/**
* @fileoverview added by tsickle
* Generated from: src/material/tooltip/public-api.ts
* @suppress {checkTypes,constantProperty,extraRequire,missingOverride,missingReturn,unusedPrivateMembers,uselessCode} checked by tsc
*/
/**
* Generated bundle index. Do not edit.
*/
export { MAT_TOOLTIP_DEFAULT_OPTIONS, MAT_TOOLTIP_DEFAULT_OPTIONS_FACTORY, MAT_TOOLTIP_SCROLL_STRATEGY, MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY, MAT_TOOLTIP_SCROLL_STRATEGY_FACTORY_PROVIDER, MatTooltip, MatTooltipModule, SCROLL_THROTTLE_MS, TOOLTIP_PANEL_CLASS, TooltipComponent, getMatTooltipInvalidPositionError, matTooltipAnimations };
//# sourceMappingURL=tooltip.js.map