Praman — Agent-First SAP UI5 Test Automation Plugin - v1.2.0
    Preparing search index...

    Interface UI5NavigationAPIAi

    UI5 Navigation API provided by the ui5Navigation fixture.

    Use to navigate between SAP Fiori Launchpad apps and views.

    Wraps all 11 FLP navigation module functions. The page argument is injected automatically from the Playwright fixture system.

    test('navigate to app', async ({ ui5Navigation }) => {
      await ui5Navigation.navigateToApp('PurchaseOrder-manage');
      const hash = await ui5Navigation.getCurrentHash();
    });
    interface UI5NavigationAPI {
        getCurrentHash(): Promise<string>;
        navigateBack(options?: NavigationOptions): Promise<void>;
        navigateForward(options?: NavigationOptions): Promise<void>;
        navigateToApp(appId: string, options?: NavigationOptions): Promise<void>;
        navigateToHash(hash: string, options?: NavigationOptions): Promise<void>;
        navigateToHome(options?: NavigationOptions): Promise<void>;
        navigateToIntent(
            intent: NavigationIntent,
            params?: Readonly<Record<string, string>>,
            options?: NavigationOptions,
        ): Promise<void>;
        navigateToSectionLink(
            linkName: string,
            options?: SectionLinkNavigationOptions,
        ): Promise<void>;
        navigateToSpace(
            spaceTitle: string,
            options?: SpaceNavigationOptions,
        ): Promise<void>;
        navigateToTile(title: string, options?: NavigationOptions): Promise<void>;
        searchAndOpenApp(title: string, options?: NavigationOptions): Promise<void>;
    }
    Index

    Methods

    getCurrentHash navigateBack navigateForward navigateToApp navigateToHash navigateToHome navigateToIntent navigateToSectionLink navigateToSpace navigateToTile searchAndOpenApp

    Methods

    • Ai

      Returns the current URL hash (without leading '#').

      Returns Promise<string>

      The current hash string.

      Use to read the current navigation hash for assertions.

      const hash = await ui5Navigation.getCurrentHash();
    • Ai

      Navigates back in browser history.

      Parameters

      Returns Promise<void>

      Use to go back to the previous page in history.

      await ui5Navigation.navigateBack();
    • Ai

      Navigates forward in browser history.

      Parameters

      Returns Promise<void>

      Use to go forward to the next page in history.

      await ui5Navigation.navigateForward();
    • Ai

      Navigates to a SAP app by semantic object hash.

      Parameters

      • appId: string

        Semantic object hash (e.g., 'PurchaseOrder-manage').

      • Optionaloptions: NavigationOptions

        Navigation options.

      Returns Promise<void>

      Use to open a Fiori app by its semantic object hash.

      await ui5Navigation.navigateToApp('PurchaseOrder-manage');
    • Ai

      Navigates to a specific hash directly.

      Parameters

      • hash: string

        The hash to navigate to (without leading '#').

      • Optionaloptions: NavigationOptions

        Navigation options.

      Returns Promise<void>

      Use to navigate directly to a URL hash fragment.

      await ui5Navigation.navigateToHash('Shell-home');
    • Ai

      Navigates to the FLP home screen.

      Parameters

      Returns Promise<void>

      Use to return to the Fiori Launchpad home page.

      await ui5Navigation.navigateToHome();
    • Ai

      Navigates to an SAP intent with optional parameters.

      Parameters

      • intent: NavigationIntent

        Semantic object and action descriptor.

      • Optionalparams: Readonly<Record<string, string>>

        Optional query parameters for the intent.

      • Optionaloptions: NavigationOptions

        Navigation options.

      Returns Promise<void>

      Use to navigate via semantic object + action with params.

      await ui5Navigation.navigateToIntent(
        { semanticObject: 'PurchaseOrder', action: 'manage' },
        { CompanyCode: '1000' },
      );
    • Ai

      Navigates via an FLP Section Link in a Space-based layout.

      Parameters

      • linkName: string

        Accessible name (visible text) of the section link.

      • Optionaloptions: SectionLinkNavigationOptions

        Section link navigation options (timeout).

      Returns Promise<void>

      Uses Playwright-native getByRole('link') to locate the section link.

      Use to navigate within FLP Space sections.

      await ui5Navigation.navigateToSectionLink('Purchase Orders');
    • Ai

      Navigates to an FLP Space Tab by its visible title text.

      Parameters

      • spaceTitle: string

        Visible title text of the FLP Space Tab.

      • Optionaloptions: SpaceNavigationOptions

        Space navigation options (timeout, exact).

      Returns Promise<void>

      Uses Playwright-native getByText() because sap.m.IconTabFilter has no press() / firePress() methods.

      Use to switch between FLP Spaces in modern BTP Work Zone layouts.

      await ui5Navigation.navigateToSpace('Procurement');
    • Ai

      Navigates to an FLP tile by its title text.

      Parameters

      • title: string

        Title text of the FLP tile.

      • Optionaloptions: NavigationOptions

        Navigation options.

      Returns Promise<void>

      Use to click a Fiori Launchpad tile by its visible title.

      await ui5Navigation.navigateToTile('Purchase Orders');
    • Ai

      Searches for an app in the FLP shell search bar and opens it.

      Parameters

      • title: string

        Title of the app to search for.

      • Optionaloptions: NavigationOptions

        Navigation options.

      Returns Promise<void>

      Use to find and launch a Fiori app via shell search.

      await ui5Navigation.searchAndOpenApp('Purchase Orders');

    Settings

    Member Visibility

    On This Page

    Methods