An open modal with methods to apply a specific model to the contents.

Hierarchy

Constructors

  • An modal with methods to apply a specific model to the contents.

    Parameters

    • parent: Page | FrameLocator | ComponentModel

      The parent playwright page or frame.

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

      An absolute xpath selector to this element.

    Returns Modal

Properties

root: Page | FrameLocator

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

xpath: string

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

Methods

  • This method applies a model to the contents of the modal.

    Type Parameters

    • TModal

    Parameters

    Returns TModal

  • 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