API reference for Angular Material grid-list-testing

import {MatGridTileHarness} from '@angular/material/grid-list/testing';

Harness for interacting with a standard MatGridTitle in tests.

Properties
Name Description

static hostSelector: '.mat-grid-tile'

The selector for the host element of a MatGridTile instance.
Methods
async
countHarnesses

Returns the number of matching harnesses for the given query within the current harness's content.
Parameters

query

HarnessQuery<T>

The harness query to search for.
Returns
Promise<number>

The number of matching harnesses for the given query.
async
getAllChildLoaders

Gets a list of HarnessLoader for each element matching the given selector under the current harness's cotnent that searches for harnesses under that element.
Parameters

selector

S

The selector for elements in the component's content.
Returns
Promise<HarnessLoader[]>

A list of HarnessLoader for each element matching the given selector.
async
getAllHarnesses

Gets all matching harnesses for the given query within the current harness's content.
Parameters

query

HarnessQuery<T>

The harness query to search for.
Returns
Promise<T[]>

The list of harness matching the given query.
async
getChildLoader

Gets a HarnessLoader that searches for harnesses under the first element matching the given selector within the current harness's content.
Parameters

selector

S

The selector for an element in the component's content.
Returns
Promise<HarnessLoader>

A HarnessLoader that searches for harnesses under the given selector.
async
getColspan

Gets the amount of columns that the grid-tile takes up.
Returns
Promise<number>

async
getFooterText

Gets the text of the footer if present.
Returns
Promise<string | null>

async
getHarness

Gets the first matching harness for the given query within the current harness's content.
Parameters

query

HarnessQuery<T>

The harness query to search for.
Returns
Promise<T>

The first harness matching the given query.
async
getHarnessAtIndex

Gets a matching harness for the given query and index within the current harness's content.
Parameters

query

HarnessQuery<T>

The harness query to search for.

index

number

The zero-indexed offset of the component to find.
Returns
Promise<T>

The first harness matching the given query.
async
getHarnessOrNull

Gets the first matching harness for the given query within the current harness's content.
Parameters

query

HarnessQuery<T>

The harness query to search for.
Returns
Promise<T | null>

The first harness matching the given query, or null if none is found.
async
getHeaderText

Gets the text of the header if present.
Returns
Promise<string | null>

async
getRowspan

Gets the amount of rows that the grid-tile takes up.
Returns
Promise<number>

async
hasAvatar

Whether the grid-tile has an avatar.
Returns
Promise<boolean>

async
hasFooter

Whether the grid-tile has a footer.
Returns
Promise<boolean>

async
hasHarness

Checks whether there is a matching harnesses for the given query within the current harness's content.
Parameters

query

HarnessQuery<T>

The harness query to search for.
Returns
Promise<boolean>

Whether there is matching harnesses for the given query.
async
hasHeader

Whether the grid-tile has a header.
Returns
Promise<boolean>

async
host

Gets a Promise for the TestElement representing the host element of the component.
Returns
Promise<TestElement>

static
with

Gets a HarnessPredicate that can be used to search for a MatGridTileHarness that meets certain criteria.
Parameters

options

GridTileHarnessFilters = {}

Options for filtering which dialog instances are considered a match.
Returns
HarnessPredicate<MatGridTileHarness>

a HarnessPredicate configured with the given options.

Harness for interacting with a standard MatGridList in tests.

Properties
Name Description

static hostSelector: '.mat-grid-list'

The selector for the host element of a MatGridList instance.
Methods
async
getColumns

Gets the amount of columns of the grid-list.
Returns
Promise<number>

async
getTileAtPosition

Gets a tile of the grid-list that is located at the given location.
Parameters

row

Zero-based row index.

column

Zero-based column index.

__0

{ row: number; column: number; }

Returns
Promise<MatGridTileHarness>

async
getTiles

Gets all tiles of the grid-list.
Parameters

filters

GridTileHarnessFilters = {}

Returns
Promise<MatGridTileHarness[]>

async
host

Gets a Promise for the TestElement representing the host element of the component.
Returns
Promise<TestElement>

static
with

Gets a HarnessPredicate that can be used to search for a MatGridListHarness that meets certain criteria.
Parameters

options

GridListHarnessFilters = {}

Options for filtering which dialog instances are considered a match.
Returns
HarnessPredicate<MatGridListHarness>

a HarnessPredicate configured with the given options.

A set of criteria that can be used to filter a list of MatGridListHarness instances.

A set of criteria that can be used to filter a list of MatTileHarness instances.

Properties
Name Description

footerText: string | RegExp

Text the grid-tile footer should match.

headerText: string | RegExp

Text the grid-tile header should match.