diff options
| author | David Smith <smithdc@gmail.com> | 2024-12-13 08:20:27 +0000 |
|---|---|---|
| committer | Sarah Boyce <42296566+sarahboyce@users.noreply.github.com> | 2024-12-17 12:04:44 +0100 |
| commit | 1e05431881d64e5e009cd9a709225744c05a48f1 (patch) | |
| tree | e27c5e21a7f3198b3b47572a7ba6a92d47e2edc9 /docs/ref/forms | |
| parent | 27375ad50ea3306844aab8122de13e9b3e0d1189 (diff) | |
Refs #32819 -- Added aria-describedby property to BoundField.
Diffstat (limited to 'docs/ref/forms')
| -rw-r--r-- | docs/ref/forms/api.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt index 4875a1ab72..494f3f244e 100644 --- a/docs/ref/forms/api.txt +++ b/docs/ref/forms/api.txt @@ -1161,6 +1161,15 @@ The field-specific output honors the form object's ``auto_id`` setting: Attributes of ``BoundField`` ---------------------------- +.. attribute:: BoundField.aria_describedby + + .. versionadded:: 5.2 + + Returns an ``aria-describedby`` reference to associate a field with its + help text. Returns ``None`` if ``aria-describedby`` is set in + :attr:`Widget.attrs` to preserve the user defined attribute when rendering + the form. + .. attribute:: BoundField.auto_id The HTML ID attribute for this ``BoundField``. Returns an empty string |