Page History

...

• visibilityPolicySetId – Determines the visibility of the component based on user permissions and policy sets. For example, setting to "adminOnlyPolicy" restricts the overflow menu to users with admin privileges.

Guidelines

Common Use Cases

• Row actions in tables – Providing actions like Edit, Delete, Archive for individual table rows
• Page-level actions – Housing secondary actions that don't warrant primary button placement
• Settings menus – Offering configuration options in a compact dropdown
• Export options – Providing various export formats like PDF, Excel, CSV

Design Considerations

• Use consistent iconography that clearly communicates the menu's purpose
• Order menu items by frequency of use or logical grouping
• Consider adding dividers between logical groups of options
• Keep the number of options reasonable (generally fewer than 7–8 items)
• Use clear, concise labels for each option
• Add icons to options when they help with quick visual recognition
• This component helps maintain a clean, uncluttered interface while still providing access to important functionality when needed.

Accessibility

...

Links

• Figma: https://www.figma.com/design/yck1tcUXgdQ5aYX6iUAwrO/GE---Astronaut-Design-System?node-id=11600-88110&t=ftfrOGkPzlG2GaTo-1
• Live style guide: https://e1-dev.k8s.myapp.de/live-style-guide/id4/2-overflow-menu

Guidelines

Usage

• Use the component to reveal contextual or secondary actions by configuring the trigger icon with iconName and the list of items with options.
• Place the dropdown where it will not obscure the trigger or key content by setting placement to "bottom", "top", "right", or "left" according to available space.
• Keep actions concise and scannable by writing clear labels in options[].text and, when recognition helps, enabling options[].showMenuLinkIcon to pair labels with icons.
• Keep menus lightweight by constraining the length of the options array to a manageable number (for example, around eight) so choices remain easy to scan.
• Use side-specific icons consistently by setting options[].iconPositionKey to "menuLinkLeftIconName" or "menuLinkRightIconName", and assigning options[].menuLinkLeftIconName or options[].menuLinkRightIconName accordingly.

Sizing & Layout

• Adjust the trigger’s tap/click comfort and breathing room using paddingClass (for example, "p-1", "p-2", "p-3") to align visually with nearby controls.
• Keep item alignment steady by choosing a single options[].iconPositionKey value so labels in options[].text line up across the list.
• Prevent clipping and reduce pointer travel by choosing an appropriate placement relative to the trigger using the "top", "right", "bottom", or "left" values.

States & Feedback

• Perform cleanup on teardown with ON_DESTROY (declared in events) when initialization attached resources that need removal.
• Provide immediate feedback on selection by wiring per-item handlers in options[].events so ON_OPTION_CLICK triggers the intended action flow.

Interactions & Events

• Navigate or execute tasks by attaching actions to options[].events for the ON_OPTION_CLICK type; ensure the intent is reflected by clear options[].text.
• Gate destructive actions behind confirmation by routing ON_OPTION_CLICK in options[].events through a confirmation step before execution.
• Enable onboarding assistance by turning on enableAsHotspot and providing guidedTourHotSpotTitle and guidedTourHotSpotDescription so the trigger can be highlighted in a guided tour.

Data-Driven / Conditional Behavior

• Show only relevant actions for the current context by passing a context-appropriate options array to the component.
• Convey action semantics with icons by enabling options[].showMenuLinkIcon and setting options[].menuLinkLeftIconName or options[].menuLinkRightIconName consistently with options[].iconPositionKey.

Visibility & Authorization

• Show or hide the trigger based on context by defining displayConditions that resolve to true only when actions are applicable.
• Restrict access by setting visibilityPolicySetId so the overflow menu appears only for users in the permitted policy set.

Dos & Don’ts

Accessibility

• Provide explicit, readable action labels with options[].text so assistive technologies can announce them clearly.
  • Prefer short, verb-led phrases in options[].text and avoid jargon to aid screen readers and translation.
• Avoid meaning by color or icon alone by pairing options[].showMenuLinkIcon with text labels in options[].text.
• Reduce occlusion and surprise by selecting a predictable placement so the dropdown appears where users expect.
• Improve onboarding comprehension by enabling enableAsHotspot and supplying descriptive guidedTourHotSpotTitle and guidedTourHotSpotDescription strings.
• Keep icon placement consistent using options[].iconPositionKey so the reading order remains stable.
• Confirm destructive actions via options[].events using ON_OPTION_CLICK to present a confirmation step before the action proceeds.
• Ensure consistent placement across similar menus by standardizing placement within a product area.