Skip to content
Open
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
89 changes: 87 additions & 2 deletions packages/main/cypress/specs/List.cy.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -378,7 +378,7 @@ describe("List - Accessibility", () => {

it("has default aria-description for accessibleRole List when no accessibleDescription is set", () => {
cy.mount(
<List>
<List selectionMode="Delete">
Comment thread
NakataCode marked this conversation as resolved.
<ListItemStandard>Item 1</ListItemStandard>
<ListItemStandard>Item 2</ListItemStandard>
</List>
Expand Down Expand Up @@ -413,7 +413,7 @@ describe("List - Accessibility", () => {
const customDescription = "Custom list description";

cy.mount(
<List accessibleDescription={customDescription}>
<List selectionMode="Delete" accessibleDescription={customDescription}>
<ListItemStandard>Item 1</ListItemStandard>
<ListItemStandard>Item 2</ListItemStandard>
</List>
Expand Down Expand Up @@ -457,6 +457,91 @@ describe("List - Accessibility", () => {
});
});
});

it("does not announce F2 instruction for selectionMode None with standard items", () => {
cy.mount(
<List selectionMode="None">
<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.not.include(defaultText);
});
});
});

it("announces F2 instruction for selectionMode Delete", () => {
cy.mount(
<List selectionMode="Delete">
<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);
});
});
});

it("announces F2 instruction for selectionMode None with type Detail items", () => {
cy.mount(
<List selectionMode="None">
<ListItemStandard type="Detail">Item 1</ListItemStandard>
<ListItemStandard type="Detail">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);
});
});
});

it("announces F2 instruction for selectionMode None with custom list items", () => {
cy.mount(
<List selectionMode="None">
<ListItemCustom>
<Button>Action</Button>
</ListItemCustom>
</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);
});
});
});
});

describe("List - Wrapping Behavior", () => {
Expand Down
13 changes: 12 additions & 1 deletion packages/main/src/List.ts
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ import type CheckBox from "./CheckBox.js";
import type RadioButton from "./RadioButton.js";
import { isInstanceOfListItemGroup } from "./ListItemGroup.js";
import type ListItemGroup from "./ListItemGroup.js";
import { isInstanceOfListItemCustom } from "./ListItemCustom.js";

const INFINITE_SCROLL_DEBOUNCE_RATE = 250; // ms

Expand Down Expand Up @@ -742,7 +743,7 @@ class List extends UI5Element {
get ariaDescriptionText() {
const parts = [];

if (this.accessibleRole === ListAccessibleRole.List) {
if (this.accessibleRole === ListAccessibleRole.List && this._hasInteractiveItems) {
parts.push(this.defaultAriaDescriptionText);
}
const externalDescription = this._associatedDescriptionRefTexts || getEffectiveAriaDescriptionText(this);
Expand All @@ -763,6 +764,16 @@ class List extends UI5Element {
return List.i18nBundle.getText(LIST_ROLE_DESCRIPTION);
}

get _hasInteractiveItems() {
if (this.selectionMode === ListSelectionMode.Delete) {
return true;
}

return this.getItems().some(item => {
return item.getAttribute("type") === "Detail" || isInstanceOfListItemCustom(item);
});
}

get growingButtonAriaLabel() {
return this.accessibilityAttributes.growingButton?.name;
}
Expand Down
8 changes: 8 additions & 0 deletions packages/main/src/ListItemCustom.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import type { ClassMap, AccessibilityInfo } from "@ui5/webcomponents-base/dist/t
import customElement from "@ui5/webcomponents-base/dist/decorators/customElement.js";
import property from "@ui5/webcomponents-base/dist/decorators/property.js";
import i18n from "@ui5/webcomponents-base/dist/decorators/i18n.js";
import createInstanceChecker from "@ui5/webcomponents-base/dist/util/createInstanceChecker.js";
import ListItem from "./ListItem.js";
import ListItemCustomTemplate from "./ListItemCustomTemplate.js";
import { getCustomAnnouncement, applyCustomAnnouncement } from "./CustomAnnouncement.js";
Expand Down Expand Up @@ -44,6 +45,11 @@ import ListItemCustomCss from "./generated/themes/ListItemCustom.css.js";
class ListItemCustom extends ListItem {
@i18n("@ui5/webcomponents")
static i18nBundle: I18nBundle;

get isCustomListItem() {
return true;
}

/**
* Defines whether the item is movable.
* @default false
Expand Down Expand Up @@ -193,3 +199,5 @@ class ListItemCustom extends ListItem {
ListItemCustom.define();

export default ListItemCustom;

export const isInstanceOfListItemCustom = createInstanceChecker<ListItemCustom>("isCustomListItem");
Loading