Class SelectionExplorer

A model for a SelectionExplorer component which is opened as the content of a modal.

Hierarchy

Constructors

constructor

Properties

filters list messageBar pageHeader root xpath

Methods

getChildOfType getGlobalLocator getLocator waitToClose waitToOpen

Constructors

constructor

  • A model for a component which is opened as the content of a modal.

    Parameters

    • parent: Page | FrameLocator

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

    • xpath: string

      A relative xpath to this component from the parent.

    Returns SelectionExplorer

Properties

Readonly filters

filters: Filters

A model for the filters panel which shows next to the list of results.

Readonly list

list: List

A model for the list of results.

Readonly messageBar

messageBar: MessageBar

A model for the message bar which appears below the page header (error / warning / info).

Readonly pageHeader

pageHeader: PageHeader

A model for the page header with subtitle, title and actions.

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

Protected getGlobalLocator

  • 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

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

waitToClose

  • Wait for the modal to close. As this method does not wait for an event it should not be used inside Promise.all.

    Returns Promise<void>

waitToOpen

  • Wait for the modal to open. As this method does not wait for an event it should not be used inside Promise.all.

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc