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

    Interface WorkbenchDialogOptions

    Controls the appearance and behavior of a dialog.

    interface WorkbenchDialogOptions {
        animate?: boolean;
        context?:
            | null
            | `view.${string}`
            | `part.${string}`
            | `dialog.${string}`
            | `popup.${string}`
            | Context;
        cssClass?: string
        | string[];
        modality?: "view" | "none" | "context" | "application";
        params?: Map<string, unknown> | { [param: string]: unknown };
    }
    Index

    Properties

    animate?: boolean

    Controls whether to animate the opening of the dialog. Defaults is false.

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

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

    The dialog is displayed only if the context is visible and closes when the context is disposed. The dialog is opened in the center of its context, if any, unless opened from the peripheral area.

    Set to null to open the dialog outside a context.

    cssClass?: string | string[]

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

    modality?: "view" | "none" | "context" | "application"

    Controls which area of the application to block by the dialog. Defaults to context.

    One of:

    • 'none': Non-blocking dialog.
    • context: Blocks a specific part of the application, as specified in context, defaulting to the calling context.
    • application: Blocks the workbench or browser viewport, based on global workbench settings.
    • view: Deprecated. Same as context. Marked for removal.
    params?: Map<string, unknown> | { [param: string]: unknown }

    Passes data to the dialog.

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