Class List

A model for a List component. Use this for the results in an explorer station or explorer modal.

Hierarchy

Constructors

constructor

Properties

allVisibleRows emptyResultsMessage header root xpath

Methods

getChildOfType getLocator getRow getRowByPropertyValue getSortOrderOfProperty sortByProperty waitForData

Constructors

constructor

  • A model for a List component. Use this for the results in an explorer station or explorer modal.

    Parameters

    • parent: Page | FrameLocator | ComponentModel

      The parent playwright page, frame or component model.

    • xpath: string = '//*[@data-test-id="list"]'

      A relative xpath selector to this element from the parent.

    Returns List

Properties

Readonly allVisibleRows

allVisibleRows: Locator = ...

A locator to all visible entries. Useful for getting a count.

Readonly emptyResultsMessage

emptyResultsMessage: Locator = ...

A locator to the message which is displayed when data is loaded but no results were found.

Readonly header

header: ListHeader = ...

A model for the list header row.

Protected root

root: Page | FrameLocator

The root playwright entity from which to resolve this component model's xpath.

Readonly xpath

xpath: string

An absolute xpath to the DOM element that this component model represents.

Methods

getChildOfType

  • This method gets a child component model with a provided type. This is useful for modelling a page where the UI is composed in a custom manner.

    Type Parameters

    Parameters

    • model: ComponentModelType<TModel>

      A ComponentModel type. e.g. ToggleButton / Modal

    • Optional xpath: string

      An optional xpath relative to this component. If not provided, the model's default xpath will be used.

    • Optional nth: number

      Optional position among matches. Position is 1 indexed. Negative numbers count from the end.

    Returns TModel

getLocator

  • This method gets a locator to the DOM element represented by this component model.

    Returns Locator

  • This method gets a locator to a DOM element relative to the element represented by this component model.

    Parameters

    • xpath: string

      An xpath relative to this component.

    • Optional nth: number

      Optional position among matches. Position is 1 indexed. Negative numbers count from the end.

    Returns Locator

getRow

  • This method gets a visible row by position. Position is 1 indexed. Negative numbers count from the end.

    Parameters

    • position: number

    Returns ListRow

getRowByPropertyValue

  • This method gets a visible entry by matching the value of a property. If multiple entries share the same property value, the 'nth' parameter can be used to select which is returned (the first by default).

    Parameters

    • propertyName: string
    • propertyValue: string
    • Optional nth: number

    Returns ListRow

getSortOrderOfProperty

  • This method gets the sort order of a property. If the property is not sortable an exception will be raised. If the property is not currently sorted, 'none' will be returned.

    Parameters

    • propertyName: string

    Returns Promise<"none" | "desc" | "asc">

sortByProperty

  • This method sorts the list by a property. If the list is already sorted by this property then the sort order will be reversed. If the property is not sortable an exception will be raised.

    Parameters

    • propertyName: string

    Returns Promise<void>

waitForData

  • This method waits while data loaders are visible, and waits for data to be displayed. As this method does not wait for an event it should not be used inside Promise.all. Example usage:

    await app.uiShell.navigateToLandingPageTile('Images');
    await uiWorkflows.list.waitForData();

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc