Refs #32819 -- Added id to ErrorList class and template. #18871
Merged
+91
−59
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
force-pushed
the
ticket_32819_errorlist_id
branch
from
af927c7 to
ecc0259
Compare
sarahboyce
reviewed
Dec 2, 2024
| @@ -1043,6 +1043,13 @@ Customizing the error list format | |||
| Defaults to ``None`` which means to use the default renderer | |||
| specified by the :setting:`FORM_RENDERER` setting. | |||
|
|
|||
| .. attribute:: field_id | |||
There was a problem hiding this comment.
Do you think it's worth mentioning that this defaults to the auto_id for field errors and no id is associated to non-field errors?
There was a problem hiding this comment.
I made some changes here, could you have another look? I'm not sure if we need to go further and mention non-field errors.
There was a problem hiding this comment.
This looks great thank you!
smithdc1
force-pushed
the
ticket_32819_errorlist_id
branch
2 times, most recently
from
4d2c195 to
a986c89
Compare
sarahboyce
reviewed
Dec 4, 2024
docs/ref/forms/api.txt
Outdated
| @@ -1416,7 +1430,7 @@ Methods of ``BoundField`` | |||
|
|
|||
| .. method:: BoundField.render(template_name=None, context=None, renderer=None) | |||
|
|
|||
| The render method is called by ``as_field_group``. All arguments are | |||
| The render method is called by ``as_field_group``. All arguments are | |||
There was a problem hiding this comment.
This disappears when rebasing main 👍
docs/releases/5.2.txt
Outdated
Comment on lines
233
to
234
| * :class:`~django.forms.ErrorList` now accepts a ``field_id`` argument and an | ||
| ``id`` HTML element is added to the default ``ErrorList`` template. |
There was a problem hiding this comment.
Suggested change
| * :class:`~django.forms.ErrorList` now accepts a ``field_id`` argument and an | |
| ``id`` HTML element is added to the default ``ErrorList`` template. | |
| * The new ``field_id`` argument for :class:`~django.forms.ErrorList` allows an | |
| HTML ``id`` attribute to be added in the error template. The default template | |
| uses the format ``id="{{ field_id }}_error"`` where ``field_id`` is the | |
| field's :attr:`~.BoundField.auto_id`. |
Possibly? Or
* The new ``field_id`` argument for :class:`~django.forms.ErrorList` allows an
HTML ``id`` attribute to be added in the error template. See
:attr:`.ErrorList.field_id` for details.
There was a problem hiding this comment.
I like your second suggestion.
smithdc1
force-pushed
the
ticket_32819_errorlist_id
branch
2 times, most recently
from
30df69b to
7126d66
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.
Trac ticket number
ticket-32819
Branch description
Step 1 of ticket 32819 is to add an id to the error list template so the
aria-describedbyhas something to point to. See #17520Checklist
mainbranch.