Add status announcement after file change #5729
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-5729
romaricpascal
commented
Feb 20, 2025
| @@ -283,7 +284,6 @@ export class FileUpload extends ConfigurableComponent { | |||
| // Use a `CustomEvent` so our events are distinguishable from browser's native events | |||
| this.$input.dispatchEvent(new CustomEvent('change')) | |||
|
|
|||
| this.$announcements.innerText = this.$status.innerText | |||
There was a problem hiding this comment.
As the status is a live region, we no longer need to explicitely announce status after dropping.
📋 StatsFile sizes
Modules
View stats and visualisations on the review app Action run for 9fcde09 |
JavaScript changes to npm packagediff --git a/packages/govuk-frontend/dist/govuk/govuk-frontend.min.js b/packages/govuk-frontend/dist/govuk/govuk-frontend.min.js
index f6220464f..59ef37dd2 100644
--- a/packages/govuk-frontend/dist/govuk/govuk-frontend.min.js
+++ b/packages/govuk-frontend/dist/govuk/govuk-frontend.min.js
@@ -769,7 +769,7 @@ class FileUpload extends ConfigurableComponent {
const o = this.$input.getAttribute("aria-describedby");
o && s.setAttribute("aria-describedby", o);
const r = document.createElement("span");
- r.className = "govuk-body govuk-file-upload-button__status", r.innerText = this.i18n.t("noFileChosen"), s.appendChild(r);
+ r.className = "govuk-body govuk-file-upload-button__status", r.setAttribute("aria-live", "polite"), r.innerText = this.i18n.t("noFileChosen"), s.appendChild(r);
const a = document.createElement("span");
a.className = "govuk-visually-hidden", a.innerText = ", ", a.id = `${this.id}-comma`, s.appendChild(a);
const l = document.createElement("span");
@@ -795,7 +795,7 @@ class FileUpload extends ConfigurableComponent {
this.$button.classList.remove("govuk-file-upload-button--dragging")
}
onDrop(t) {
- t.preventDefault(), t.dataTransfer && isContainingFiles(t.dataTransfer) && (this.$input.files = t.dataTransfer.files, this.$input.dispatchEvent(new CustomEvent("change")), this.$announcements.innerText = this.$status.innerText, this.hideDraggingState())
+ t.preventDefault(), t.dataTransfer && isContainingFiles(t.dataTransfer) && (this.$input.files = t.dataTransfer.files, this.$input.dispatchEvent(new CustomEvent("change")), this.hideDraggingState())
}
onChange() {
const t = this.$input.files.length;
Action run for 9fcde09 |
Other changes to npm packagediff --git a/packages/govuk-frontend/dist/govuk/all.bundle.js b/packages/govuk-frontend/dist/govuk/all.bundle.js
index b57e1a9a6..fb3d69a27 100644
--- a/packages/govuk-frontend/dist/govuk/all.bundle.js
+++ b/packages/govuk-frontend/dist/govuk/all.bundle.js
@@ -1713,6 +1713,7 @@
}
const $status = document.createElement('span');
$status.className = 'govuk-body govuk-file-upload-button__status';
+ $status.setAttribute('aria-live', 'polite');
$status.innerText = this.i18n.t('noFileChosen');
$button.appendChild($status);
const commaSpan = document.createElement('span');
@@ -1804,7 +1805,6 @@
if (event.dataTransfer && isContainingFiles(event.dataTransfer)) {
this.$input.files = event.dataTransfer.files;
this.$input.dispatchEvent(new CustomEvent('change'));
- this.$announcements.innerText = this.$status.innerText;
this.hideDraggingState();
}
}
diff --git a/packages/govuk-frontend/dist/govuk/all.bundle.mjs b/packages/govuk-frontend/dist/govuk/all.bundle.mjs
index bd59d9bb4..2562e1c2b 100644
--- a/packages/govuk-frontend/dist/govuk/all.bundle.mjs
+++ b/packages/govuk-frontend/dist/govuk/all.bundle.mjs
@@ -1707,6 +1707,7 @@ class FileUpload extends ConfigurableComponent {
}
const $status = document.createElement('span');
$status.className = 'govuk-body govuk-file-upload-button__status';
+ $status.setAttribute('aria-live', 'polite');
$status.innerText = this.i18n.t('noFileChosen');
$button.appendChild($status);
const commaSpan = document.createElement('span');
@@ -1798,7 +1799,6 @@ class FileUpload extends ConfigurableComponent {
if (event.dataTransfer && isContainingFiles(event.dataTransfer)) {
this.$input.files = event.dataTransfer.files;
this.$input.dispatchEvent(new CustomEvent('change'));
- this.$announcements.innerText = this.$status.innerText;
this.hideDraggingState();
}
}
diff --git a/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.js b/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.js
index 6c37a8243..6e9b129eb 100644
--- a/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.js
+++ b/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.js
@@ -540,6 +540,7 @@
}
const $status = document.createElement('span');
$status.className = 'govuk-body govuk-file-upload-button__status';
+ $status.setAttribute('aria-live', 'polite');
$status.innerText = this.i18n.t('noFileChosen');
$button.appendChild($status);
const commaSpan = document.createElement('span');
@@ -631,7 +632,6 @@
if (event.dataTransfer && isContainingFiles(event.dataTransfer)) {
this.$input.files = event.dataTransfer.files;
this.$input.dispatchEvent(new CustomEvent('change'));
- this.$announcements.innerText = this.$status.innerText;
this.hideDraggingState();
}
}
diff --git a/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.mjs b/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.mjs
index 307cbbd67..09263d181 100644
--- a/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.mjs
+++ b/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.bundle.mjs
@@ -534,6 +534,7 @@ class FileUpload extends ConfigurableComponent {
}
const $status = document.createElement('span');
$status.className = 'govuk-body govuk-file-upload-button__status';
+ $status.setAttribute('aria-live', 'polite');
$status.innerText = this.i18n.t('noFileChosen');
$button.appendChild($status);
const commaSpan = document.createElement('span');
@@ -625,7 +626,6 @@ class FileUpload extends ConfigurableComponent {
if (event.dataTransfer && isContainingFiles(event.dataTransfer)) {
this.$input.files = event.dataTransfer.files;
this.$input.dispatchEvent(new CustomEvent('change'));
- this.$announcements.innerText = this.$status.innerText;
this.hideDraggingState();
}
}
diff --git a/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.mjs b/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.mjs
index 482b1798c..614cd849a 100644
--- a/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.mjs
+++ b/packages/govuk-frontend/dist/govuk/components/file-upload/file-upload.mjs
@@ -55,6 +55,7 @@ class FileUpload extends ConfigurableComponent {
}
const $status = document.createElement('span');
$status.className = 'govuk-body govuk-file-upload-button__status';
+ $status.setAttribute('aria-live', 'polite');
$status.innerText = this.i18n.t('noFileChosen');
$button.appendChild($status);
const commaSpan = document.createElement('span');
@@ -146,7 +147,6 @@ class FileUpload extends ConfigurableComponent {
if (event.dataTransfer && isContainingFiles(event.dataTransfer)) {
this.$input.files = event.dataTransfer.files;
this.$input.dispatchEvent(new CustomEvent('change'));
- this.$announcements.innerText = this.$status.innerText;
this.hideDraggingState();
}
}
Action run for 9fcde09 |
Adds an automatic announcement of the status after users pick a file. This should reassure JAWS users that their selection has been taken into account, as JAWS announces the accessible name of the button before the file picker was open, sometimes without re-announcing afterwards the accessible name once a file is picked.
romaricpascal
force-pushed
the
spike-announce-status-after-change
branch
from
d3f6fc5 to
9fcde09
Compare
govuk-design-system-ci
temporarily deployed
to
govuk-frontend-pr-5729
romaricpascal
changed the title
romaricpascal
commented
Feb 21, 2025
| // rather than being in the initial state | ||
| await expect( | ||
| $announcements.evaluate((e) => e.textContent) | ||
| ).resolves.toBe('file-upload.puppeteer.test.js') | ||
| ).resolves.toBe('Entered drop zone') |
There was a problem hiding this comment.
note This test changes slightly as we no longer announce the file name in the announcements element, but via the status itself. We can still check that we're no longer in the initial state as the announcements will remain 'Entered drop zone' after the drop.
This also serves as a check that we don't double up the file name announcement with another announcement using the announcements element.
romaricpascal
commented
Feb 21, 2025
| expect(announcementsText).toBe('') | ||
| // As the announcement is feedback while user is dragging, | ||
| // best to announce it as soon as the user enters the zone | ||
| expect(announcementsAriaLive).toBe('assertive') |
There was a problem hiding this comment.
*note That bit is important for the feedback while dragging, so took the opportunity to check this while looking at other tests for aria-live attributes.
1 task
patrickpatrickpatrick
approved these changes
Feb 21, 2025
1 task
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds an automatic announcement of the status after users pick a file.
This should reassure JAWS users that their selection has been taken into account, as JAWS announces the accessible name of the button before the file picker was open, sometimes without re-announcing afterwards the accessible name once a file is picked.
Testing confirmed it to be a better option than manipulating which element is focused (see #5726)