Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
82 changes: 82 additions & 0 deletions packages/main/cypress/specs/List.cy.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -374,6 +374,88 @@ describe("List - Accessibility", () => {
.should("not.have.text", "Is Active");
});
});

it("has default aria-description for accessibleRole List when no accessibleDescription is set", () => {
cy.mount(
<List>
<ListItemStandard>Item 1</ListItemStandard>
<ListItemStandard>Item 2</ListItemStandard>
</List>
);

cy.get("[ui5-list]")
.shadow()
.find(".ui5-list-ul")
.should("have.attr", "aria-description")
.and("not.be.empty");

cy.get("[ui5-list]")
.should(($list) => {
const defaultText = $list.prop("defaultAriaDescriptionText") as string;
expect(defaultText).to.not.be.empty;
});

cy.get("[ui5-list]")
.shadow()
.find(".ui5-list-ul")
.invoke("attr", "aria-description")
.then((ariaDesc) => {
cy.get("[ui5-list]")
.should(($list) => {
const defaultText = $list.prop("defaultAriaDescriptionText") as string;
expect(ariaDesc).to.equal(defaultText);
});
});
});

it("combines default aria-description with user-provided accessibleDescription for accessibleRole List", () => {
const customDescription = "Custom list description";

cy.mount(
<List accessibleDescription={customDescription}>
<ListItemStandard>Item 1</ListItemStandard>
<ListItemStandard>Item 2</ListItemStandard>
</List>
);

cy.get("[ui5-list]")
.shadow()
.find(".ui5-list-ul")
.invoke("attr", "aria-description")
.then((ariaDesc) => {
cy.get("[ui5-list]")
.should(($list) => {
const defaultText = $list.prop("defaultAriaDescriptionText") as string;
expect(ariaDesc).to.include(defaultText);
expect(ariaDesc).to.include(customDescription);
expect(ariaDesc).to.equal(`${defaultText} ${customDescription}`);
});
});
});

it("does not prepend default aria-description for accessibleRole ListBox", () => {
const customDescription = "Custom list description";

cy.mount(
<List accessibleRole="ListBox" accessibleDescription={customDescription}>
<ListItemStandard>Item 1</ListItemStandard>
<ListItemStandard>Item 2</ListItemStandard>
</List>
);

cy.get("[ui5-list]")
.shadow()
.find(".ui5-list-ul")
.invoke("attr", "aria-description")
.then((ariaDesc) => {
cy.get("[ui5-list]")
.should(($list) => {
const defaultText = $list.prop("defaultAriaDescriptionText") as string;
expect(ariaDesc).to.equal(customDescription);
expect(ariaDesc).to.not.include(defaultText);
});
});
});
});

describe("List - Wrapping Behavior", () => {
Expand Down
23 changes: 22 additions & 1 deletion packages/main/src/List.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ import listCss from "./generated/themes/List.css.js";

// Texts
import {
LIST_ROLE_DESCRIPTION,
LIST_ROLE_LIST_GROUP_DESCRIPTION,
LIST_ROLE_LISTBOX_GROUP_DESCRIPTION,
LOAD_MORE_TEXT, ARIA_LABEL_LIST_SELECTABLE,
Expand Down Expand Up @@ -739,7 +740,27 @@ class List extends UI5Element {
}

get ariaDescriptionText() {
return this._associatedDescriptionRefTexts || getEffectiveAriaDescriptionText(this) || this._getDescriptionForGroups();
const parts = [];

if (this.accessibleRole === ListAccessibleRole.List) {
parts.push(this.defaultAriaDescriptionText);
}
const externalDescription = this._associatedDescriptionRefTexts || getEffectiveAriaDescriptionText(this);

if (externalDescription) {
parts.push(externalDescription);
}

const groupDescription = this._getDescriptionForGroups();
if (groupDescription) {
parts.push(groupDescription);
}

return parts.join(" ");
}

get defaultAriaDescriptionText() {
return List.i18nBundle.getText(LIST_ROLE_DESCRIPTION);
}

get growingButtonAriaLabel() {
Expand Down
3 changes: 3 additions & 0 deletions packages/main/src/i18n/messagebundle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,9 @@ LINK_SUBTLE=Subtle
#XFLD: Emphasized link description label
LINK_EMPHASIZED=Emphasized

#XACT: ARIA announcement for the interactive nature of the list
LIST_ROLE_DESCRIPTION=List with interactive items. To move to the content press F2.

#XACT: ARIA announcement for the active clickable list items
LIST_ITEM_ACTIVE=Is Active

Expand Down
Loading