Class NavigationPanel

A model for Shell apps Navigation Panel

Hierarchy

Constructors

constructor

Properties

panel root xpath

Methods

getCategory getCategoryByLabel getChildOfType getLocator getNavigationItemById getNavigationItemGroupById

Constructors

constructor

Properties

Readonly panel

panel: Locator = ...

A locator for navigation panel

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

getCategory

  • Gets navigation category by position

    Parameters

    • position: number

      1-based index. Negative numbers count from the end.

    Returns NavigationCategory

getCategoryByLabel

  • Gets navigation category by matching category label text

    Parameters

    • label: string

      Text of the category item label

    • nth: number = 1

      1-based index. Negative numbers count from the end.

    Returns NavigationCategory

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

getNavigationItemById

  • Gets navigation item by matching data-test-id attribute

    Parameters

    • id: string

      Value of items data-test-id attribute

    • nth: number = 1

      1-based index. Negative numbers count from the end.

    Returns Locator

getNavigationItemGroupById

  • Gets navigation item group by matching data-test-id attribute

    Parameters

    • id: string

      Value of item groups data-test-id attribute

    • nth: number = 1

      1-based index. Negative numbers count from the end.

    Returns NavigationItemGroup

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc