fix(menu): ipad menu item click #5901

iuliauta · 2025-11-19T14:15:28Z

Description

Issue

Menu items (<sp-menu-item>) in <sp-action-menu> were not registering click events on iPad devices, while the same items wrapped in <sp-menu-group> worked correctly. This issue was reported in GitHub Issue #5706.

Symptoms

On iPad (and other tablets):
- Direct menu items inside <sp-action-menu> don't fire click events
- pointerdown and pointerup events fire correctly
- Works fine when menu items are wrapped in <sp-menu-group>
On desktop and mobile phones:
- Everything works as expected

Root cause

The issue stemmed from an incorrect device detection strategy that didn't properly account for tablet devices with touch input.

Technical details

Device detection query
```
// Old IS_MOBILE definition
const IS_MOBILE =
    '(max-width: 743px) and (hover: none) and (pointer: coarse)';
```
This query only matched devices with:
- Screen width ≤ 743px AND
- Touch input (hover: none, pointer: coarse)
iPad devices don't match because their screen width is typically 768px-1024px.
The shouldSupportDragAndSelect flag

In packages/picker/src/InteractionController.ts, the code set:
```
this.host.optionsMenu.shouldSupportDragAndSelect =
    !this.host.isMobile.matches;
```
Since iPad didn't match IS_MOBILE, shouldSupportDragAndSelect was set to true.

Event handling conflict

In packages/menu/src/Menu.ts:

private handlePointerup(event: Event): void {
    this.handleTouchEnd();

    if (!this.shouldSupportDragAndSelect) {
        return; // Selection handled by click event
    }
    this.pointerUpTarget = event.target;
    this.handlePointerBasedSelection(event);
}

private handleClick(event: Event): void {
    if (this.pointerUpTarget === event.target) {
        this.pointerUpTarget = null;
        return; // EARLY RETURN - Click is ignored!
    }
    this.handlePointerBasedSelection(event);
}

When shouldSupportDragAndSelect = true:

handlePointerup processes the selection and sets pointerUpTarget
handleClick sees that pointerUpTarget === event.target and returns early
The click event is never processed!

Why menu-group worked

When menu items are wrapped in <sp-menu-group>, the additional DOM wrapper causes the event.target in the click handler to sometimes differ from the pointerUpTarget set in the pointerup handler, allowing the click to proceed.

Solution

We introduced a new IS_TOUCH_DEVICE media query that detects any device with touch input, regardless of screen size:

export const IS_TOUCH_DEVICE = '(hover: none) and (pointer: coarse)';

This query matches:

Mobile phones (screen width ≤ 743px)
Tablets like iPad (screen width 744px-1366px)
Any other device with touch input

The PickerBase class now includes an isTouchDevice property:

public isTouchDevice = new MatchMediaController(this, IS_TOUCH_DEVICE);

The menu's shouldSupportDragAndSelect property is set directly in the template when the menu is rendered:

protected get renderMenu(): TemplateResult {
    const menu = html`
        <sp-menu
            ...
            .shouldSupportDragAndSelect=${!this.isTouchDevice.matches}
            ...
        >
            <slot></slot>
        </sp-menu>
    `;
    ...
}

This ensures that on all touch devices (including iPads), the menu uses click events instead of the drag-and-select pattern, preventing the event handling conflict.

Motivation and context

Related issue(s)

fixes [Bug]: Menu items in action menus do not dispatch click events on tablets #5706

Screenshots (if appropriate)

Author's checklist

I have read the CONTRIBUTING and PULL_REQUESTS documents.
I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
I have added automated tests to cover my changes.
I have included a well-written changeset if my change needs to be published.
I have included updated documentation if my change required it.

Reviewer's checklist

Includes a Github Issue with appropriate flag or Jira ticket number without a link
Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
Automated tests cover all use cases and follow best practices for writing
Validated on all supported browsers
All VRTs are approved before the author can update Golden Hash

Manual review test cases

iPad Menu Item click test
1. Go https://swcpreviews.z13.web.core.windows.net/pr-5829/docs/storybook/?path=/story/action-menu--menu-item-alerts
2. Open this in iPad mini or any iPad
3. Click any menu Item
4. You will see an alert
Descriptive Test Statement
1. Go here
2. Do this action
3. Expect this result

Device review

Did it pass in Desktop?
Did it pass in (emulated) Mobile?
Did it pass in (emulated) iPad?

changeset-bot · 2025-11-19T14:15:33Z

🦋 Changeset detected

Latest commit: b2194cc

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 78 packages

Name	Type
@spectrum-web-components/picker	Patch
@spectrum-web-components/reactive-controllers	Patch
@spectrum-web-components/action-menu	Patch
@spectrum-web-components/bundle	Patch
@spectrum-web-components/accordion	Patch
@spectrum-web-components/action-group	Patch
@spectrum-web-components/button	Patch
@spectrum-web-components/coachmark	Patch
@spectrum-web-components/color-area	Patch
@spectrum-web-components/color-slider	Patch
@spectrum-web-components/color-wheel	Patch
@spectrum-web-components/combobox	Patch
@spectrum-web-components/contextual-help	Patch
@spectrum-web-components/field-label	Patch
@spectrum-web-components/icon	Patch
@spectrum-web-components/menu	Patch
@spectrum-web-components/meter	Patch
@spectrum-web-components/number-field	Patch
@spectrum-web-components/overlay	Patch
@spectrum-web-components/progress-bar	Patch
@spectrum-web-components/radio	Patch
@spectrum-web-components/sidenav	Patch
@spectrum-web-components/slider	Patch
@spectrum-web-components/swatch	Patch
@spectrum-web-components/tabs	Patch
@spectrum-web-components/tags	Patch
@spectrum-web-components/tooltip	Patch
@spectrum-web-components/tray	Patch
@spectrum-web-components/grid	Patch
@spectrum-web-components/breadcrumbs	Patch
@spectrum-web-components/action-bar	Patch
@spectrum-web-components/action-button	Patch
@spectrum-web-components/alert-banner	Patch
@spectrum-web-components/alert-dialog	Patch
@spectrum-web-components/button-group	Patch
@spectrum-web-components/dialog	Patch
@spectrum-web-components/infield-button	Patch
@spectrum-web-components/picker-button	Patch
@spectrum-web-components/search	Patch
@spectrum-web-components/toast	Patch
@spectrum-web-components/checkbox	Patch
@spectrum-web-components/icons-ui	Patch
@spectrum-web-components/icons-workflow	Patch
@spectrum-web-components/table	Patch
@spectrum-web-components/textfield	Patch
@spectrum-web-components/popover	Patch
@spectrum-web-components/truncated	Patch
@spectrum-web-components/top-nav	Patch
@spectrum-web-components/card	Patch
@spectrum-web-components/switch	Patch
@spectrum-web-components/help-text	Patch
@spectrum-web-components/color-field	Patch
@spectrum-web-components/field-group	Patch
@spectrum-web-components/asset	Patch
@spectrum-web-components/avatar	Patch
@spectrum-web-components/badge	Patch
@spectrum-web-components/clear-button	Patch
@spectrum-web-components/close-button	Patch
@spectrum-web-components/color-handle	Patch
@spectrum-web-components/color-loupe	Patch
@spectrum-web-components/divider	Patch
@spectrum-web-components/dropzone	Patch
@spectrum-web-components/icons	Patch
@spectrum-web-components/iconset	Patch
@spectrum-web-components/illustrated-message	Patch
@spectrum-web-components/link	Patch
@spectrum-web-components/modal	Patch
@spectrum-web-components/progress-circle	Patch
@spectrum-web-components/split-view	Patch
@spectrum-web-components/status-light	Patch
@spectrum-web-components/thumbnail	Patch
@spectrum-web-components/underlay	Patch
@spectrum-web-components/base	Patch
@spectrum-web-components/opacity-checkerboard	Patch
@spectrum-web-components/shared	Patch
@spectrum-web-components/styles	Patch
@spectrum-web-components/theme	Patch
@spectrum-web-components/eslint-plugin	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2025-11-19T14:24:10Z

📚 Branch Preview Links

🔍 First Generation Visual Regression Test Results

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

Deployed to Azure Blob Storage: pr-5901

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

.changeset/brave-deer-pick.md

.changeset/cold-chefs-jog.md

marissahuysentruyt · 2025-11-20T23:08:21Z

1st-gen/packages/picker/test/picker-responsive.test.ts

+            expect(el.optionsMenu.shouldSupportDragAndSelect).to.be.true;
+        });
+
+        it('dispatches change event when menu item is clicked on touch device', async () => {


Does this test fail for you occasionally? Or could it be me?

Could we maybe need an await nextFrame();? Could the menu.click() event not be propogating correctly since we're sort of "faking" a touch device here?

You are right @marissahuysentruyt I too see this error while running locally.
The menu wasn't fully ready when clicking so the test was timing out. I added a check to wait for the menu to update. What is happening here is that the menu renders asynchronously in an overlay. updateComplete ensures Lit has finished rendering and elementUpdated ensures that the DOM reflects those changes. We need these two boundaries to make sure menu is ready in the DOM for clicks.
Added a fix here
cc @iuliauta

…spectrum-web-components into iuta/menu-item-ipad-click

Rajdeepc

Tests look ok! el.isTouchDevice.matches is brittle though but since Playwright lacks the capability of touch device testing this is good for now.

Rajdeepc · 2025-11-21T06:11:42Z

.changeset/cold-chefs-jog.md

+'@spectrum-web-components/reactive-controllers': patch
+---
+
+**Added**: IS_TOUCH_DEVICE media query constant
+
+- Added IS_TOUCH_DEVICE constant: '(hover: none) and (pointer: coarse)'
+- Detects any touch-capable device regardless of screen size
+- Unlike IS_MOBILE (max-width: 743px), this matches iPads and all tablets


This changeset is not needed. You can remove it

Rajdeepc · 2025-11-21T06:13:37Z

.changeset/brave-deer-pick.md

+**Fixed**: iPad menu item click events not working
+
+- Changed from isMobile to isTouchDevice for shouldSupportDragAndSelect property
+- Fixes issue where menu items in action menus on iPad/tablets would not dispatch click events
+- All touch devices (including iPads with screen widths >743px) now correctly use click events instead of drag-and-select behavior


Suggested change

**Fixed**: iPad menu item click events not working

- Changed from isMobile to isTouchDevice for shouldSupportDragAndSelect property

- Fixes issue where menu items in action menus on iPad/tablets would not dispatch click events

- All touch devices (including iPads with screen widths >743px) now correctly use click events instead of drag-and-select behavior

**Fixed**: click events are now dispatched from menu-items on touch devices

- All touch devices (including iPads with screen widths >743px) now correctly use click events instead of drag-and-select behavior

Rajdeepc · 2025-11-21T06:17:45Z

1st-gen/packages/picker/test/picker-responsive.test.ts

+             * so that we can test the touch device behavior.
+             */
+            el.isTouchDevice.matches = true;
+            el.bindEvents();


bindEvents() might add duplicate listeners. You will loose idempotency here. Call it only once in the fixture setup or reset the environment between tests.

Rajdeepc · 2025-11-21T06:19:22Z

1st-gen/packages/picker/test/picker-responsive.test.ts

+            const menuItem = el.querySelector(
+                'sp-menu-item[value="option-2"]'
+            ) as MenuItem;
+            expect(menuItem).to.not.be.null;


If you query for menu item with el.querySelector you may miss items in shadow DOM. you should query the menu through el.optionsMenu (e.g. el.optionsMenu.childItems[index] or el.optionsMenu.querySelector(...)) which you already wait for with waitUntil.

Rajdeepc · 2025-11-21T06:20:41Z

1st-gen/packages/picker/test/picker-responsive.test.ts

+        afterEach(() => {
+            // Reset touch device simulation.
+            if (el && el.isTouchDevice) {
+                el.isTouchDevice.matches = false;
+            }
+        });


This is incomplete. You have tests which also modify el.isMobile.matches in one test but don’t reset that value. Either restore the matchMedia stub in afterEach or explicitly reset both isTouchDevice and isMobile.

Rajdeepc · 2025-11-21T06:56:51Z

1st-gen/packages/picker/test/picker-responsive.test.ts

+            expect(el.optionsMenu.shouldSupportDragAndSelect).to.be.true;
+        });
+
+        it('dispatches change event when menu item is clicked on touch device', async () => {


You are right @marissahuysentruyt I too see this error while running locally.
The menu wasn't fully ready when clicking so the test was timing out. I added a check to wait for the menu to update. What is happening here is that the menu renders asynchronously in an overlay. updateComplete ensures Lit has finished rendering and elementUpdated ensures that the DOM reflects those changes. We need these two boundaries to make sure menu is ready in the DOM for clicks.
Added a fix here
cc @iuliauta

iuliauta self-assigned this Nov 19, 2025

iuliauta added the Status: WIP PR is a work in progress or draft label Nov 19, 2025

fix(menu): ipad menu item click

7523d6a

iuliauta force-pushed the iuta/menu-item-ipad-click branch from 3ece1a2 to 7523d6a Compare November 19, 2025 14:18

marissahuysentruyt reviewed Nov 19, 2025

View reviewed changes

.changeset/brave-deer-pick.md Outdated Show resolved Hide resolved

marissahuysentruyt reviewed Nov 19, 2025

View reviewed changes

.changeset/cold-chefs-jog.md Outdated Show resolved Hide resolved

iuliauta marked this pull request as ready for review November 19, 2025 19:41

iuliauta requested a review from a team as a code owner November 19, 2025 19:41

iuliauta added Status: Ready for review PR ready for review or re-review. Component: Picker and removed Status: WIP PR is a work in progress or draft labels Nov 19, 2025

caseyisonit added the Contribution PRs from contributors label Nov 19, 2025

docs: apply changeset formatting suggestions from review

65e6978

Rajdeepc mentioned this pull request Nov 20, 2025

fix(menu): ipad menu item click #5829

Closed

15 tasks

Merge branch 'main' into iuta/menu-item-ipad-click

dd2df56

marissahuysentruyt reviewed Nov 20, 2025

View reviewed changes

Rajdeep Chandra added 2 commits November 21, 2025 12:27

test: menu now handle clicks properly

aca60ba

Merge branch 'iuta/menu-item-ipad-click' of https://github.com/adobe/…

b2194cc

…spectrum-web-components into iuta/menu-item-ipad-click

Rajdeepc reviewed Nov 21, 2025

View reviewed changes

fix(menu): ipad menu item click #5901

Are you sure you want to change the base?

fix(menu): ipad menu item click #5901

Uh oh!

Conversation

iuliauta commented Nov 19, 2025

Description

Issue

Symptoms

Root cause

Technical details

Solution

Motivation and context

Related issue(s)

Screenshots (if appropriate)

Author's checklist

Reviewer's checklist

Manual review test cases

Device review

Uh oh!

changeset-bot bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Nov 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📚 Branch Preview Links

🔍 First Generation Visual Regression Test Results

Uh oh!

Uh oh!

Uh oh!

marissahuysentruyt Nov 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Rajdeepc left a comment

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Rajdeepc Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

changeset-bot bot commented Nov 19, 2025 •

edited

Loading

github-actions bot commented Nov 19, 2025 •

edited

Loading

marissahuysentruyt Nov 20, 2025 •

edited

Loading

Rajdeepc Nov 21, 2025 •

edited

Loading

Rajdeepc Nov 21, 2025 •

edited

Loading