Skip to content

feat(SelectDialog): add SR announcement for number of selected items #7598

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

Merged
merged 3 commits into from
Aug 5, 2025
Merged

feat(SelectDialog): add SR announcement for number of selected items #7598

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc6c20d
feat(SelectDialog): add SR announcement for number of selected items
Lukas742 Jul 30, 2025
49f827d
fix `onConfirm` type
Lukas742 Jul 30, 2025
05c0697
Merge branch 'main' into fix/sd-invisible-message
Lukas742 Aug 5, 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
20 changes: 20 additions & 0 deletions packages/main/src/components/SelectDialog/SelectDialog.cy.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,4 +303,24 @@ describe('SelectDialog', () => {
cy.findByTestId('confirmBtn').should('be.visible').and('have.attr', 'disabled');
cy.findByTestId('confirmBtn').should('have.attr', 'design', 'Emphasized');
});

it('invisible messaging', () => {
cy.mount(
<SelectDialog open selectionMode={ListSelectionMode.Multiple}>
<ListItemStandard text={'ListItem 1'} data-testid="1" />
<ListItemStandard text={'ListItem 2'} data-testid="2" />
<ListItemStandard text={'ListItem 3'} data-testid="3" />
<ListItemStandard text={'ListItem 4'} data-testid="4" />
</SelectDialog>,
);
cy.findByTestId('1').click();
cy.findByText('Selected Items 1').should('exist');
cy.findByTestId('1').click();
cy.findByText('Selected Items 1').should('not.exist');
cy.findByTestId('1').click();
cy.findByTestId('2').click();
cy.findByTestId('3').click();
cy.findByTestId('4').click();
cy.findByText('Selected Items 4').should('exist');
});
});
22 changes: 16 additions & 6 deletions packages/main/src/components/SelectDialog/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
'use client';

import type ListItemBase from '@ui5/webcomponents/dist/ListItemBase.js';
import ButtonDesign from '@ui5/webcomponents/dist/types/ButtonDesign.js';
import IconMode from '@ui5/webcomponents/dist/types/IconMode.js';
import InputType from '@ui5/webcomponents/dist/types/InputType.js';
import ListSelectionMode from '@ui5/webcomponents/dist/types/ListSelectionMode.js';
import TitleLevel from '@ui5/webcomponents/dist/types/TitleLevel.js';
import InvisibleMessageMode from '@ui5/webcomponents-base/dist/types/InvisibleMessageMode.js';
import announce from '@ui5/webcomponents-base/dist/util/InvisibleMessage.js';
import iconSearch from '@ui5/webcomponents-icons/dist/search.js';
import { enrichEventWithDetails, useI18nBundle, useStylesheet, useSyncRef } from '@ui5/webcomponents-react-base';
import { clsx } from 'clsx';
import type { ReactNode } from 'react';
import { forwardRef, useEffect, useState } from 'react';
import { CANCEL, CLEAR, SEARCH, SELECT, SELECTED } from '../../i18n/i18n-defaults.js';
// todo: remove comment once translations are available
// eslint-disable-next-line @typescript-eslint/no-unused-vars
import { CANCEL, CLEAR, SEARCH, SELECT, SELECTED, SELECTED_ITEMS } from '../../i18n/i18n-defaults.js';
import { Button, Dialog, FlexBox, FlexBoxAlignItems, Icon, Input, List, Text, Title } from '../../index.js';
import type { Ui5CustomEvent } from '../../types/index.js';
import type {
Expand Down Expand Up @@ -135,9 +140,8 @@ export interface SelectDialogPropTypes
/**
* This event will be fired when the dialog is confirmed by selecting an item in single selection mode or by pressing the confirmation button in multi selection mode.
*/
onConfirm?:
| ((event: Ui5CustomEvent<ListDomRef, { selectedItems: ListItemStandardDomRef[] }>) => void)
| ((event: Ui5CustomEvent<ButtonDomRef, { selectedItems: ListItemStandardDomRef[] }>) => void);
onConfirm?: (event: Ui5CustomEvent<ListDomRef | ButtonDomRef, { selectedItems: ListItemBase[] }>) => void;

/**
* This event will be fired when the cancel button is clicked or ESC key is pressed.
*/
Expand Down Expand Up @@ -232,12 +236,18 @@ const SelectDialog = forwardRef<DialogDomRef, SelectDialogPropTypes>((props, ref
setSearchValue('');
};

const handleSelectionChange = (e) => {
const handleSelectionChange: ListPropTypes['onSelectionChange'] = (e) => {
const { selectedItems } = e.detail;
if (typeof listProps?.onSelectionChange === 'function') {
listProps.onSelectionChange(e);
}
if (selectionMode === ListSelectionMode.Multiple) {
setSelectedItems(e.detail.selectedItems);
setSelectedItems(selectedItems);
if (selectedItems.length) {
announce('Selected Items ' + selectedItems.length, InvisibleMessageMode.Polite);
//todo: uncomment this, once translations are available
// announce(i18nBundle.getText(SELECTED_ITEMS, selectedItems.length), InvisibleMessageMode.Polite);
}
} else {
if (typeof onConfirm === 'function') {
onConfirm(e);
Expand Down
2 changes: 2 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 @@ -378,5 +378,7 @@ HAS_DETAILS=Has Details
#XACT: Message Item counter label
COUNTER=Counter

#ACT: Screen reader announcement text for selection in the SelectDialog component when multi-selection mode is active. The placeholder represents a number.
SELECTED_ITEMS=Selected Items {0}


Loading