Class Breadcrumbs

A model for a Breadcrumbs bar with methods to retrieve individual breadcrumbs.

Hierarchy

Constructors

constructor

Properties

root xpath

Methods

expand getBreadcrumb getBreadcrumbByLabel getBreadcrumbByURL getChildOfType getLocator

Constructors

constructor

  • A model for a breadcrumbs bar with methods to retrieve individual breadcrumbs.

    Parameters

    • parent: Page | FrameLocator

      The playwright page or frame.

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

      An absolute XPath selector to this element. Default: //*[@data-test-id="breadcrumbs"]

    Returns Breadcrumbs

Properties

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

expand

  • This method expands the drop-down menu if it is visible enabling hidden breadcrumbs to be selected.

    Returns Promise<void>

getBreadcrumb

  • This method finds a breadcrumb by position. Position is 1 indexed. Negative numbers count from the end.

    Parameters

    • position: number

    Returns Locator

getBreadcrumbByLabel

  • The method finds a breadcrumb by label. The label must match exactly.

    Parameters

    • label: string

    Returns Locator

getBreadcrumbByURL

  • The method finds a breadcrumb by URL. The URL must match exactly.

    Parameters

    • url: string

    Returns Locator

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

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