Interface WorkbenchPopupCapability

Type Declaration

• [key: string]: unknown

  Arbitrary metadata associated with the capability.

• OptionalcssClass?: string | string[]

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

• path: string

  Specifies the path to the microfrontend.

  The path is relative to the base URL given in the application manifest, or to the origin of the manifest file if no base URL is specified.

  Path segments can reference capability parameters using the colon syntax.

  {
    "params": [
      {"name": "id", "required": true}
    ],
    "properties": {
      "path": "products/:id", // `:id` references a capability parameter
    }
  }
  Copy

• OptionalshowSplash?: boolean

  Instructs the workbench to show a splash, such as a skeleton or loading indicator, until the popup microfrontend signals readiness.

  By default, the workbench shows a loading indicator. A custom splash can be configured in the workbench host application.

  See

  WorkbenchPopup.signalReady

• Optionalsize?: PopupSize

  Specifies the preferred popup size.

  If not set, the popup will adjust its size to the content size reported by the embedded content using @scion/microfrontend-platform!PreferredSizeService. 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.