sass-references/angular-material/material/table/testing/cell-harness.ts

102 lines
3.5 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 {
ComponentHarnessConstructor,
ContentContainerComponentHarness,
HarnessPredicate,
} from '@angular/cdk/testing';
import {CellHarnessFilters} from './table-harness-filters';
export abstract class _MatCellHarnessBase extends ContentContainerComponentHarness {
/** Gets the cell's text. */
async getText(): Promise<string> {
return (await this.host()).text();
}
/** Gets the name of the column that the cell belongs to. */
async getColumnName(): Promise<string> {
const host = await this.host();
const classAttribute = await host.getAttribute('class');
if (classAttribute) {
const prefix = 'mat-column-';
const name = classAttribute
.split(' ')
.map(c => c.trim())
.find(c => c.startsWith(prefix));
if (name) {
return name.split(prefix)[1];
}
}
throw Error('Could not determine column name of cell.');
}
protected static _getCellPredicate<T extends MatCellHarness>(
type: ComponentHarnessConstructor<T>,
options: CellHarnessFilters,
): HarnessPredicate<T> {
return new HarnessPredicate(type, options)
.addOption('text', options.text, (harness, text) =>
HarnessPredicate.stringMatches(harness.getText(), text),
)
.addOption('columnName', options.columnName, (harness, name) =>
HarnessPredicate.stringMatches(harness.getColumnName(), name),
);
}
}
/** Harness for interacting with an Angular Material table cell. */
export class MatCellHarness extends _MatCellHarnessBase {
/** The selector for the host element of a `MatCellHarness` instance. */
static hostSelector = '.mat-mdc-cell';
/**
* Gets a `HarnessPredicate` that can be used to search for a table cell with specific attributes.
* @param options Options for narrowing the search
* @return a `HarnessPredicate` configured with the given options.
*/
static with(options: CellHarnessFilters = {}): HarnessPredicate<MatCellHarness> {
return _MatCellHarnessBase._getCellPredicate(this, options);
}
}
/** Harness for interacting with an Angular Material table header cell. */
export class MatHeaderCellHarness extends _MatCellHarnessBase {
/** The selector for the host element of a `MatHeaderCellHarness` instance. */
static hostSelector = '.mat-mdc-header-cell';
/**
* Gets a `HarnessPredicate` that can be used to search for a table header cell with specific
* attributes.
* @param options Options for narrowing the search
* @return a `HarnessPredicate` configured with the given options.
*/
static with(options: CellHarnessFilters = {}): HarnessPredicate<MatHeaderCellHarness> {
return _MatCellHarnessBase._getCellPredicate(this, options);
}
}
/** Harness for interacting with an Angular Material table footer cell. */
export class MatFooterCellHarness extends _MatCellHarnessBase {
/** The selector for the host element of a `MatFooterCellHarness` instance. */
static hostSelector = '.mat-mdc-footer-cell';
/**
* Gets a `HarnessPredicate` that can be used to search for a table footer cell with specific
* attributes.
* @param options Options for narrowing the search
* @return a `HarnessPredicate` configured with the given options.
*/
static with(options: CellHarnessFilters = {}): HarnessPredicate<MatFooterCellHarness> {
return _MatCellHarnessBase._getCellPredicate(this, options);
}
}