Versions Compared

Old Version 1

changes.mady.by.user GE-DevDoc-Bot

Saved on

compared with

New Version Current

changes.mady.by.user GE-DevDoc-Bot

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Static Boardlet Wrapper

...

[!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.

...

  • 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.

Guidelines

[NO DATA AVAILABLE]

Accessibility

...

Usage

  • 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.

Content & Localization

  • 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.

Dos & Don’ts

DoDon’tArticle 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
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
Use a precise displayName so maintainers can find the instance quickly.Keep vague/default names that hinder maintenance.displayName
Choose boardlets with stable contracts registered in the selected microfrontend.Point to experimental or unregistered components.microfrontend, staticComponentName

Accessibility

  • 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.