Interface WorkbenchDialogCapability

Type Declaration

• [key: string]: unknown

  Arbitrary metadata associated with the capability.

• Optionalclosable?: boolean

  Specifies if to display a close button in the dialog header. Defaults to true.

• OptionalcssClass?: string | string[]

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

• Optionalpadding?: boolean

  Controls if to apply a padding to the content of the dialog.

  By default, dialogs provided by the workbench host application have a padding, others do not.

• 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

• Optionalresizable?: boolean

  Specifies if the user can resize the dialog. Defaults to true.

• Optionalresolve?: { [name: string]: string }

  Defines resolvers for use in the dialog title.

  A resolver defines a topic where a request is sent to resolve text or a translation key, typically based on capability parameters. Topic segments can reference capability parameters using the colon syntax.

  The application can respond to resolve requests by installing a message listener in the activator. Refer to ActivatorCapability for registering an activator.

  Example: - Message listener replying to resolve requests

  import {Beans} from '@scion/toolkit/bean-manager';
  import {MessageClient} from '@scion/microfrontend-platform';
  
  Beans.get(MessageClient).onMessage('products/:id/name', message => {
    const id = message.params.get('id');
    return `Product ${id}`;
  });
  Copy

• OptionalshowSplash?: boolean

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

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

  See

  WorkbenchDialog.signalReady

• Optionalsize?: WorkbenchDialogSize

  Specifies the size of this dialog, required if this dialog is provided by an application other than the workbench host application.

• Optionaltitle?: string

  Specifies the title of this 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.

  Text and interpolation parameters can reference capability parameters and resolvers using the colon syntax. See resolve for defining resolvers.

  Example: - Title referencing a resolver

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

  Example: - Translatable title referencing a resolver in its interpolation parameters

  {
    "params": [
      {"name": "id", "required": true}
    ],
    "properties": {
      "title": "%product.title;name=:productName", // `:productName` references a resolver
      "resolve": {
        "productName": "products/:id/name" // `:id` references a capability parameter
      }
    }
  }
  Copy