API reference for Angular Material card-testing

import {MatCardHarness} from '@angular/material/card/testing';

Harness for interacting with a mat-card in tests.

Properties
Name Description

static hostSelector: '.mat-mdc-card'

The selector for the host element of a MatCard 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
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
getSubtitleText

Gets the cards's subtitle text.

Returns
Promise<string>

async
getText

Gets all of the card's content as text.

Returns
Promise<string>

async
getTitleText

Gets the cards's title text.

Returns
Promise<string>

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
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 card with specific attributes.

Parameters

options

CardHarnessFilters = {}

Options for filtering which card instances are considered a match.

Returns
HarnessPredicate<T>

a HarnessPredicate configured with the given options.

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

Properties
Name Description

subtitle: string | RegExp

Only find instances whose subtitle matches the given value.

text: string | RegExp

Only find instances whose text matches the given value.

title: string | RegExp

Only find instances whose title matches the given value.