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

Overflow Menu

Overview

• The Dynamic Overflow Menu Component is a dropdown menu usually shown as an icon button.
• When activated, it displays a list of selectable options.
• It is useful for contextual actions, secondary features, or extra options without cluttering the interface.
• The component can be customized with icons, placement options, and menu items.
• It helps keep interfaces clean while still providing access to important functionality.

Specs

Tokens

Structure

(Configured in General Properties)

• displayName – Sets the display name of the component shown in the structure panel. For example, "Action Menu" clearly identifies the purpose of this overflow menu in the component structure.

(Configured in Visibility)

• displayConditions – Defines conditions under which the overflow menu is displayed. This allows for context-aware visibility, showing the menu only when certain conditions are met.

(Configured in Visual Properties)

• options – Defines the menu items that appear when the overflow menu is opened. Each option can have properties such as:
• text: The label shown for the menu item
• showMenuLinkIcon: Whether to display an icon next to the menu item text
• iconPositionKey: Where to place the icon ("menuLinkLeftIconName" or "menuLinkRightIconName")
• menuLinkLeftIconName / menuLinkRightIconName: The specific icon to display

• Menu Option Configuration – The overflow menu options can be extensively configured:

[
  {
    "text": "Edit Item",
    "type": "menu-link",
    "showMenuLinkIcon": true,
    "iconPositionKey": "menuLinkLeftIconName",
    "menuLinkLeftIconName": "edit-outline",
    "events": [
      {
        "type": "ON_OPTION_CLICK",
        "actions": [
          {
            "type": "NAVIGATE_TO_URL",
            "configuration": {
              "url": "/edit/{id}"
            }
          }
        ]
      }
    ]
  },
  {
    "text": "Delete Item",
    "type": "menu-link",
    "showMenuLinkIcon": true,
    "iconPositionKey": "menuLinkLeftIconName",
    "menuLinkLeftIconName": "delete-outline",
    "events": [
      {
        "type": "ON_OPTION_CLICK",
        "actions": [
          {
            "type": "SHOW_CONFIRMATION_DIALOG",
            "configuration": {
              "title": "Confirm Deletion",
              "message": "Are you sure you want to delete this item?"
            }
          }
        ]
      }
    ]
  }
]

Styling

(Configured in Visual Properties)

• iconName – Sets the icon displayed for the overflow menu button. For example, setting this to "more-outline" creates a three-dot menu icon, while "settings-outline" creates a gear icon that suggests configuration options.

• placement – Determines where the dropdown menu appears relative to the button. Options include "top", "right", "bottom", and "left". For example, setting this to "bottom" makes the menu appear below the button, which is useful when the component is placed near the top of the screen.

• paddingClass – Configures the padding around the component using CSS classes. For example, "p-2" adds medium padding on all sides of the overflow menu button.

Actions & Variants

(Configured in Events)

• events – Configures events that the component can trigger and respond to:
• ON_INIT – Triggered when the component is initialized. This event can be used for initial setup or configuration.
• ON_DESTROY – Triggered when the component is removed from the DOM. This event can be used for cleanup operations.
• ON_OPTION_CLICK – Triggered when a specific menu option is clicked. This event can be configured for each individual menu option to perform different actions.

Tests

(Configured in Testing Hooks)

• id – Specifies a unique identifier for the component, useful for programmatic access in testing or custom code.
• dataTestId – Sets a testing hook ID for automated testing, allowing test scripts to reliably identify this overflow menu component.
• enableAsHotspot – Enables the component as a guided tour hotspot. When enabled, this overflow menu can be highlighted during onboarding tours.
• guidedTourHotSpotTitle – Sets the title text displayed when this component is highlighted in a guided tour, with support for translations.
• guidedTourHotSpotDescription – Sets the descriptive text explaining the overflow menu's purpose during a guided tour, with support for translations.

Authorization

(Configured in Authorization)

• 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

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

• Run setup logic at creation with ON_INIT (declared in events) when the menu should register analytics or prepare context for options.
• 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

Protocol of implemented accessibility measures

• Provide explicit, readable action labels with options[].text so assistive technologies can announce them clearly.
• 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.
• Support automated checks and stable selectors by setting dataTestId and id.
• Improve onboarding comprehension by enabling enableAsHotspot and supplying descriptive guidedTourHotSpotTitle and guidedTourHotSpotDescription strings.

Practices to improve accessibility

• Prefer short, verb-led phrases in options[].text and avoid jargon to aid screen readers and translation.
• 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.
• Populate dataTestId to integrate automated accessibility tests and regressions in pipelines.