Class NavigationPanel

A model for Shell apps Navigation Panel

Hierarchy (View Summary)

ComponentModel
- NavigationPanel

Index

Constructors

Properties

panel root xpath

Methods

getCategory getCategoryByLabel getChildOfType getGlobalLocator getLocator getNavigationItemById getNavigationItemGroupById

Constructors

constructor

new NavigationPanel(
parent: Page | FrameLocator,
xpath?: string,
): NavigationPanel
Parameters
- parent: Page | FrameLocator
- xpath: string = '//*[@data-test-id="navigation-panel"]'
Returns NavigationPanel
Overrides ComponentModel.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

getCategory(position: number): NavigationCategory
Gets navigation category by position
Parameters
- position: number
  1-based index. Negative numbers count from the end.
Returns NavigationCategory

getCategoryByLabel

getCategoryByLabel(label: string, nth?: number): NavigationCategory
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

getChildOfType<TModel extends ComponentModel>(
    model: ComponentModelType<TModel>,
    xpath?: string,
    nth?: number,
): 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
Parameters
- model: ComponentModelType<TModel>
  A ComponentModel type. e.g. ToggleButton / Modal
- Optionalxpath: string
  An optional xpath relative to this component. If not provided, the model's default xpath will be used.
- Optionalnth: number
  Optional position among matches. Position is 1 indexed. Negative numbers count from the end.
Returns TModel
Inherited from ComponentModel.getChildOfType

`Protected`getGlobalLocator

getGlobalLocator(selector: string): Locator
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
Inherited from ComponentModel.getGlobalLocator

getLocator

getLocator(): Locator
This method gets a locator to the DOM element represented by this component model.

Returns Locator
Inherited from ComponentModel.getLocator
getLocator(xpath: string, nth?: number): 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.
- Optionalnth: number
  Optional position among matches. Position is 1 indexed. Negative numbers count from the end.
Returns Locator
Inherited from ComponentModel.getLocator

getNavigationItemById

getNavigationItemById(id: string, nth?: number): Locator
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

getNavigationItemGroupById(id: string, nth?: number): NavigationItemGroup
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