Edit

Share via

WorkloadNavigation interface

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

An interface representing the location to which the workload should navigate

Properties

isDeepLink

Whether the onNavigate event is triggered by opening from a deep link.
targetUrl

The target URL to which the workload app should navigate. For example, /path/to/page?key1=val1&key2=val2. When a dialog/panel is closed, the workload host will explicitly ask the dialog/panel iframe to switch to the root path ('/'). This forces the workload to reset the UI state of the dialog/panel, avoiding opening the same dialog/panel twice in a row and having the UI state of the first dialog/panel carried over to the second.
userActionTimestamp

The timestamp of the user action that triggers the onNavigate event. Workload UX can use this timestamp as the time origin for some end-to-end, user-perceivable performance logging.

Property Details

Whether the onNavigate event is triggered by opening from a deep link.

isDeepLink: boolean

Property Value

boolean

targetUrl

The target URL to which the workload app should navigate. For example, /path/to/page?key1=val1&key2=val2. When a dialog/panel is closed, the workload host will explicitly ask the dialog/panel iframe to switch to the root path ('/'). This forces the workload to reset the UI state of the dialog/panel, avoiding opening the same dialog/panel twice in a row and having the UI state of the first dialog/panel carried over to the second.

targetUrl: string

Property Value

string

userActionTimestamp

The timestamp of the user action that triggers the onNavigate event. Workload UX can use this timestamp as the time origin for some end-to-end, user-perceivable performance logging.

userActionTimestamp: number

Property Value

number