Page History
(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)
Static Boardlet Wrapper
(not verified)
...
[!WARNING] This component might not work as intended. Please use with caution.
Overview
- 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.
...
- Render a specific static boardlet from a registered microfrontend by pairing
microfrontendwith a validstaticComponentName. - 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 descriptivedisplayNameto clarify placement/intent in dense layouts.
Content & Localization
- The wrapper itself has no user-facing text. If the embedded boardlet expects localized strings, supply them inside
externalConfigusing 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 |
...
