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

    Interface WorkbenchPopupConfig

    Controls the appearance and behavior of a popup.

    interface WorkbenchPopupConfig {
        align?: "east" | "west" | "north" | "south";
        anchor: PopupOrigin | Element | Observable<PopupOrigin>;
        closeStrategy?: CloseStrategy;
        context?:
            | null
            | `view.${string}`
            | `part.${string}`
            | `dialog.${string}`
            | `popup.${string}`
            | Context;
        cssClass?: string
        | string[];
        params?: Map<string, any> | Dictionary<unknown>;
    }
    Index

    Properties

    align?: "east" | "west" | "north" | "south"

    Hint where to align the popup relative to the popup anchor, unless there is not enough space available in that area. By default, if not specified, the popup opens north of the anchor.

    anchor: PopupOrigin | Element | Observable<PopupOrigin>

    Controls where to open the popup.

    Can be an HTML element or a coordinate. The coordinate is relative to the context, defaulting to the calling context.

    Supported coordinate pairs:

    • x/y: Relative to the top/left corner of the context.
    • top/left: Same as x/y.
    • top/right: Relative to the top/right corner of the context.
    • bottom/left: Relative to the bottom/left corner of the context.
    • bottom/right: Relative to the bottom/right corner of the context.

    Passing an Observable allows for updating the coordinate.

    closeStrategy?: CloseStrategy

    Controls when to close the popup.

    context?:
        | null
        | `view.${string}`
        | `part.${string}`
        | `dialog.${string}`
        | `popup.${string}`
        | Context

    Binds the popup to a context (e.g., a part or view). Defaults to the calling context.

    The popup is displayed only if the context is visible and closes when the context is disposed.

    Set to null to open the popup outside a context.

    cssClass?: string | string[]

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

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

    Passes data to the popup.

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