Class MessageBar

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

Hierarchy

Constructors

constructor

Properties

closeButton details detailsButton retryButton root title xpath

Methods

asTypeError asTypeInfo asTypeWarning getChildOfType getGlobalLocator getLocator

Constructors

constructor

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

    Parameters

    • parent: ComponentModel | Page | FrameLocator

      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

Readonly closeButton

closeButton: Locator = ...

A locator to the close button.

Readonly details

details: Locator = ...

A locator to the message details.

Readonly detailsButton

detailsButton: Locator = ...

A locator to the message details button.

Readonly retryButton

retryButton: Locator = ...

A locator to the retry button.

Protected root

root: Page | FrameLocator

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

Readonly title

title: Locator = ...

A locator to the message title.

Readonly xpath

xpath: string

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

Methods

asTypeError

asTypeInfo

asTypeWarning

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc