A model for a MessageBar component. Use this for messages which show below the page header.

Hierarchy

Constructors

  • A model for a MessageBar component. Use this for messages which show below the page header.

    Parameters

    • parent: Page | FrameLocator | ComponentModel

      The parent playwright page, frame or component model.

    • xpath: string = '//*[@data-test-id="message-bar"]'

      A relative xpath selector to this element from the parent. Default: '//*[contains(@class="Message_container")]'.

    Returns MessageBar

Properties

closeButton: Locator = ...

A locator to the close button.

details: Locator = ...

A locator to the message details.

detailsButton: Locator = ...

A locator to the message details button.

retryButton: Locator = ...

A locator to the retry button.

root: Page | FrameLocator

The root playwright entity from which to resolve this component model's xpath.

title: Locator = ...

A locator to the message title.

xpath: string

An absolute xpath to the DOM element that this component model represents.

Methods

  • 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

  • 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

Generated using TypeDoc