Skip to content

feat(ui5-list): add live region announcement for item selection (POC) #13440

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
NakataCode wants to merge 1 commit into
base: main
Choose a base branch
from
+68 −0
Open

feat(ui5-list): add live region announcement for item selection (POC) #13440

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
58 changes: 58 additions & 0 deletions packages/main/cypress/specs/List.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,64 @@ describe("List - Accessibility", () => {
});
});
});

it("announces 'Selected' when an item is selected in Single mode", () => {
cy.mount(
<List selectionMode="Single">
<ListItemStandard id="item1">Argentina</ListItemStandard>
<ListItemStandard id="item2">Bulgaria</ListItemStandard>
</List>
);

cy.get(".ui5-invisiblemessage-polite").as("liveRegion");

cy.get("#item1").realClick();
cy.get("@liveRegion").should("contain.text", "Selected");
});

it("announces 'Selected' and 'Not Selected' when items are toggled in Multiple mode", () => {
cy.mount(
<List selectionMode="Multiple">
<ListItemStandard id="item1">Argentina</ListItemStandard>
<ListItemStandard id="item2">Bulgaria</ListItemStandard>
</List>
);

cy.get(".ui5-invisiblemessage-polite").as("liveRegion");

cy.get("#item1").realClick();
cy.get("@liveRegion").should("contain.text", "Selected");

cy.get("#item1").realClick();
cy.get("@liveRegion").should("contain.text", "Not Selected");
});

it("does not announce selection when selectionMode is None", () => {
cy.mount(
<List selectionMode="None">
<ListItemStandard id="item1">Argentina</ListItemStandard>
</List>
);

cy.get(".ui5-invisiblemessage-polite").as("liveRegion");

cy.get("#item1").realClick();
cy.get("@liveRegion").should("have.text", "");
});

it("does not announce selection when selection-change event is prevented", () => {
cy.mount(
<List selectionMode="Single" onSelectionChange={(e: CustomEvent) => e.preventDefault()}>
<ListItemStandard id="item1">Argentina</ListItemStandard>
<ListItemStandard id="item2">Bulgaria</ListItemStandard>
</List>
);

cy.get(".ui5-invisiblemessage-polite").as("liveRegion");

cy.get("#item1").realClick();
cy.get("@liveRegion").should("have.text", "");
});
});

describe("List - Wrapping Behavior", () => {
Expand Down
10 changes: 10 additions & 0 deletions packages/main/src/List.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ import {
getAllAccessibleNameRefTexts,
} from "@ui5/webcomponents-base/dist/util/AccessibilityTextsHelper.js";
import getNormalizedTarget from "@ui5/webcomponents-base/dist/util/getNormalizedTarget.js";
import announce from "@ui5/webcomponents-base/dist/util/InvisibleMessage.js";
import InvisibleMessageMode from "@ui5/webcomponents-base/dist/types/InvisibleMessageMode.js";
import type I18nBundle from "@ui5/webcomponents-base/dist/i18nBundle.js";
import debounce from "@ui5/webcomponents-base/dist/util/debounce.js";
import isElementInView from "@ui5/webcomponents-base/dist/util/isElementInView.js";
Expand Down Expand Up @@ -70,6 +72,8 @@ import {
LOAD_MORE_TEXT, ARIA_LABEL_LIST_SELECTABLE,
ARIA_LABEL_LIST_MULTISELECTABLE,
ARIA_LABEL_LIST_DELETABLE,
LIST_ITEM_SELECTED,
LIST_ITEM_NOT_SELECTED,
} from "./generated/i18n/i18n-defaults.js";
import type CheckBox from "./CheckBox.js";
import type RadioButton from "./RadioButton.js";
Expand Down Expand Up @@ -917,6 +921,12 @@ class List extends UI5Element {
});
if (changePrevented) {
this._revertSelection(previouslySelectedItems);
} else {
const item = e.detail.item;
const selectedText = item.selected
? List.i18nBundle.getText(LIST_ITEM_SELECTED)
: List.i18nBundle.getText(LIST_ITEM_NOT_SELECTED);
announce(selectedText, InvisibleMessageMode.Polite);
}
}
}
Expand Down
Loading