Edit

Share via

NavigationWorkloadRoute interface

  • Reference
Package:
@ms-fabric/workload-client

An interface representing a particular workload-side route

Extends

NavigationRouteBase

Properties

queryParams

The query parameters of the workload application

Inherited Properties

path

The path to navigate to
replaceUrl

When set to true, the navigation modifies the current history entry instead of adding a new one.

Note: This works only if the previous page before navigation was also rendered by the same workload request with history replacement. This prevents unintended overwriting of history entries generated by other workloads.

Property Details

queryParams

The query parameters of the workload application

queryParams?: Record<string, undefined | null | string>

Property Value

Record<string, undefined | null | string>

Inherited Property Details

path

The path to navigate to

path: string

Property Value

string

Inherited From NavigationRouteBase.path

replaceUrl

When set to true, the navigation modifies the current history entry instead of adding a new one.

Note: This works only if the previous page before navigation was also rendered by the same workload request with history replacement. This prevents unintended overwriting of history entries generated by other workloads.

replaceUrl?: boolean

Property Value

boolean

Inherited From NavigationRouteBase.replaceUrl