Skip to content

FORMS-18634: Desktop, RWD Tablet, RWD Mobile - Form field with error not identified @sunnym @vavarshn #1585

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
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

FORMS-18634: Desktop, RWD Tablet, RWD Mobile - Form field with error not identified @sunnym @vavarshn #1585

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f68d8f
FORMS-18634: Desktop, RWD Tablet, RWD Mobile - Form field with error …
May 5, 2025
2dfe8b8
FORMS-18634: Responding to feedback
May 6, 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
10 changes: 8 additions & 2 deletions ui.frontend/src/view/FormFieldBase.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ class FormFieldBase extends FormField {
#syncLabel() {
let labelElement = typeof this.getLabel === 'function' ? this.getLabel() : null;
if (labelElement) {
labelElement.setAttribute('id', `${this.getId()}__label`);
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove this id

labelElement.setAttribute('for', this.getWidgetId());
}
}
Expand All @@ -176,6 +177,7 @@ class FormFieldBase extends FormField {
let errorElement = typeof this.getErrorDiv === 'function' ? this.getErrorDiv() : null;
if (errorElement) {
errorElement.setAttribute('id', `${this.getId()}__errormessage`);
errorElement.setAttribute('aria-describedby', `${this.getId()}__label`);
Copy link
Contributor

Choose a reason for hiding this comment

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

It is already present in the input field. We can not use the aria-describedby attribute on the error container.

}
}

Expand Down Expand Up @@ -249,7 +251,7 @@ class FormFieldBase extends FormField {
this.#syncLabel()
this.#syncWidget()
this.#syncShortDesc()
this. #syncLongDesc()
this.#syncLongDesc()
this.#syncAriaDescribedBy()
this.#syncError()
this.#syncAriaLabel()
Expand Down Expand Up @@ -538,6 +540,8 @@ class FormFieldBase extends FormField {
// Check if the validationMessage is different from the current content
if (this.errorDiv.innerHTML !== state.validationMessage) {
this.errorDiv.innerHTML = state.validationMessage;
this.errorDiv.removeAttribute('tabindex');
this.errorDiv.removeAttribute('role');
if (state.validity.valid === false) {
// Find the first key whose value is true
const validationType = Object.keys(state.validity).find(key => key !== 'valid' && state.validity[key] === true);
Expand All @@ -550,7 +554,9 @@ class FormFieldBase extends FormField {
if (!state.validationMessage) {
this.errorDiv.innerHTML = LanguageUtils.getTranslatedString(this.formContainer.getModel().lang, "defaultError");
}
}
this.errorDiv.setAttribute('tabindex', 0);
this.errorDiv.setAttribute('role', 'complementary');
Copy link
Contributor

Choose a reason for hiding this comment

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

It is usually incorrect to use role="complementary" on an error container.
Use role="alert" or aria-live="assertive" for error messages, as this is the best practice(Optional)

}
this.#syncAriaDescribedBy();
}
}
Expand Down