A model for a List component. Use this for the results in an explorer station or explorer modal.
The parent playwright page, frame or component model.
Optionalxpath: stringA relative xpath selector to this element from the parent.
ReadonlyallA locator to all visible entries. Useful for getting a count.
ReadonlyemptyA locator to the message which is displayed when data is loaded but no results were found.
ReadonlyheaderA model for the list header row.
ProtectedrootThe root playwright entity from which to resolve this component model's xpath.
ReadonlyxpathAn absolute xpath to the DOM element that this component model represents.
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.
A ComponentModel type. e.g. ToggleButton / Modal
Optionalxpath: stringAn optional xpath relative to this component. If not provided, the model's default xpath will be used.
Optionalnth: numberOptional position among matches. Position is 1 indexed. Negative numbers count from the end.
ProtectedgetA helper method to create global locators - This helps with locating globally across the entire DOM, rather than being scoped to the form
This method gets a locator to the DOM element represented by this component model.
This method gets a locator to a DOM element relative to the element represented by this component model.
An xpath relative to this component.
Optionalnth: numberOptional position among matches. Position is 1 indexed. Negative numbers count from the end.
This method gets a visible row by position. Position is 1 indexed. Negative numbers count from the end.
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).
Optionalnth: numberThis 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.
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.
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();
A model for a List component. Use this for the results in an explorer station or explorer modal.