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

    Interface WorkbenchNavigationExtras

    Options to control the navigation.

    interface WorkbenchNavigationExtras {
        activate?: boolean;
        close?: boolean;
        cssClass?: string | string[];
        params?: Map<string, any> | Dictionary<unknown>;
        paramsHandling?: "merge" | "replace";
        partId?: string;
        position?:
            | number
            | "start"
            | "end"
            | "before-active-view"
            | "after-active-view";
        target?: string;
    }
    Index

    Properties

    activate? close? cssClass? params? paramsHandling? partId? position? target?

    Properties

    activate?: boolean

    Instructs the router to activate the view. Defaults to true.

    close?: boolean

    Closes views that match the specified qualifier and required parameters. Optional parameters do not affect view resolution.

    The parameters support the asterisk wildcard value (*) to match views with any value for a parameter.

    Only views for which the application has an intention can be closed.

    cssClass?: string | string[]

    Specifies CSS class(es) to add to the view, e.g., to locate the view in tests.

    params?: Map<string, any> | Dictionary<unknown>

    Passes data to the view.

    The view can declare mandatory and optional parameters. No additional parameters are allowed. Refer to the documentation of the capability for more information.

    paramsHandling?: "merge" | "replace"

    Instructs the workbench router how to handle params in self-navigation.

    Self-navigation allows the microfrontend to update its parameters, restoring updated parameters when the page reloads. Setting a paramsHandling strategy has no effect on navigations other than self-navigation. A self-navigation is initiated by passing an empty qualifier.

    One of:

    • replace: Replaces current parameters (default).
    • merge: Merges new parameters with current parameters, with new parameters of equal name overwriting existing parameters. A parameter can be removed by passing undefined as its value.
    partId?: string

    Controls which part to navigate views in.

    If target is blank, opens the view in the specified part. If target is auto, navigates matching views in the specified part, or opens a new view in that part otherwise.

    If the specified part is not in the layout, opens the view in the active part, with the active part of the main area, if any, taking precedence.

    position?: number | "start" | "end" | "before-active-view" | "after-active-view"

    Specifies where to insert the view into the tab bar. Has no effect if navigating an existing view. Defaults to after the active view.

    target?: string

    Controls where to open the view. Defaults to auto.

    One of:

    • auto: Navigates existing views that match the qualifier and required params, or opens a new view otherwise. Optional parameters do not affect view resolution.
    • blank: Opens a new view and navigates it.
    • <viewId>: Navigates the specified view. If already opened, replaces it, or opens a new view otherwise.

    Settings

    Member Visibility

    On This Page

    Properties