82 lines
2.8 KiB
TypeScript
82 lines
2.8 KiB
TypeScript
|
/**
|
||
|
|
* @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.dev/license
|
||
|
|
*/
|
||
|
|
|
||
|
|
import {
|
||
|
|
ComponentHarness,
|
||
|
|
ComponentHarnessConstructor,
|
||
|
|
HarnessPredicate,
|
||
|
|
} from '@angular/cdk/testing';
|
||
|
|
import {TooltipHarnessFilters} from './tooltip-harness-filters';
|
||
|
|
|
||
|
|
/** Harness for interacting with a mat-tooltip in tests. */
|
||
|
|
export class MatTooltipHarness extends ComponentHarness {
|
||
|
|
static hostSelector = '.mat-mdc-tooltip-trigger';
|
||
|
|
|
||
|
|
private _optionalPanel = this.documentRootLocatorFactory().locatorForOptional('.mat-mdc-tooltip');
|
||
|
|
private _hiddenClass = 'mat-mdc-tooltip-hide';
|
||
|
|
private _disabledClass = 'mat-mdc-tooltip-disabled';
|
||
|
|
private _showAnimationName = 'mat-mdc-tooltip-show';
|
||
|
|
private _hideAnimationName = 'mat-mdc-tooltip-hide';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets a `HarnessPredicate` that can be used to search for a tooltip trigger with specific
|
||
|
|
* attributes.
|
||
|
|
* @param options Options for narrowing the search.
|
||
|
|
* @return a `HarnessPredicate` configured with the given options.
|
||
|
|
*/
|
||
|
|
static with<T extends MatTooltipHarness>(
|
||
|
|
this: ComponentHarnessConstructor<T>,
|
||
|
|
options: TooltipHarnessFilters = {},
|
||
|
|
): HarnessPredicate<T> {
|
||
|
|
return new HarnessPredicate(this, options);
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Shows the tooltip. */
|
||
|
|
async show(): Promise<void> {
|
||
|
|
const host = await this.host();
|
||
|
|
|
||
|
|
// We need to dispatch both `touchstart` and a hover event, because the tooltip binds
|
||
|
|
// different events depending on the device. The `changedTouches` is there in case the
|
||
|
|
// element has ripples.
|
||
|
|
await host.dispatchEvent('touchstart', {changedTouches: []});
|
||
|
|
await host.hover();
|
||
|
|
const panel = await this._optionalPanel();
|
||
|
|
await panel?.dispatchEvent('animationend', {animationName: this._showAnimationName});
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Hides the tooltip. */
|
||
|
|
async hide(): Promise<void> {
|
||
|
|
const host = await this.host();
|
||
|
|
|
||
|
|
// We need to dispatch both `touchstart` and a hover event, because
|
||
|
|
// the tooltip binds different events depending on the device.
|
||
|
|
await host.dispatchEvent('touchend');
|
||
|
|
await host.mouseAway();
|
||
|
|
const panel = await this._optionalPanel();
|
||
|
|
await panel?.dispatchEvent('animationend', {animationName: this._hideAnimationName});
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Gets whether the tooltip is open. */
|
||
|
|
async isOpen(): Promise<boolean> {
|
||
|
|
const panel = await this._optionalPanel();
|
||
|
|
return !!panel && !(await panel.hasClass(this._hiddenClass));
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Gets whether the tooltip is disabled */
|
||
|
|
async isDisabled(): Promise<boolean> {
|
||
|
|
const host = await this.host();
|
||
|
|
return host.hasClass(this._disabledClass);
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Gets a promise for the tooltip panel's text. */
|
||
|
|
async getTooltipText(): Promise<string> {
|
||
|
|
const panel = await this._optionalPanel();
|
||
|
|
return panel ? panel.text() : '';
|
||
|
|
}
|
||
|
|
}
|