Versions Compared

Old Version 6

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

Saved on

compared with

New Version 7

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)

Boardlet

Link to Figma: https://www.figma.com/design/yck1tcUXgdQ5aYX6iUAwrO/GE---Astronaut-Design-System?node-id=11550-252668&t=iosNC2AkSTGs5lMh-1

Overview

  • Dynamic Boardlet is automatically created when a boardlet from the app boardlet library is used.
  • It provides a consistent framework with header, body, and footer sections.
  • Each section can hold other dynamic components.

...

  • visibilityPolicySetId – determines the visibility of the component based on specified policy sets. For example, setting it to "adminOnlyPolicy" restricts the boardlet to users with admin privileges.

Figma: https://www.figma.com/design/yck1tcUXgdQ5aYX6iUAwrO/GE---Astronaut-Design-System?node-id=11550-252668&t=iosNC2AkSTGs5lMh-1 Life style guide: https://e1-dev.k8s.myapp.de/live-style-guide/id5/2-boardlet

Guidelines

Header / Toolbar

...

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

...

DoDon’tArticle setting(s)
Keep header actions to ≤3 and surface the rest via overflow.Crowd the header with many icons and no overflow.Header elements[] (limit count), moreIconVisible: true
Hide the footer when no workflow actions exist.Leave an empty footer occupying space.showFooter: false
Use layout: "vertical" in the body to stack dense content for readability.Force cramped side-by-side layouts that truncate content.Body layout: "vertical"
Enable scrollingEnabled when content can exceed visible height.Allow content to clip, overlap, or push other regions unpredictably.scrollingEnabled: true
Localize the name and title for all supported locales.Hard-code English-only strings.boardletNameTranslations, titleTranslations/titleInitialize data and flags on mount; dispose on unmount.Defer setup until first click and forget to clear timers or listeners.events.ON_INIT, events.ON_DESTROY

Accessibility

  • Provide localized output to assistive tech by filling boardletNameTranslations and titleTranslations/title for all supported locales.
  • Maintain predictable reading and navigation order by keeping section visibility (showHeader, showFooter) and section layout stable during interaction.
  • Ensure overflow actions remain discoverable by enabling moreIconVisible, so important commands are reachable without shrinking targets.
  • Expose dataTestId to support automated accessibility checks and regression testing.
  • Avoid using color alone to convey meaning; augment with recognizable leftIcon/rightIcon and clear titleTranslations/title text.