Skip to content

feat(dom): announce results updates with a live region #1329

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

Draft
dhayab wants to merge 1 commit into
base: next
Choose a base branch
from
Draft

feat(dom): announce results updates with a live region #1329

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
7 changes: 6 additions & 1 deletion packages/autocomplete-js/src/createAutocompleteDom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,10 @@ export function createAutocompleteDom<TItem extends BaseItem>({
isDetached,
});

const inputLiveRegion = createDomElement('div', {
ariaLive: 'assertive',
Copy link
Contributor

@Haroenv Haroenv Dec 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in UK gov, this is "polite"

hidden: true,
});
const inputWrapperPrefix = createDomElement('div', {
class: classNames.inputWrapperPrefix,
children: [label, loadingIndicator],
Expand All @@ -118,7 +122,7 @@ export function createAutocompleteDom<TItem extends BaseItem>({
});
const inputWrapper = createDomElement('div', {
class: classNames.inputWrapper,
children: [input],
children: [input, inputLiveRegion],
});

const formProps = propGetters.getFormProps({
Expand Down Expand Up @@ -207,6 +211,7 @@ export function createAutocompleteDom<TItem extends BaseItem>({
detachedOverlay,
detachedSearchButtonQuery,
detachedSearchButtonPlaceholder,
inputLiveRegion,
inputWrapper,
input,
root,
Expand Down
6 changes: 6 additions & 0 deletions packages/autocomplete-js/src/render.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,12 @@ export function renderSearchBox<TItem extends BaseItem>({
setProperties(dom.detachedSearchButtonPlaceholder, {
hidden: Boolean(state.query),
});

// FIXME: Should leverage `translations`
dom.inputLiveRegion.innerText = ((count) =>
count > 0 ? `${count} results available` : 'No results available')(
state.collections.reduce((count, { items }) => count + items.length, 0)
);
}

// Safari will animate the SVG even when it's hidden. We need to pause the
Expand Down
1 change: 1 addition & 0 deletions packages/autocomplete-js/src/types/AutocompleteDom.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
export type AutocompleteDom = {
inputLiveRegion: HTMLDivElement;
inputWrapper: HTMLDivElement;
input: HTMLInputElement;
root: HTMLDivElement;
Expand Down