Skip to content

chore(ui5-user-menu): open submenu on hover instead of click #13437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SvilenDarvenyashki merged 1 commit into from
Apr 30, 2026
+168 −3
Merged

chore(ui5-user-menu): open submenu on hover instead of click #13437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 117 additions & 0 deletions packages/fiori/cypress/specs/UserMenu.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -916,6 +916,123 @@ describe("Responsiveness", () => {
});
});

describe("Submenu hover behavior", () => {
it("should open submenu on hover over item with subitems", () => {
cy.mount(
<>
<Button id="openUserMenuBtn">Open User Menu</Button>
<UserMenu open={true} opener="openUserMenuBtn">
<UserMenuAccount slot="accounts" titleText="Alain Chevalier 1"></UserMenuAccount>
<UserMenuItem text="Setting" data-id="setting"></UserMenuItem>
<UserMenuItem text="Legal Information">
<UserMenuItem text="Privacy Policy" data-id="privacy-policy"></UserMenuItem>
<UserMenuItem text="Terms of Use" data-id="terms-of-use"></UserMenuItem>
</UserMenuItem>
</UserMenu>
</>
);

cy.get("[ui5-user-menu]").as("userMenu");
cy.get("@userMenu")
.find("> [ui5-user-menu-item]")
.as("items");

cy.get("@items")
.eq(1)
.should("be.visible")
.as("parentItem");

cy.get("@parentItem").realHover();

cy.get("@parentItem")
.shadow()
.find("[ui5-responsive-popover]")
.should("have.attr", "open");
});

it("should close submenu when hover moves to another item", () => {
cy.mount(
<>
<Button id="openUserMenuBtn">Open User Menu</Button>
<UserMenu open={true} opener="openUserMenuBtn">
<UserMenuAccount slot="accounts" titleText="Alain Chevalier 1"></UserMenuAccount>
<UserMenuItem text="Setting" data-id="setting"></UserMenuItem>
<UserMenuItem text="Legal Information">
<UserMenuItem text="Privacy Policy" data-id="privacy-policy"></UserMenuItem>
<UserMenuItem text="Terms of Use" data-id="terms-of-use"></UserMenuItem>
</UserMenuItem>
</UserMenu>
</>
);

cy.get("[ui5-user-menu]").as("userMenu");
cy.get("@userMenu")
.find("> [ui5-user-menu-item]")
.as("items");

cy.get("@items")
.eq(1)
.should("be.visible")
.as("parentItem");

cy.get("@parentItem").realHover();

cy.get("@parentItem")
.shadow()
.find("[ui5-responsive-popover]")
.as("submenuPopover");

cy.get("@submenuPopover")
.should("have.attr", "open");

cy.get("@items")
.eq(0)
.should("be.visible")
.as("otherItem");

cy.get("@otherItem").realHover();

cy.get("@submenuPopover")
.should("not.have.attr", "open");
});

it("should not move focus to submenu when opened via hover", () => {
cy.mount(
<>
<Button id="openUserMenuBtn">Open User Menu</Button>
<UserMenu open={true} opener="openUserMenuBtn">
<UserMenuAccount slot="accounts" titleText="Alain Chevalier 1"></UserMenuAccount>
<UserMenuItem text="Legal Information">
<UserMenuItem text="Privacy Policy" data-id="privacy-policy"></UserMenuItem>
<UserMenuItem text="Terms of Use" data-id="terms-of-use"></UserMenuItem>
</UserMenuItem>
</UserMenu>
</>
);

cy.get("[ui5-user-menu]").as("userMenu");
cy.get("@userMenu")
.find("> [ui5-user-menu-item]")
.first()
.should("be.visible")
.as("parentItem");

cy.get("@parentItem").realHover();

cy.get("@parentItem")
.shadow()
.find("[ui5-responsive-popover]")
.should("have.attr", "open");

cy.get("@parentItem")
.should("be.focused");

cy.get("[ui5-user-menu-item] > [ui5-user-menu-item]")
.first()
.should("not.be.focused");
});
});

describe("Footer configuration", () => {
it("tests default footer with Sign Out button", () => {
cy.mount(
Expand Down
53 changes: 50 additions & 3 deletions packages/fiori/src/UserMenu.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ import type I18nBundle from "@ui5/webcomponents-base/dist/i18nBundle.js";
import type { PopupScrollEventDetail } from "@ui5/webcomponents/dist/Popup.js";
import i18n from "@ui5/webcomponents-base/dist/decorators/i18n.js";
import { isInstanceOfMenuItem } from "@ui5/webcomponents/dist/MenuItem.js";
import { isPhone } from "@ui5/webcomponents-base/dist/Device.js";
import { isPhone, isDesktop } from "@ui5/webcomponents-base/dist/Device.js";
import type { Timeout } from "@ui5/webcomponents-base/dist/types.js";
import type UserMenuAccount from "./UserMenuAccount.js";
import type UserMenuItem from "./UserMenuItem.js";
import UserMenuTemplate from "./UserMenuTemplate.js";
Expand All @@ -35,6 +36,8 @@ import {
USER_MENU_ACTIONS_TXT,
} from "./generated/i18n/i18n-defaults.js";

const MENU_OPEN_DELAY = 300;

type UserMenuItemClickEventDetail = {
item: UserMenuItem;
}
Expand Down Expand Up @@ -260,6 +263,11 @@ class UserMenu extends UI5Element {
*/
_observer?: IntersectionObserver;

/**
* @private
*/
_timeout?: Timeout;

/**
* @private
*/
Expand Down Expand Up @@ -372,7 +380,7 @@ class UserMenu extends UI5Element {
}

_handleMenuItemClick(e: CustomEvent<ListItemClickEventDetail>) {
const item = e.detail.item as UserMenuItem; // imrove: improve this ideally without "as" cating
const item = e.detail.item as UserMenuItem;

item._updateCheckedState();

Expand All @@ -385,6 +393,7 @@ class UserMenu extends UI5Element {
item.fireEvent("close-menu");
}
} else {
this._closeOtherSubMenus(item);
this._openItemSubMenu(item);
}
}
Expand All @@ -409,14 +418,52 @@ class UserMenu extends UI5Element {
this.fireDecoratorEvent("close");
}

_openItemSubMenu(item: UserMenuItem) {
_itemMouseOver(e: MouseEvent) {
if (!isDesktop()) {
return;
}

const item = e.target as UserMenuItem;
if (!isInstanceOfMenuItem(item)) {
return;
}

item.getFocusDomRef()?.focus();
this._startOpenTimeout(item);
}

_startOpenTimeout(item: UserMenuItem) {
clearTimeout(this._timeout);

this._timeout = setTimeout(() => {
this._closeOtherSubMenus(item);
this._openItemSubMenu(item, true);
}, MENU_OPEN_DELAY);
}

_closeOtherSubMenus(item: UserMenuItem) {
if (!this._menuItems.includes(item)) {
return;
}

this._menuItems.forEach(menuItem => {
if (menuItem !== item) {
menuItem._close();
}
});
}

_openItemSubMenu(item: UserMenuItem, openedByMouse = false) {
clearTimeout(this._timeout);

if (!item._popover || item._popover.open) {
return;
}

item._popover.opener = item;
item._popover.open = true;
item.selected = true;
item._openedByMouse = openedByMouse;
}

_closeUserMenu() {
Expand Down
1 change: 1 addition & 0 deletions packages/fiori/src/UserMenuTemplate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ export default function UserMenuTemplate(this: UserMenu) {
accessibleRole="Menu"
accessibleName={this._ariaLabelledByActions}
onItemClick={this._handleMenuItemClick}
onMouseOver={this._itemMouseOver}
onui5-close-menu={this._handleMenuItemClose}
>
<slot></slot>
Expand Down
Loading