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

    Class WorkbenchPopupAbstract

    A popup is a visual workbench element for displaying content above other content. The popup is positioned relative to an anchor based on its preferred alignment. The anchor can be an element or a coordinate.

    The microfrontend can inject this handle to interact with the popup.

    Configure the popup with a fixed size in WorkbenchPopupCapability.properties.size, or report its intrinsic content size using @scion/microfrontend-platform!PreferredSizeService.

    Beans.get(PreferredSizeService).fromDimension(<Microfrontend HTMLElement>);
    

    If the content can grow and shrink, e.g., if using expandable panels, position the microfrontend absolute to allow infinite space for rendering at its preferred size.

    Since loading a microfrontend may take time, prefer setting the popup size in the popup capability to avoid flickering when opening the popup.

    Index

    Constructors

    Properties

    Capability of the microfrontend loaded into this popup.

    focused$: Observable<boolean>

    Indicates whether this popup has the focus.

    id: `popup.${string}`

    Identity of this popup.

    params: Map<string, unknown>

    Parameters passed to the microfrontend loaded into the popup.

    Provides information about the context in which this popup was opened.

    since version 1.0.0-beta.34. Marked for removal. No replacement. Instead, add a parameter to the popup capability for the popup opener to pass required referrer information.

    Methods

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

      Type Parameters

      • R

      Parameters

      • Optionalresult: Error | R

      Returns void

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

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

      Returns void

      WorkbenchPopupCapability.properties.showSplash