Form field aria-describedby fixes #30015
Merged
Conversation
This file contains hidden or 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
Currently we set the `aria-describedby` every time the state of the form control changes. This is excessive, because it only needs to happen if the error state or `userAriaDescribedBy` change.
Currently there are two sources of an `aria-describedby` for a `matInput`: the IDs of the hint/error message in the form field and any custom ones set through `aria-describedby`. This is insufficient, because the ID can also come from a direct DOM manupulation like in the `AriaDescriber`. These changes tweak the logic to try and preserve them, because currently they get overwritten. Fixes angular#30011.
crisbeto
requested review from
andrewseguin and
mmalerba
and removed request for
a team
crisbeto
commented
Nov 14, 2024
|
|
||
| // Updating the `aria-describedby` touches the DOM. Only do it if it actually needs to change. | ||
| this._describedByChanges?.unsubscribe(); | ||
| this._describedByChanges = control.stateChanges |
There was a problem hiding this comment.
I tried basing this on top of signals, but the timing was off because I had to run _syncDescribedByIds in an effect.
There was a problem hiding this comment.
Ideally we'll do a bigger refactor at some point and replace syncDescribedByIds with a signal, describedByIds
There was a problem hiding this comment.
Yep, I'd argue pretty much all the properties in the FormFieldControl should be signals.
mmalerba
approved these changes
Nov 14, 2024
crisbeto
added
action: merge
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
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.
Includes the following fixes for how we deal with
ariab-describedbyin the form field:fix(material/form-field): avoid touching the DOM on each state change
Currently we set the
aria-describedbyevery time the state of the form control changes. This is excessive, because it only needs to happen if the error state oruserAriaDescribedBychange.fix(material/input): preserve aria-describedby set externally
Currently there are two sources of an
aria-describedbyfor amatInput: the IDs of the hint/error message in the form field and any custom ones set througharia-describedby. This is insufficient, because the ID can also come from a direct DOM manipulation like in theAriaDescriber.These changes tweak the logic to try and preserve them, because currently they get overwritten.
Fixes #30011.