API for grid-list

API reference for Angular Material grid-list

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

Selector: mat-grid-list

Exported as: matGridList
Properties
Name Description
@Input()

cols: number

Amount of columns in the grid list.

@Input()

gutterSize: string

Size of the grid list's gutter in pixels.

@Input()

rowHeight: string | number

Set internal representation of row height from the user-provided value.

Selector: mat-grid-tile

Exported as: matGridTile
Properties
Name Description
@Input()

colspan: number

Amount of columns that the grid tile takes up.

@Input()

rowspan: number

Amount of rows that the grid tile takes up.

Selector: mat-grid-tile-header mat-grid-tile-footer

const ɵTileCoordinator: typeof TileCoordinator;

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
getAllChildLoaders
Parameters

selector

S

Returns
Promise<HarnessLoader[]>

async
getAllHarnesses
Parameters

query

HarnessQuery<T>

Returns
Promise<T[]>

async
getChildLoader
Parameters

selector

S

Returns
Promise<HarnessLoader>

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
Parameters

query

HarnessQuery<T>

Returns
Promise<T>

async
getHarnessOrNull
Parameters

query

HarnessQuery<T>

Returns
Promise<T | null>

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
Parameters

query

HarnessQuery<T>

Returns
Promise<boolean>

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.

Azure & Blue theme selected.