Refs #32819 -- Used auto_id instead of id_for_label as unique identifier for the field. #17480
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
smithdc1
commented
Nov 15, 2023
docs/ref/forms/fields.txt
Outdated
| @@ -395,7 +395,7 @@ be ignored in favor of the value from the form's initial data. | |||
| .. versionadded:: 5.0 | |||
|
|
|||
| The ``template_name`` argument allows a custom template to be used when the | |||
| field is rendered with :meth:`~django.forms.BoundField.as_field_group`. By | |||
| field is rendered with :meth:`~django.forms.BoundField.as_field_group`. By | |||
There was a problem hiding this comment.
I don't know how to commit a change to this file without adding this whitespace change.
felixxm
reviewed
Nov 16, 2023
| ): | ||
| attrs["aria-describedby"] = f"{self.id_for_label}_helptext" | ||
| attrs["aria-describedby"] = f"{self.auto_id}_helptext" |
There was a problem hiding this comment.
This was added in 966ecdd (Django 5.0). I'd recommend backporting this change to the Django 5.0 to avoid changes in Django 5.1 in recently added functionality.
There was a problem hiding this comment.
Sounds reasonable.
I was wondering if you may have triaged the other pr as a release blocker. I think it's not as we we've only recently agreed on a way forward for fields with related <inputs>.
felixxm
force-pushed
the
aria-describedby-autoid
branch
from
4da6fc1
to
00b8ba3
Compare
…ier for the field. `id_for_label` is blank for widgets with multiple inputs such as radios and multiple checkboxes. Therefore , `help_text` for fields using these widgets cannot currently be associated using `aria-describedby`. `id_for_label` is being used as a guard to avoid incorrectly adding `aria-describedby` to those widgets. This change uses `auto_id` as the unique identified for the fields `help_text`. A guard is added to avoid incorrectly adding `aria-describedby` to inputs by checking the widget's `use_fieldset` attribute. Fields rendered in a `<fieldset>` should have `aria-describedby` added to the `<fieldset>` and not every `<input>`.
felixxm
force-pushed
the
aria-describedby-autoid
branch
from
00b8ba3
to
292f1ea
Compare
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.
id_for_labelis blank for widgets with multiple inputs such as radios and multiple checkboxes. Therefore ,help_textfor fields using these widgets can not currently be associated usingaria-describedby.id_for_labelis being used as a guard to avoid incorrectly addingaria-describedbyto those widgets.This change uses
auto_idas the unique identified for the fieldshelp_text. A guard is added to avoid incorrectly addingaria-describedbyto inputs by checking the widget'suse_fieldsetattribute. Fields rendered in a<fieldset>should havearia-describedbyadded to the<fieldset>and not every<input>.