SCION Workbench Client - v1.0.0-beta.35
    Preparing search index...

    Class WorkbenchRouterAbstract

    Enables navigation of workbench views.

    A view is a visual workbench element for displaying content side-by-side or stacked.

    A microfrontend provided as a view capability can be opened in a view. The qualifier differentiates between different view capabilities. Declaring an intention allows for opening public view capabilities of other applications.

    Index

    Constructors

    Methods

    Constructors

    Methods

    • Navigates to a microfrontend of a view capability based on the given qualifier and extras.

      By default, the router opens a new view if no view is found that matches the specified qualifier and required params. Optional parameters do not affect view resolution. If one or more views match the qualifier and required params, they will be navigated instead of opening the microfrontend in a new view tab. This behavior can be changed by setting an explicit navigation target in navigation extras.

      Parameters

      • qualifier: Qualifier | Empty<Qualifier>

        Identifies the view capability that provides the microfrontend to display in a view. Passing an empty qualifier ({}) allows the microfrontend to update its parameters, restoring updated parameters when the page reloads. Parameter handling can be controlled using the WorkbenchNavigationExtras#paramsHandling option.

      • Optionalextras: WorkbenchNavigationExtras

        Options to control navigation.

      Returns Promise<boolean>

      Promise that resolves to true on successful navigation, or false otherwise.