diff options
| author | Matthias Kestenholz <mk@feinheit.ch> | 2025-01-15 21:04:26 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-01-15 17:04:26 -0300 |
| commit | 6a7ee02f5994c65bbefe92a3da74f22326970cf9 (patch) | |
| tree | d49780a99dbb0ad8b85522b55dcaf54fafde0264 /docs/ref/forms/fields.txt | |
| parent | 0cabed9efa2c7abd1693860069f20ec5db41fcd8 (diff) | |
Fixed #35521 -- Allowed overriding BoundField class on fields, forms and renderers.
Thank you Sarah Boyce, Carlton Gibson, Tim Schilling and Adam Johnson
for reviews.
Co-authored-by: Christophe Henry <contact@c-henry.fr>
Co-authored-by: David Smith <smithdc@gmail.com>
Co-authored-by: Natalia <124304+nessita@users.noreply.github.com>
Co-authored-by: Matthias Kestenholz <mk@feinheit.ch>
Diffstat (limited to 'docs/ref/forms/fields.txt')
| -rw-r--r-- | docs/ref/forms/fields.txt | 22 |
1 files changed, 21 insertions, 1 deletions
diff --git a/docs/ref/forms/fields.txt b/docs/ref/forms/fields.txt index c0ab4f2434..7ae5c121eb 100644 --- a/docs/ref/forms/fields.txt +++ b/docs/ref/forms/fields.txt @@ -397,6 +397,16 @@ default this value is set to ``"django/forms/field.html"``. Can be changed per field by overriding this attribute or more generally by overriding the default template, see also :ref:`overriding-built-in-field-templates`. +``bound_field_class`` +--------------------- + +.. attribute:: Field.bound_field_class + +.. versionadded:: 5.2 + +The ``bound_field_class`` attribute allows a per-field override of +:attr:`.Form.bound_field_class`. + Checking if the field data has changed ====================================== @@ -1635,4 +1645,14 @@ only requirements are that it implement a ``clean()`` method and that its ``label``, ``initial``, ``widget``, ``help_text``). You can also customize how a field will be accessed by overriding -:meth:`~django.forms.Field.get_bound_field()`. +:attr:`~django.forms.Field.bound_field_class` or override +:meth:`.Field.get_bound_field()` if you need more flexibility when creating +the ``BoundField``: + +.. method:: Field.get_bound_field(form, field_name) + + Takes an instance of :class:`~django.forms.Form` and the name of the field. + The returned :class:`.BoundField` instance will be used when accessing the + field in a template. + +See :ref:`custom-boundfield` for examples of overriding a ``BoundField``. |
