Class Tab

An model for a Tab component with methods to retrieve individual tabs.

Hierarchy (View Summary)

ComponentModel
- Tab

Index

Constructors

Properties

Methods

getChildOfType getGlobalLocator getLocator getTabByLabel

Constructors

constructor

new Tab(parent: ComponentModel | Page | FrameLocator, xpath?: string): Tab
Parameters
- parent: ComponentModel | Page | FrameLocator
- xpath: string = '//ul[@data-test-id="tab-list"]'
Returns Tab
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 extends ComponentModel>(
    model: ComponentModelType<TModel>,
    xpath?: string,
    nth?: number,
): 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
Parameters
- model: ComponentModelType<TModel>
  A ComponentModel type. e.g. ToggleButton / Modal
- Optionalxpath: string
  An optional xpath relative to this component. If not provided, the model's default xpath will be used.
- Optionalnth: number
  Optional position among matches. Position is 1 indexed. Negative numbers count from the end.
Returns TModel
Inherited from ComponentModel.getChildOfType

`Protected`getGlobalLocator

getGlobalLocator(selector: string): Locator
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
Inherited from ComponentModel.getGlobalLocator

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: string, nth?: number): 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.
- Optionalnth: number
  Optional position among matches. Position is 1 indexed. Negative numbers count from the end.
Returns Locator
Inherited from ComponentModel.getLocator

getTabByLabel

getTabByLabel(label: string): Locator
This method finds a tab by label. The label must match exactly.
Parameters
- label: string
Returns Locator