Class LandingPageTiles

A model for a LandingPageTiles component. Use this for the grid of tiles on the home page.

Hierarchy

ComponentModel
- LandingPageTiles

Index

Constructors

Properties

Methods

getChildOfType getLocator getTile getTileByLabel getTileByURL

Constructors

constructor

new LandingPageTiles(parent, xpath?): LandingPageTiles
A model for a LandingPageTiles component. Use this for the grid of tiles on the home page.
Parameters
- parent: Page | FrameLocator
  
  The playwright page or frame.
- xpath: string = '//*[@data-test-id="landing-page-tiles"]'
  
  An absolute XPath selector to this element. Default: //*[@data-test-id="landing-page-tiles"]
Returns LandingPageTiles

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

getTile

getTile(position): Locator
This method gets a tile by position among all descendents. Position is 1 indexed. Negative numbers count from the end.
Parameters
- position: number
Returns Locator

getTileByLabel

getTileByLabel(label): Locator
This method gets a tile by label. The text of the label must match exactly.
Parameters
- label: string
Returns Locator

getTileByURL

getTileByURL(url): Locator
This method gets a tile by URL. The URL must match exactly.
Parameters
- url: string
Returns Locator

Generated using TypeDoc