(this page was created automatically. In case of formatting issues, please visit the official Wiki Page)
Static Boardlet Wrapper
(not verified)
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.
Specs
Tokens
| 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 |
Structure
(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 }.
Styling
(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.
Actions & Variants
(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.
Tests
(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.
Guidelines
[NO DATA AVAILABLE]
Accessibility
[NO DATA AVAILABLE]
