Class SelectionExplorer

constructor

• new SelectionExplorer(parent, xpath): SelectionExplorer

• 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

Readonly xpath

getChildOfType

• getChildOfType<TModel>(model, xpath?, nth?): TModel

• 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

  • TModel extends ComponentModel<TModel>

  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

getLocator

• getLocator(): Locator

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

  Returns Locator
• getLocator(xpath, nth?): 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

• waitToClose(): Promise<void>

• 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

• waitToOpen(): Promise<void>

• 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>