A model for a form with methods to get contained form fields.
The playwright page or frame.
Optionalxpath: stringAn absolute XPath selector to this element. Default: '//form'
ReadonlymodalA model for an untyped modal with methods to to apply a model for a specific type. A modal is most often opened from a dynamic data list for data entry.
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.
This method gets a form field by position. Position is 1 indexed. Negative numbers count from the end.
An untyped form field model with methods to apply a model for a specific field type.
This method gets a form field by label. The label text must match exactly.
An untyped form field model with methods to apply a model for a specific field type.
This method gets a form field by property name. The element is matched by looking for a field with a descendent element that has matching name or id attribute.
An untyped form field model with methods to apply a model for a specific field type.
This method gets a form field with a validation error. If multiple form fields have errors, the 'nth' parameter is used to select which is returned (first by default).
Optionalnth: numberAn untyped form field model with methods to apply a model for a specific field type.
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 waits for at least one form field 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.waitForPageTransition(
list.getRow(1).actionButton.click(),
);
await form.waitForData();
A model for a form with methods to get contained form fields. Use this model for create, form and details stations.