Skip to content

feat(ui5-icon): implement accessibilityInfo getter #12604

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
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

feat(ui5-icon): implement accessibilityInfo getter #12604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
062df5e
feat(ui5-icon): implement accessibilityInfo getter
IlianaB Nov 3, 2025
f5259ad
chore: add translatable type in accessibilityInfo and return undefine…
IlianaB Nov 18, 2025
7ae10a1
Merge branch 'main' into icon-accessibilityinfo-getter
IlianaB Nov 18, 2025
720690c
Merge branch 'main' into icon-accessibilityinfo-getter
IlianaB Nov 19, 2025
cd19b8b
Merge branch 'main' into icon-accessibilityinfo-getter
IlianaB Nov 24, 2025
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
66 changes: 65 additions & 1 deletion packages/main/cypress/specs/Icon.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,4 +274,68 @@ describe("Icon general interaction", () => {
.find(".ui5-icon-root")
.should("have.attr", "role", "img");
});
});

it("Tests accessibilityInfo getter", () => {
const interactiveMode = "Interactive";
const imageMode = "Image";
const decorativeMode = "Decorative";
const accessibleName = "Test Icon";

// Test with Interactive mode
cy.mount(
<Icon
name="add-equipment"
mode={interactiveMode}
accessibleName={accessibleName}
/>
);

cy.get("[ui5-icon][mode='Interactive']").then($icon => {
const icon = $icon[0] as any;
const accessibilityInfo = icon.accessibilityInfo;

// For Interactive mode, accessibilityInfo should have role, type and description
expect(accessibilityInfo).to.not.be.undefined;
expect(accessibilityInfo.role).to.equal("button");
expect(accessibilityInfo.type).to.equal("Button");
expect(accessibilityInfo.description).to.equal(accessibleName);
});

// Test with Decorative mode
cy.mount(
<Icon
name="add-equipment"
mode={decorativeMode}
accessibleName={accessibleName}
/>
);

cy.get("[ui5-icon][mode='Decorative']").then($icon => {
const icon = $icon[0] as any;
const accessibilityInfo = icon.accessibilityInfo;

// For Decorative mode, accessibilityInfo should be undefined
expect(accessibilityInfo).to.be.undefined;
});

// Test with Image mode
cy.mount(
<Icon
name="add-equipment"
mode={imageMode}
accessibleName={accessibleName}
/>
);

cy.get("[ui5-icon][mode='Image']").then($icon => {
const icon = $icon[0] as any;
const accessibilityInfo = icon.accessibilityInfo;

// For Image mode, accessibilityInfo should have role, type and description
expect(accessibilityInfo).to.not.be.undefined;
expect(accessibilityInfo.role).to.equal("img");
expect(accessibilityInfo.type).to.equal("Image");
expect(accessibilityInfo.description).to.equal(accessibleName);
});
});
});
32 changes: 32 additions & 0 deletions packages/main/src/Icon.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,22 @@ import jsxRender from "@ui5/webcomponents-base/dist/renderer/JsxRenderer.js";
import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
import event from "@ui5/webcomponents-base/dist/decorators/event-strict.js";
import property from "@ui5/webcomponents-base/dist/decorators/property.js";
import type { AriaRole } from "@ui5/webcomponents-base/dist/types.js";
import type { IconData, UnsafeIconData } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
import { getIconData, getIconDataSync } from "@ui5/webcomponents-base/dist/asset-registries/Icons.js";
import { getI18nBundle } from "@ui5/webcomponents-base/dist/i18nBundle.js";
import type { I18nText } from "@ui5/webcomponents-base/dist/i18nBundle.js";
import type I18nBundle from "@ui5/webcomponents-base/dist/i18nBundle.js";
import i18n from "@ui5/webcomponents-base/dist/decorators/i18n.js";
import { isDesktop } from "@ui5/webcomponents-base/dist/Device.js";
import { isSpace, isEnter } from "@ui5/webcomponents-base/dist/Keys.js";
import executeTemplate from "@ui5/webcomponents-base/dist/renderer/executeTemplate.js";
import IconTemplate from "./IconTemplate.js";
import type IconDesign from "./types/IconDesign.js";
import IconMode from "./types/IconMode.js";

import { ICON_ARIA_TYPE_IMAGE, ICON_ARIA_TYPE_INTERACTIVE } from "./generated/i18n/i18n-defaults.js";

// Styles
import iconCss from "./generated/themes/Icon.css.js";

Expand Down Expand Up @@ -117,6 +122,10 @@ class Icon extends UI5Element implements IIcon {
eventDetails!: {
click: void
}

@i18n("@ui5/webcomponents")
static i18nBundle: I18nBundle;

/**
* Defines the component semantic design.
* @default "Default"
Expand Down Expand Up @@ -327,6 +336,29 @@ class Icon extends UI5Element implements IIcon {
get hasIconTooltip() {
return this.showTooltip && this.effectiveAccessibleName;
}

_getAriaTypeDescription() {
switch (this.mode) {
case IconMode.Interactive:
return Icon.i18nBundle.getText(ICON_ARIA_TYPE_INTERACTIVE);
case IconMode.Image:
return Icon.i18nBundle.getText(ICON_ARIA_TYPE_IMAGE);
default:
return "";
}
}

get accessibilityInfo() {
if (this.mode === IconMode.Decorative) {
return undefined;
Copy link
Contributor

@ilhan007 ilhan007 Nov 25, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @IlianaB

although the code is completely fine, we would like to suggest a small change - returning empty object {}, instead of undefined when the Icon is decorative.

Context
There was one thing we did not think of until now and it's that the base class (UI5Element) returns undefined by default. And, when decorative, the Icon also returns undefined.

In this case, the component that reads the accessibilityInfo of the components it contains, can't determine if the child component does not implement accessibilityInfo at all or the child component implements it, but must remain hidden from a11y point of view (as the decorative Icon).

For example, the Table has logic by design to provide default accessibility for elements that don't provide such. And in this case, it can't determine if it should provide such default accessibility or not. It reads the accessibilityInfo from the Icon, gets undefined, and applies default accessibility logic (but should not as it's decorative icon and should be hidden from a11y point of view).

We had to decide between these 3 options and picked up the first:

  • returning {}
  • returning null
  • or removing the base implementation

}

return {
role: this.effectiveAccessibleRole as AriaRole,
type: this._getAriaTypeDescription(),
description: this.effectiveAccessibleName,
};
}
}

Icon.define();
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 @@ -942,3 +942,9 @@ DYNAMIC_DATE_RANGE_NEXT_COMBINED_TEXT=Next X {0} (included)

#XFLD: Suffix text for included date range options.
DYNAMIC_DATE_RANGE_INCLUDED_TEXT=(included)

#XACT: ARIA announcement for icon type image
ICON_ARIA_TYPE_IMAGE=Image

#XACT: ARIA announcement for icon type interactive
ICON_ARIA_TYPE_INTERACTIVE=Button
Loading