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

    Class WorkbenchDialogAbstract

    Handle to interact with a dialog opened via WorkbenchDialogService.

    The dialog microfrontend can inject this handle to interact with the dialog, such as setting the title, reading parameters, or closing it.

    • WorkbenchDialogCapability
    • WorkbenchDialogService
    Index

    Constructors

    constructor

    Properties

    capability focused$ id params referrer

    Methods

    close setTitle signalReady

    Constructors

    Properties

    capability: WorkbenchDialogCapability

    Capability of the microfrontend loaded into this dialog.

    focused$: Observable<boolean>

    Indicates whether this dialog has the focus.

    id: `dialog.${string}`

    Identity of this dialog.

    params: Map<string, unknown>

    Parameters passed to the microfrontend loaded into the dialog.

    referrer: Referrer

    Identifies the source context from which the dialog was opened.

    Methods

    • Closes the dialog. Optionally, pass a result or an error to the dialog opener.

      Type Parameters

      • R

      Parameters

      • Optionalresult: R | Error

      Returns void

    • Sets the title of the dialog.

      Can be text or a translation key. A translation key starts with the percent symbol (%) and may include parameters in matrix notation for text interpolation.

      Parameters

      • title: string

      Returns void

    • Signals readiness, notifying the workbench that this dialog has completed initialization.

      If showSplash is set to true on the dialog capability, the workbench displays a splash until the dialog microfrontend signals readiness.

      Returns void

      WorkbenchDialogCapability.properties.showSplash

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods