Class DynamicDataList

A model for a DynamicDataList component.

Hierarchy

Constructors

constructor

Properties

allVisibleRows dataEntryRow header root xpath

Methods

getChildOfType getGlobalLocator getLocator getRow getRowByPropertyValue waitForData

Constructors

constructor

  • A model representing a dynamic data list component.

    Parameters

    • parent: ComponentModel | Page | FrameLocator

      The parent playwright page, frame or component model.

    • Optional xpath: string

      A relative xpath selector to this element from the parent.

    Returns DynamicDataList

Properties

Readonly allVisibleRows

allVisibleRows: Locator

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

Readonly dataEntryRow

dataEntryRow: DynamicListDataEntry

A model representing the data entry row.

Readonly header

header: DynamicListHeader

A model representing the dynamic data 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

Protected getGlobalLocator

  • A helper method to create global locators - This helps with locating globally across the entire DOM, rather than being scoped to the form

    Parameters

    • selector: string

    Returns Locator

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 DynamicListRow

getRowByPropertyValue

  • This method gets a row by matching the value of a property. If multiple rows 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 DynamicListRow

waitForData

  • This method waits for transitions of new or removed rows of data to be completed. As this method does not wait for an event it should not be used inside Promise.all.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc