Skip to content

fix(ui5-menu): improve accessibility for end content and loading state #13099

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

Open
hinzzx wants to merge 1 commit into
base: main
Choose a base branch
from
+40 −1
Open

fix(ui5-menu): improve accessibility for end content and loading state #13099

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
10 changes: 10 additions & 0 deletions packages/main/src/MenuItem.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ import {
MENU_BACK_BUTTON_ARIA_LABEL,
MENU_CANCEL_BUTTON_TEXT,
MENU_POPOVER_ACCESSIBLE_NAME,
MENU_ITEM_END_CONTENT_ACCESSIBLE_NAME,
MENU_ITEM_LOADING,
} from "./generated/i18n/i18n-defaults.js";
import type { IMenuItem } from "./Menu.js";

Expand Down Expand Up @@ -399,6 +401,14 @@ class MenuItem extends ListItem implements IMenuItem {
return MenuItem.i18nBundle.getText(MENU_POPOVER_ACCESSIBLE_NAME);
}

get endContentAccessibleName() {
return MenuItem.i18nBundle.getText(MENU_ITEM_END_CONTENT_ACCESSIBLE_NAME);
}

get loadingText() {
return MenuItem.i18nBundle.getText(MENU_ITEM_LOADING);
}

onBeforeRendering() {
super.onBeforeRendering();

Expand Down
20 changes: 19 additions & 1 deletion packages/main/src/MenuItemTemplate.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,15 @@ function rightContent(this: MenuItem) {
</div>
);
case this.hasEndContent:
return <slot name="endContent" onKeyDown={this._endContentKeyDown}></slot>;
return (
<div
class="ui5-menu-item-end-content"
role="group"
aria-label={this.endContentAccessibleName}
>
<slot name="endContent" onKeyDown={this._endContentKeyDown}></slot>
</div>
);
case !!this.additionalText:
return (
<span
Expand Down Expand Up @@ -123,6 +131,7 @@ function listItemPostContent(this: MenuItem) {
<div
id={`${this._id}-menu-main`}
class={this.loading ? "menu-busy-indicator-main" : ""}
aria-busy={this.loading}
>
{
this.items.length ? (
Expand Down Expand Up @@ -150,6 +159,15 @@ function listItemPostContent(this: MenuItem) {
/>
}
</div >

{/* ARIA live region for loading state announcement */}
<span
class="ui5-hidden-text"
aria-live="polite"
aria-atomic="true"
>
{this.loading ? this.loadingText : ""}
</span>
{
this.isPhone && (
<div slot="footer" class="ui5-menu-dialog-footer">
Expand Down
6 changes: 6 additions & 0 deletions packages/main/src/i18n/messagebundle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -805,6 +805,12 @@ MENU_ITEM_GROUP_SINGLE_ACCESSIBLE_NAME=Contains Selectable Items
#XACT: ARIA information for the Menu Item Group with itemSelectionMode "MultiSelect"
MENU_ITEM_GROUP_MULTI_ACCESSIBLE_NAME=Contains Multi-Selectable Items

#XACT: ARIA information for the Menu Item end content slot
MENU_ITEM_END_CONTENT_ACCESSIBLE_NAME=Additional Actions

#XACT: ARIA information for the Menu Item loading state
MENU_ITEM_LOADING=Loading

#XACT: ARIA announcement for roldesecription attribute of Dialog header
DIALOG_HEADER_ARIA_ROLE_DESCRIPTION=Interactive Header

Expand Down
5 changes: 5 additions & 0 deletions packages/main/src/themes/MenuItem.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,11 @@
padding-top: 0.25rem;
}

.ui5-menu-item-end-content {
display: inline-flex;
align-items: center;
}

.ui5-menu-busy-indicator {
position: absolute;
width: 100%;
Expand Down
Loading