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

    Interface WorkbenchViewRef

    Describes a view referenced in a part.

    interface WorkbenchViewRef {
        active?: boolean;
        cssClass?: string | string[];
        params?: { [name: string]: unknown };
        qualifier: Qualifier;
    }
    Index

    Properties

    active?: boolean

    Controls whether to activate the view. If not specified, activates the first view of the stack.

    cssClass?: string | string[]

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

    params?: { [name: string]: unknown }

    Defines data to pass 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.

    qualifier: Qualifier

    Specifies the WorkbenchViewCapability that provides the view microfrontend.

    Declaring an intention allows for referencing public view capabilities of other applications.

    If the view capability cannot be resolved, the view is omitted, allowing conditional display, for example, based on user permissions.