Class Loader

A model for a Loader component.

Hierarchy

ComponentModel
- Loader

Index

Constructors

Properties

Methods

getChildOfType getLocator waitFor

Constructors

constructor

new Loader(parent, xpath?, nth?): Loader
A model for a loading icon.
Parameters
- parent: Page | FrameLocator | ComponentModel
  
  The parent playwright page, frame or component model.
- xpath: string = '//*[@data-test-id="loader"]'
  
  A relative xpath selector to this element from the parent. Default: '//*[contains(@class="Message_container")]'.
- nth: number = 1
  
  The position among all descendant loaders. Position 1 is the first. Default 1.
Returns Loader

Overrides ComponentModel.constructor

Properties

`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

getChildOfType<TModel>(model, xpath?, nth?): TModel
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
- TModel extends ComponentModel<TModel>
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

Inherited from ComponentModel.getChildOfType

getLocator

getLocator(): Locator
This method gets a locator to the DOM element represented by this component model.

Returns Locator

Inherited from ComponentModel.getLocator
getLocator(xpath, nth?): 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

Inherited from ComponentModel.getLocator

waitFor

waitFor(): Promise<void>
This method waits for the loader to be hidden or detached. As this method does not wait for an event it should not be used inside Promise.all.

Returns Promise<void>

Generated using TypeDoc