Class ListHeader

A model for a ListHeader component.

Hierarchy

Constructors

constructor

Properties

root xpath

Methods

getChildOfType getLabel getLabelByPropertyName getLocator

Constructors

constructor

  • A model which represents a DOM element.

    Parameters

    • parent: Page | FrameLocator | ComponentModel

      The playwright page object, frame or component model to be used as the parent of this component.

    • xpath: string

      A relative xpath to this component from the parent.

    • Optional nth: number

      Optional position of this component among xpath matches. Position is 1 indexed. Negative numbers count from the end.

    Returns ListHeader

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

  • 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

    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

getLabel

  • This method finds a header label by position. Position is 1 indexed. Negative numbers count from the end.

    Parameters

    • position: number

    Returns Locator

getLabelByPropertyName

  • This method finds a header label by property name. The property name must match exactly.

    Parameters

    • propertyName: string

    Returns Locator

getLocator

  • This method gets a locator to the DOM element represented by this component model.

    Returns 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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc