Versions Compared

Key

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

...

  • The footerbar always controls the workflow of the boardlet.
  • Workflow-related actions are always placed at the bottom right. Hierarchy flows from bottom right to bottom left.
  • Allowed footerbar layouts:
  • Tabs only.
  • Tabs with buttons (maximum two).
  • Buttons only (maximum two).
  • Tabs with actionbar (secondary option, e.g., kiosk mode).
  • The footerbar has a fixed height and may never be multiline.

Example styling of the Boardlet Header and Footer

Usage

  • Create a three-part frame for content that needs a header, body, and footer by toggling section visibility (showHeader, showFooter) and placing components into the corresponding arrays (elements.header[], elements.body[], elements.footer[]).
  • Pick the visual emphasis that matches the page context by setting boardletType to Normal (bordered) for stronger separation or Ghost (borderless) when the Boardlet should blend into surrounding content.
  • Keep the header action area compact: place at most three immediate actions in elements.header[] and expose the rest via the mandatory overflow by setting moreIconVisible: true.
  • Use the footer only for workflow-related actions or tabs. If there is no workflow, hide the region (showFooter: false) so the layout stays clean.
  • Provide a clear, localized identity: set a human-readable builder label with displayName, a localized product-facing name with boardletNameTranslations, and a localized header title with titleTranslations/title (the visual title reads from these values).

Sizing & Layout

...

  • Prevent clipping when content grows by enabling internal scrolling with scrollingEnabled: true; this preserves container height and reduces layout shifts.
  • Reduce visual noise by hiding unused chrome (showHeader: false, showFooter: false) instead of leaving empty regions.
  • Provide quick, recognizable affordances in the header by configuring leftIcon and/or rightIcon with symbols that match the Boardlet’s purpose (e.g., info, settings).

States & Feedback

  • Switch visual style by changing boardletType (NormalGhost) to communicate emphasis without altering content.
  • Control presence of major regions at runtime with showHeader and showFooter to reflect task needs (e.g., hide footer after workflow completes).
  • Expose additional actions via overflow by toggling moreIconVisible; when true, users have a stable “more” entry point even when visible actions are limited.

Interactions & Events

...

  • Release resources and listeners on teardown with events.ON_DESTROY to keep the UI responsive and stable over time.
  • Provide deterministic automation hooks for QA and a11y testing with dataTestId so scripts can reliably target the Boardlet across builds.

...