(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)

Static Boardlet Wrapper

(not verified)

Link to Figma: tba

The Dynamic Static Boardlet Wrapper enables integration of microfrontend-based static boardlets into your application.
It serves as a container that loads and displays external microfrontend components (static boardlets).
It lets you incorporate functionality from other applications while keeping a consistent UI experience.
It is ideal for bringing specialized features, visualizations, or integrations from other systems.

Token	Description
displayName	Display name in structure panel
microfrontend	Selected microfrontend application
staticComponentName	Selected boardlet component from the microfrontend
externalConfig	Configuration object passed to the boardlet
events	Configurable component events
ON_INIT (Events)	Triggered on component initialization
ON_DESTROY (Events)	Triggered when component is removed
dataTestId	Testing hook identifier

(Configured in Visual Properties)

microfrontend — Specifies the microfrontend application that contains the static boardlet. This property uses a dropdown to select from available microfrontend applications registered in your system. For example, selecting "analytics-app" will allow you to use boardlets from the analytics microfrontend.
staticComponentName — Selects the specific boardlet component to be rendered from the chosen microfrontend. This property is dependent on the microfrontend selection and will show only components available from that microfrontend. For example, "CustomerChartBoardlet" might be a component that displays customer-related charts.
externalConfig — Provides configuration parameters to the static boardlet component. This object contains properties expected by the specific boardlet being used and allows customizing its behavior. For example, for a chart boardlet, you might specify: { "showLegend": true, "chartType": "bar", "dataLimit": 20 }.

(Configured in General Properties)

displayName — Sets the display name of the component shown in the structure panel. For example, "Customer Analytics Boardlet" provides clear identification of the integrated component's purpose in the component hierarchy.

(Configured in Events)

events — Configures the events that the component can trigger and respond to:
ON_INIT — Triggered when the component is initialized. Can be used to perform setup operations or pass initial context data to the microfrontend.
ON_DESTROY — Triggered when the component is removed from the DOM. Useful for cleanup operations or releasing resources allocated to the microfrontend.

(Configured in Testing Hooks)

dataTestId — Sets the testing hook ID for automated testing. For example, setting it to "customer-analytics-boardlet" allows test scripts to reliably locate this wrapper during automated testing.

Render a specific static boardlet from a registered microfrontend by pairing microfrontend with a valid staticComponentName.
Configure the embedded boardlet only via externalConfig; pass exactly the keys the selected boardlet expects.
Label the instance clearly for authors with displayName. Use a descriptive displayName to clarify placement/intent in dense layouts.

The wrapper itself has no user-facing text. If the embedded boardlet expects localized strings, supply them inside externalConfig using the keys that boardlet defines.

Do	Don’t	Article setting(s)
Select the `microfrontend` first, then pick a matching `staticComponentName` within it.	Choose a `staticComponentName` from a different microfrontend or leave the pair inconsistent.	`microfrontend`, `staticComponentName`
Pass only parameters the boardlet expects via `externalConfig` and validate them during init.	Dump unrelated app state into `externalConfig`.	`externalConfig`, `ON_INIT`
Build the initial configuration and hand it off on initialization.	Rely on implicit defaults or “first user action” to configure the boardlet.	`ON_INIT`, `externalConfig`
Tear down integrations and free resources when removed.	Assume the embedded boardlet auto-cleans without signaling.	`ON_DESTROY`
Set a unique `dataTestId` for automation.	Target by brittle selectors like text or DOM position.	`dataTestId`
Use a precise `displayName` so maintainers can find the instance quickly.	Keep vague/default names that hinder maintenance.	`displayName`
Keep configuration stable during a session; if it must change, re-init deliberately.	Mutate `externalConfig` repeatedly mid-session, causing unpredictable reloads.	`externalConfig`, `ON_INIT`
Choose boardlets with stable contracts registered in the selected microfrontend.	Point to experimental or unregistered components.	`microfrontend`, `staticComponentName`

Provide a stable automation handle for accessibility regression tests using dataTestId.
Ensure deterministic teardown with ON_DESTROY to prevent orphaned overlays or live regions created by the embedded boardlet.
If the boardlet consumes localized strings, pass them via externalConfig in the user’s locale.