Skip to main content
Version: 1.x

Interface: UI5NavigationAPI

Defined in: src/fixtures/nav-fixtures.ts:78

Ai

UI5 Navigation API provided by the ui5Navigation fixture.

Ai Context

Use to navigate between SAP Fiori Launchpad apps and views.

Remarks

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

Example

test('navigate to app', async ({ ui5Navigation }) => {
await ui5Navigation.navigateToApp('PurchaseOrder-manage');
const hash = await ui5Navigation.getCurrentHash();
});

Methods

getCurrentHash()

getCurrentHash(): Promise<string>

Defined in: src/fixtures/nav-fixtures.ts:225

Ai

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

Returns

Promise<string>

The current hash string.

Ai Context

Use to read the current navigation hash for assertions.

Example

const hash = await ui5Navigation.getCurrentHash();

navigateBack(options?): Promise<void>

Defined in: src/fixtures/nav-fixtures.ts:179

Ai

Navigates back in browser history.

Parameters

options?

NavigationOptions

Navigation options.

Returns

Promise<void>

Ai Context

Use to go back to the previous page in history.

Example

await ui5Navigation.navigateBack();

navigateForward(options?): Promise<void>

Defined in: src/fixtures/nav-fixtures.ts:194

Ai

Navigates forward in browser history.

Parameters

options?

NavigationOptions

Navigation options.

Returns

Promise<void>

Ai Context

Use to go forward to the next page in history.

Example

await ui5Navigation.navigateForward();

navigateToApp(appId, options?): Promise<void>

Defined in: src/fixtures/nav-fixtures.ts:93

Ai

Navigates to a SAP app by semantic object hash.

Parameters

appId

string

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

options?

NavigationOptions

Navigation options.

Returns

Promise<void>

Ai Context

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

Example

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

navigateToHash(hash, options?): Promise<void>

Defined in: src/fixtures/nav-fixtures.ts:149

Ai

Navigates to a specific hash directly.

Parameters

hash

string

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

options?

NavigationOptions

Navigation options.

Returns

Promise<void>

Ai Context

Use to navigate directly to a URL hash fragment.

Example

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

navigateToHome(options?): Promise<void>

Defined in: src/fixtures/nav-fixtures.ts:164

Ai

Navigates to the FLP home screen.

Parameters

options?

NavigationOptions

Navigation options.

Returns

Promise<void>

Ai Context

Use to return to the Fiori Launchpad home page.

Example

await ui5Navigation.navigateToHome();

navigateToIntent(intent, params?, options?): Promise<void>

Defined in: src/fixtures/nav-fixtures.ts:129

Ai

Navigates to an SAP intent with optional parameters.

Parameters

intent

NavigationIntent

Semantic object and action descriptor.

params?

Readonly<Record<string, string>>

Optional query parameters for the intent.

options?

NavigationOptions

Navigation options.

Returns

Promise<void>

Ai Context

Use to navigate via semantic object + action with params.

Example

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

navigateToTile(title, options?): Promise<void>

Defined in: src/fixtures/nav-fixtures.ts:109

Ai

Navigates to an FLP tile by its title text.

Parameters

title

string

Title text of the FLP tile.

options?

NavigationOptions

Navigation options.

Returns

Promise<void>

Ai Context

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

Example

await ui5Navigation.navigateToTile('Purchase Orders');

searchAndOpenApp()

searchAndOpenApp(title, options?): Promise<void>

Defined in: src/fixtures/nav-fixtures.ts:210

Ai

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

Parameters

title

string

Title of the app to search for.

options?

NavigationOptions

Navigation options.

Returns

Promise<void>

Ai Context

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

Example

await ui5Navigation.searchAndOpenApp('Purchase Orders');