Class Accordion

A model for an Accordion component with methods to get models for the header and individual items.

Hierarchy (View Summary)

ComponentModel
- Accordion

Index

Constructors

Properties

header root xpath

Methods

getChildOfType getGlobalLocator getItem getItemContainingText getLocator

Constructors

constructor

new Accordion(
parent: ComponentModel | Page | FrameLocator,
xpath?: string,
): Accordion
A model for an accordion component.
Parameters
- parent: ComponentModel | Page | FrameLocator
  The parent playwright page, frame or component model.
- xpath: string = '//*[@data-test-id="accordion"]'
  A relative xpath selector to this element from the parent.
Returns Accordion
Overrides ComponentModel.constructor

Properties

`Readonly`header

header: Locator = ...

A locator to the header row.

`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

getItem

getItem(position: number): AccordionItem
This method gets a visible accordion item by position. Position is 1 indexed. Negative numbers count from the end.
Parameters
- position: number
Returns AccordionItem

getItemContainingText

getItemContainingText(text: string, nth?: number): AccordionItem
This method gets a visible accordion item by matching text in the accordion row. If multiple items match the text, the 'nth' parameter can be used to select which is returned (the first by default).
Parameters
- text: string
- nth: number = 1
Returns AccordionItem

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