Class UiShellModel

constructor

• new UiShellModel(page: Page): UiShellModel

  Parameters

  • page: Page

    The playwright page object.

  Returns UiShellModel

Readonlybreadcrumbs

ReadonlylandingPageHeader

ReadonlylandingPageTiles

ReadonlynavigationPanel

Readonlynotifications

ReadonlysettingsPageHeader

ReadonlysettingsPageHub

waitForPageTransition

• get waitForPageTransition(): (promise: Promise<any>) => Promise<void>

  This method waits for a page transition to complete while another promise is being resolved. The two async processes run in parallel inside a Promise.all which prevents problems with race conditions. See: https://playwright.dev/docs/events.

  By convention, mosaic library methods which begin with "navigate" already use this method so it does not need to be used explicitly.

  Example usage:

  await uiShell.waitForPageTransition(
   uiWorkflows.list.getRow(1).actionButton.click(),
  );
  Copy

  Returns (promise: Promise<any>) => Promise<void>

clickPageHeaderAction

• clickPageHeaderAction(actionToSelect: string): Promise<void>

  Click a Page Header action by its visible label.

  Behavior:

  • If the target action is directly visible in the header, click it.
  • Otherwise, click the "More" overflow button and then click the target action in the menu.

  This helper does not wait for any subsequent navigation; callers should await navigation or network idle states as needed.

  Parameters

  • actionToSelect: string

    data-test-id attribute of navigation item

  Returns Promise<void>

goToNavigationPanelItem

• goToNavigationPanelItem(
      categoryLabel: string,
      itemLabel: string,
      groupLabel?: string,
  ): Promise<void>

  Navigates to the specified navigation panel page using Navigation Panel item text The management system must be loaded & signed in before using this method.

  The following steps will be taken:

  • Expand the menu (if not on a home view where the navigation panel is already visible)
  • Navigate to the navigation category by category label
  • In case groupLabel is provided Navigate to the navigation item group by group label and expand the group
  • Navigate to the navigation item by item label
  • Wait for a page transition to complete

  Parameters

  • categoryLabel: string

    Navigation category label

  • itemLabel: string

    Label of navigation item

  • OptionalgroupLabel: string

    Label of navigation item group in category, that needs to be expanded

  Returns Promise<void>

goToNavigationPanelItemByTestIds

• goToNavigationPanelItemByTestIds(
      itemTestId: string,
      groupTestId?: string,
  ): Promise<void>

  Navigates to the specified navigation panel page using HTML element attribute data-test-id The management system must be loaded & signed in before using this method.

  The following steps will be taken:

  • Expand the menu (if not on a home view where the navigation panel is already visible)
  • Navigate to the navigation category by category label
  • In case groupLabel is provided Navigate to the navigation item group by group label and expand the group
  • Navigate to the navigation item by item label
  • Wait for a page transition to complete

  Parameters

  • itemTestId: string

    data-test-id attribute of navigation item

  • OptionalgroupTestId: string

    data-test-id attribute of navigation item group

  Returns Promise<void>

goToNavigationPanelSettingsItem

• goToNavigationPanelSettingsItem(
      itemLabel: string,
      groupLabel?: string,
  ): Promise<void>

  Navigates to specified Settings page item using navigation panel The management system must be loaded & signed in before using this method.

  The following steps will be taken:

  • Navigate to the home breadcrumb (if not already on the landing page)
  • Navigate to the Settings category
  • In case groupLabel is provided navigate to the navigation item group by group label and expand the it
  • Navigate to the navigation item by item label
  • Wait for a page transition to complete

  Parameters

  • itemLabel: string

    Navigation item label

  • OptionalgroupLabel: string

    Label of navigation item group in Settings category, that needs to be expanded

  Returns Promise<void>

navigateToBreadcrumbHome

• navigateToBreadcrumbHome(): Promise<void>

  This method navigates to the landing page breadcrumb. The management system must be loaded & signed in before using this method.

  The following steps will be taken:

  • Click the first (home) breadcrumb
  • Wait for a page transition to complete

  Returns Promise<void>

navigateToBreadcrumbPrevious

• navigateToBreadcrumbPrevious(): Promise<void>

  This method navigates to the 'previous' breadcrumb. The management system must be loaded & signed in before using this method.

  The following steps will be taken:

  • Click the last-but-one breadcrumb
  • Wait for a page transition to complete

  Returns Promise<void>

navigateToBreadcrumbRefresh

• navigateToBreadcrumbRefresh(): Promise<void>

  This method navigates to the 'refresh' breadcrumb. The management system must be loaded & signed in before using this method.

  The following steps will be taken:

  • Click the last breadcrumb
  • Wait for a page transition to complete

  Returns Promise<void>

navigateToLandingPageTile

• navigateToLandingPageTile(label: string): Promise<void>

  This method navigates to a landing page tile by label. The management system must be loaded & signed in before using this method.

  The following steps will be taken:

  • Navigate to the home breadcrumb (if not already on the landing page)
  • Navigate to a tile by label
  • Wait for a page transition to complete

  Parameters

  • label: string

  Returns Promise<void>

navigateToSettingsTile

• navigateToSettingsTile(groupLabel: string, tileLabel: string): Promise<void>

  This method navigates to a settings page tile by label. The management system must be loaded & signed in before using this method.

  Parameters

  • groupLabel: string
  • tileLabel: string

  Returns Promise<void>

  Deprecated

  Please use goToNavigationPanelSettingsItem instead

  The following steps will be taken:

  • Navigate to the home breadcrumb (if not already on the landing page)
  • Navigate to the 'Settings' tile
  • Navigate to a tile by group label and tile label
  • Wait for a page transition to complete