AbstractAbstract ReadonlycapabilityCapability that represents the microfrontend loaded into this workbench popup.
Abstract Readonlyfocused$Indicates whether this popup has the focus.
Abstract ReadonlyidRepresents the identity of this popup.
Abstract ReadonlyparamsParameters including qualifier entries as passed for navigation by the popup opener.
Abstract ReadonlyreferrerProvides information about the context in which this popup was opened.
AbstractcloseCloses the popup. Optionally, pass a result or an error to the popup opener.
Optionalresult: Error | RAbstractsetSets a result that will be passed to the popup opener when the popup is closed on focus loss CloseStrategy#onFocusLost.
Optionalresult: RAbstractsignal
A popup is a visual workbench component for displaying content above other content.
If a microfrontend lives in the context of a workbench popup, regardless of its embedding level, it can inject an instance of this class to interact with the workbench popup, such as reading passed parameters or closing the popup.
Preferred Size
You can report preferred popup size using @scion/microfrontend-platform!PreferredSizeService. Typically, you would subscribe to size changes of the microfrontend's primary content and report it. As a convenience, @scion/microfrontend-platform!PreferredSizeService provides API to pass an element for automatic dimension monitoring. If your content can grow and shrink, e.g., if using expandable panels, consider positioning primary content out of the document flow, that is, setting its position to
absolute. This way, you give it infinite space so that it can always be rendered at its preferred size.Note that the microfrontend may take some time to load, causing the popup to flicker when opened. Therefore, for fixed-sized popups, consider declaring the popup size in the popup capability.