diff --git a/packages/pluggableWidgets/combobox-web/CHANGELOG.md b/packages/pluggableWidgets/combobox-web/CHANGELOG.md index 200adb3382..6504eb13ef 100644 --- a/packages/pluggableWidgets/combobox-web/CHANGELOG.md +++ b/packages/pluggableWidgets/combobox-web/CHANGELOG.md @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ## [Unreleased] +### Added + +- We added the "No options available" accessibility status message. Screen readers announce it when no options match and "No options text" is empty. + ### Changed - We hid the "Placeholder text" property when the combobox type is set to Boolean, since boolean attributes can never be empty and the placeholder has no effect. @@ -14,6 +18,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - We fixed an issue where pages with many combo boxes became slow to scroll. +- We improved the screen reader experience of the combobox. The arrow icon is no longer announced as an image, and an empty combobox no longer exposes an empty option to screen reader users. + +- We fixed an issue where a "No options text" made only of spaces showed an empty option that screen readers could still reach. + +- We fixed an issue where the clear and remove value buttons had no accessible name when their aria labels were empty. They now fall back to "Clear selection" and "Remove value". + ## [2.10.0] - 2026-09-21 ### Fixed diff --git a/packages/pluggableWidgets/combobox-web/e2e/ComboboxKeyboardNavigation.spec.js b/packages/pluggableWidgets/combobox-web/e2e/ComboboxKeyboardNavigation.spec.js index 44c5af2a7f..31d43b9c77 100644 --- a/packages/pluggableWidgets/combobox-web/e2e/ComboboxKeyboardNavigation.spec.js +++ b/packages/pluggableWidgets/combobox-web/e2e/ComboboxKeyboardNavigation.spec.js @@ -116,12 +116,12 @@ test.describe("combobox-web single selection keyboard navigation", () => { await expect(combobox.selectedText).toHaveText(caption); }); - test("shows the no options placeholder when the filter matches nothing", async () => { + test("renders no empty option when the filter matches nothing and no text is configured", async () => { await combobox.open(); await combobox.filter("zzz"); await expect(combobox.options).toHaveCount(0); - await expect(combobox.noOptionsPlaceholder).toHaveCount(1); + await expect(combobox.noOptionsPlaceholder).toHaveCount(0); await expect(combobox.input).toHaveAttribute("aria-expanded", "true"); await combobox.filter(""); diff --git a/packages/pluggableWidgets/combobox-web/e2e/ComboboxMenuFeatures.spec.js b/packages/pluggableWidgets/combobox-web/e2e/ComboboxMenuFeatures.spec.js index 7bb87a692c..81fc871383 100644 --- a/packages/pluggableWidgets/combobox-web/e2e/ComboboxMenuFeatures.spec.js +++ b/packages/pluggableWidgets/combobox-web/e2e/ComboboxMenuFeatures.spec.js @@ -58,7 +58,8 @@ test.describe("combobox-web menu features on the city overview", () => { // "land" occurs inside a caption but at the start of none. await combobox.filter("land"); await expect(combobox.options).toHaveCount(0); - await expect(combobox.noOptionsPlaceholder).toHaveCount(1); + // No "no options" text is configured, so no empty option is exposed. + await expect(combobox.noOptionsPlaceholder).toHaveCount(0); }); test("renders the configured custom content inside every option", async () => { diff --git a/packages/pluggableWidgets/combobox-web/src/Combobox.editorPreview.tsx b/packages/pluggableWidgets/combobox-web/src/Combobox.editorPreview.tsx index 289b9c1edc..31f2a0d54c 100644 --- a/packages/pluggableWidgets/combobox-web/src/Combobox.editorPreview.tsx +++ b/packages/pluggableWidgets/combobox-web/src/Combobox.editorPreview.tsx @@ -33,7 +33,7 @@ export const preview = (props: ComboboxPreviewProps): ReactElement => { a11ySelectedValue: props.a11ySelectedValue, a11yOptionsAvailable: props.a11yOptionsAvailable, a11yInstructions: props.a11yInstructions, - a11yNoOption: props.noOptionsText + a11yNoOption: props.noOptionsText || props.a11yNoOptions } }, menuFooterContent: props.showFooter ? ( diff --git a/packages/pluggableWidgets/combobox-web/src/Combobox.tsx b/packages/pluggableWidgets/combobox-web/src/Combobox.tsx index 10338a2e58..bafce1d9bd 100644 --- a/packages/pluggableWidgets/combobox-web/src/Combobox.tsx +++ b/packages/pluggableWidgets/combobox-web/src/Combobox.tsx @@ -6,11 +6,15 @@ import { MultiSelection } from "./components/MultiSelection/MultiSelection"; import { Placeholder } from "./components/Placeholder"; import { SingleSelection } from "./components/SingleSelection/SingleSelection"; import { SelectionBaseProps } from "./helpers/types"; +import { textOrFallback } from "./helpers/utils"; import { useActionEvents } from "./hooks/useActionEvents"; import { useGetSelector } from "./hooks/useGetSelector"; import "./ui/Combobox.scss"; +const DEFAULT_CLEAR_SELECTION_LABEL = "Clear selection"; +const DEFAULT_REMOVE_VALUE_LABEL = "Remove value"; + export default function Combobox(props: ComboboxContainerProps): ReactElement { const selector = useGetSelector(props); const actionEvents = useActionEvents({ @@ -28,15 +32,15 @@ export default function Combobox(props: ComboboxContainerProps): ReactElement { ariaLabel: props.ariaLabel?.value, a11yConfig: { ariaLabels: { - clearSelection: props.clearButtonAriaLabel?.value ?? "", - removeSelection: props.removeValueAriaLabel?.value ?? "", + clearSelection: textOrFallback(props.clearButtonAriaLabel?.value, DEFAULT_CLEAR_SELECTION_LABEL), + removeSelection: textOrFallback(props.removeValueAriaLabel?.value, DEFAULT_REMOVE_VALUE_LABEL), selectAll: props.selectAllButtonCaption?.value ?? "" }, a11yStatusMessage: { a11ySelectedValue: props.a11ySelectedValue?.value ?? "", a11yOptionsAvailable: props.a11yOptionsAvailable?.value ?? "", a11yInstructions: props.a11yInstructions?.value ?? "", - a11yNoOption: props.noOptionsText?.value ?? "" + a11yNoOption: textOrFallback(props.noOptionsText?.value, props.a11yNoOptions?.value ?? "") } }, menuFooterContent: props.showFooter ? props.menuFooterContent : undefined diff --git a/packages/pluggableWidgets/combobox-web/src/Combobox.xml b/packages/pluggableWidgets/combobox-web/src/Combobox.xml index 9f19b10211..9b492be44c 100644 --- a/packages/pluggableWidgets/combobox-web/src/Combobox.xml +++ b/packages/pluggableWidgets/combobox-web/src/Combobox.xml @@ -389,6 +389,14 @@ Aantal beschikbare opties: + + No options available + Announced when no options match and "No options text" is empty. + + No options available. + Geen opties beschikbaar. + + Instructions Instructions to be read after announcing the status. diff --git a/packages/pluggableWidgets/combobox-web/src/__tests__/MultiSelection.spec.tsx b/packages/pluggableWidgets/combobox-web/src/__tests__/MultiSelection.spec.tsx index ba32ecde94..4966645bcf 100644 --- a/packages/pluggableWidgets/combobox-web/src/__tests__/MultiSelection.spec.tsx +++ b/packages/pluggableWidgets/combobox-web/src/__tests__/MultiSelection.spec.tsx @@ -157,6 +157,29 @@ describe("Combo box (Association)", () => { fireEvent.click(clearButton); expect(defaultProps.attributeAssociation?.value).toEqual([]); }); + it("gives the clear and remove buttons a default name when their labels are empty", async () => { + defaultProps.attributeAssociation = new ReferenceSetValueBuilder().withValue([obj("111"), obj("222")]).build(); + defaultProps.selectedItemsStyle = "boxes"; + defaultProps.clearButtonAriaLabel = dynamic.available(""); + defaultProps.removeValueAriaLabel = dynamic.available(" "); + const component = render(); + + expect(await component.findByRole("button", { name: "Clear selection" })).toBeInTheDocument(); + expect(component.getAllByRole("button", { name: "Remove value" })).toHaveLength(2); + }); + it("announces the no-options status message when no options text is empty", async () => { + defaultProps.selectAllButton = false; + defaultProps.optionsSourceAssociationDataSource = list([]); + defaultProps.noOptionsText = dynamic.available(""); + defaultProps.a11yNoOptions = dynamic.available("No options available."); + const component = render(); + fireEvent.click(await getInput(component)); + + expect(component.queryAllByRole("option")).toHaveLength(0); + await waitFor(() => { + expect(document.getElementById("a11y-status-message")).toHaveTextContent("No options available."); + }); + }); it("selects all items with the Select All button", async () => { const component = render(); const input = await getInput(component); diff --git a/packages/pluggableWidgets/combobox-web/src/__tests__/__snapshots__/MultiSelection.spec.tsx.snap b/packages/pluggableWidgets/combobox-web/src/__tests__/__snapshots__/MultiSelection.spec.tsx.snap index 041e9a3745..7f331c9155 100644 --- a/packages/pluggableWidgets/combobox-web/src/__tests__/__snapshots__/MultiSelection.spec.tsx.snap +++ b/packages/pluggableWidgets/combobox-web/src/__tests__/__snapshots__/MultiSelection.spec.tsx.snap @@ -40,7 +40,9 @@ exports[`Combo box (Association) renders combobox widget 1`] = ` class="widget-combobox-icon-container" > - + diff --git a/packages/pluggableWidgets/combobox-web/src/components/Placeholder.tsx b/packages/pluggableWidgets/combobox-web/src/components/Placeholder.tsx index d001481741..2111112b8e 100644 --- a/packages/pluggableWidgets/combobox-web/src/components/Placeholder.tsx +++ b/packages/pluggableWidgets/combobox-web/src/components/Placeholder.tsx @@ -12,7 +12,12 @@ export function Placeholder(): ReactElement { ); } -export function NoOptionsPlaceholder(props: PropsWithChildren): ReactElement { +export function NoOptionsPlaceholder(props: { children?: string }): ReactElement | null { + // Blank text would still be reachable as an empty option by screen readers. + if (!props.children?.trim()) { + return null; + } + return (
  • {props.children} diff --git a/packages/pluggableWidgets/combobox-web/src/components/__tests__/ComboboxMenuWrapperEmptyState.spec.tsx b/packages/pluggableWidgets/combobox-web/src/components/__tests__/ComboboxMenuWrapperEmptyState.spec.tsx new file mode 100644 index 0000000000..dd8382340e --- /dev/null +++ b/packages/pluggableWidgets/combobox-web/src/components/__tests__/ComboboxMenuWrapperEmptyState.spec.tsx @@ -0,0 +1,32 @@ +import "@testing-library/jest-dom"; +import { render } from "@testing-library/react"; +import { ComboboxMenuWrapper } from "../ComboboxMenuWrapper"; + +const baseProps = { + isEmpty: true, + isLoading: false, + isOpen: true, + lazyLoading: false, + loader: null, + getMenuProps: (options?: any) => ({ ...options }) +}; + +describe("ComboboxMenuWrapper empty state", () => { + it("does not expose an empty option when there is no no-options text", () => { + const { container } = render(); + + expect(container.querySelector('[role="option"]')).toBeNull(); + }); + + it("does not expose an empty option when the no-options text is only whitespace", () => { + const { container } = render(); + + expect(container.querySelector('[role="option"]')).toBeNull(); + }); + + it("exposes the no-options text as an option when it is set", () => { + const { getByRole } = render(); + + expect(getByRole("option")).toHaveTextContent("No options"); + }); +}); diff --git a/packages/pluggableWidgets/combobox-web/src/helpers/utils.ts b/packages/pluggableWidgets/combobox-web/src/helpers/utils.ts index 723d193da7..04ecb44d5e 100644 --- a/packages/pluggableWidgets/combobox-web/src/helpers/utils.ts +++ b/packages/pluggableWidgets/combobox-web/src/helpers/utils.ts @@ -7,6 +7,10 @@ import { MultiSelector, SortOrder } from "./types"; export const DEFAULT_LIMIT_SIZE = 100; +export function textOrFallback(text: string | undefined, fallback: string): string { + return text?.trim() ? text : fallback; +} + type ValueType = string | Big | boolean | Date | undefined; export function getSelectedCaptionsPlaceholder(selector: MultiSelector, selectedItems: string[]): string { diff --git a/packages/pluggableWidgets/combobox-web/typings/ComboboxProps.d.ts b/packages/pluggableWidgets/combobox-web/typings/ComboboxProps.d.ts index 7ef36d070f..80df987032 100644 --- a/packages/pluggableWidgets/combobox-web/typings/ComboboxProps.d.ts +++ b/packages/pluggableWidgets/combobox-web/typings/ComboboxProps.d.ts @@ -111,6 +111,7 @@ export interface ComboboxContainerProps { removeValueAriaLabel?: DynamicValue; a11ySelectedValue?: DynamicValue; a11yOptionsAvailable?: DynamicValue; + a11yNoOptions?: DynamicValue; a11yInstructions?: DynamicValue; lazyLoading: boolean; loadingType: LoadingTypeEnum; @@ -175,6 +176,7 @@ export interface ComboboxPreviewProps { removeValueAriaLabel: string; a11ySelectedValue: string; a11yOptionsAvailable: string; + a11yNoOptions: string; a11yInstructions: string; lazyLoading: boolean; loadingType: LoadingTypeEnum;