• Added support for Python 3.13.
• Confirmed support for Django 5.2.

What's Changed

• Fixed unexpected addition the 'active' css_class to AccordionGroup

• Added support for Django 5.1.
• Allowed pass through of context when rendering a Fieldset layout object.

Full Changelog: 2.1...2.2

What's Changed

• Added support for Django 5.0.
• Dropped support for Django 3.2, 4.0 and 4.1.
• Added support for Python 3.12.
• Dropped support for Python 3.7.

New Contributors

• @DanielSwain made their first contribution in #1340
• @sankarebarri made their first contribution in #1342
• @foarsitter made their first contribution in #1353

Full Changelog: 2.0...2.1

2.0 (2023-02-13)

Major Changes and Migration Guide

• Removed all Bootstrap template packs. These template packs are now available as standalone packages.
  To upgrade, install the required template pack and add it to your
  INSTALLED_APPS setting.

  • Boostrap 2: PyPI -- GitHub
  • Boostrap 3: PyPI -- GitHub
  • Boostrap 4: PyPI -- GitHub

  Also, support for Bootstrap 5 is provided by a 3rd party package under the django-crispy-forms organisation at
  crispy-bootstrap5.

• Removed uni-form template pack. Uni-Form specific classes previously added to every template pack e.g. textInput are now removed.
  If you require these classes, the previous behaviour can be restored by adding the following to CRISPY_CLASS_CONVERTERS in your settings file.

    converters = {
      "textinput": "textinput textInput",
      "fileinput": "fileinput fileUpload",
      "passwordinput": "textinput textInput",
  }
  

• The uni-form template pack allowed for rendering of templates using a default or inline layout. As the uni-form template
  pack has been removed support for this has also been removed. This has resulted in the following BREAKING changes.

  • The form_style attribute of FormHelper is removed.
  • The form_style positional argument to render_field() is removed.
  • The form_style positional argument to the render() method of all LayoutObjects is removed.

  Audit for use of render() and render_field() due to the removal of the form_style positional argument is therefore
  required. For example:

  # django-crispy-forms 1.x
  html = my_layout_object.render(form, form_style, context)
  # django-crispy-forms 2.x
  html = my_layout_object.render(form, context)
  

• Widespread use of the |safe in crispy-form templates is removed. Audit for html input in your forms
  especially for Field and Prepended/Appended text. To retain the previous behaviour mark text as safe
  in your project code using
  mark_safe(). Refs #296.

Other Changes

• Dropped support for Django 2.2.
• Added support for Django 4.1 and 4.2.
• Added support for Python 3.11.
• The flat_attrs() method of FormActions is removed. Attributes provided by **kwargs are now passed via the flat_attrs function during __init__() instead of with each call of render()
• The html5_required attribute of FormHelper is removed. In all supported versions of Django the required attribute is provided by the core forms module.
• The FormActions layout object learnt a css_id kwarg to add an id to the rendered <div>
• The default values of "form_error_title" and "formset_error_title" of FormHelper changed from None to "".
• An attribute error is now raised if the CRISPY_TEMPLATE_PACK setting is not provided.
• The get_layout_objects() and get_field_names() functions of LayoutObject now return a list of Pointers rather than a list
  of lists. Pointers are a dataclass containing a list of posistions and the name of object/field.

2.0a1 (2023-01-18)

Major Changes and Migration Guide

• Removed all Bootstrap template packs. These template packs are now available as standalone packages.
  To upgrade, install the required template pack and add it to your
  INSTALLED_APPS setting.

  • Boostrap 2: PyPI -- GitHub
  • Boostrap 3: PyPI -- GitHub
  • Boostrap 4: PyPI -- GitHub

  Also, support for Bootstrap 5 is provided by a 3rd party package under the django-crispy-forms organisation at
  crispy-bootstrap5.

• Removed uni-form template pack. Uni-Form specific classes previously added to every template pack e.g. textInput are now removed.
  If you require these classes, the previous behaviour can be restored by adding the following to CRISPY_CLASS_CONVERTERS in your settings file.

    converters = {
      "textinput": "textinput textInput",
      "fileinput": "fileinput fileUpload",
      "passwordinput": "textinput textInput",
  }
  

• The uni-form template pack allowed for rendering of templates using a default or inline layout. As the uni-form template
  pack has been removed support for this has also been removed. This has resulted in the following BREAKING changes.

  • The form_style attribute of FormHelper is removed.
  • The form_style positional argument to render_field() is removed.
  • The form_style positional argument to the render() method of all LayoutObjects is removed.

  Audit for use of render() and render_field() due to the removal of the form_style positional argument is therefore
  required. For example:

  # django-crispy-forms 1.x
  html = my_layout_object.render(form, form_style, context)
  # django-crispy-forms 2.x
  html = my_layout_object.render(form, context)
  

• Widespread use of the |safe in crispy-form templates is removed. Audit for html input in your forms
  especially for Field and Prepended/Appended text. To retain the previous behaviour mark text as safe
  in your project code using
  mark_safe(). Refs #296.

Other Changes

• Dropped support for Django 2.2.
• Added support for Django 4.1 and 4.2.
• Added support for Python 3.11.
• The flat_attrs() method of FormActions is removed. Attributes provided by **kwargs are now passed via the flat_attrs function during __init__() instead of with each call of render()
• The html5_required attribute of FormHelper is removed. In all supported versions of Django the required attribute is provided by the core forms module.
• The FormActions layout object learnt a css_id kwarg to add an id to the rendered <div>
• The default values of "form_error_title" and "formset_error_title" of FormHelper changed from None to "".
• An attribute error is now raised if the CRISPY_TEMPLATE_PACK setting is not provided.
• The get_layout_objects() and get_field_names() functions of LayoutObject now return a list of Pointers rather than a list
  of lists. Pointers are a dataclass containing a list of posistions and the name of object/field.

What's Changed

• Updated meta license-file in setup.cfg by @smithdc1 in #1188
• Remove bs3 styles from crispy_forms_field by @smithdc1 in #1003
• Fix css id for non ascii characters by @smithdc1 in #1190
• Simplified adding wrapper_class to context when rendering PrependedApppendedText by @smithdc1 in #1191
• Added support for Python 3.10 by @smithdc1 in #1189
• Refs #938 -- Avoid attributes being duplicated by @smithdc1 in #1194
• Fix mismatched HTML tag by @wgordon17 in #1201
• Dropped support for Python 3.6 and Django 3.1. by @smithdc1 in #1205
• Fixed Bootstrap4 Field with buttons input size by @smithdc1 in #1159
• Removed empty class attribute if field class is None by @smithdc1 in #1208
• Create a bootstrap modal layout object by @nsandler1 in #1204

New Contributors

• @wgordon17 made their first contribution in #1201
• @nsandler1 made their first contribution in #1204

Full Changelog: 1.13.0...1.14.0

1.13.0 (2021-09-25)

• Added support for Django 4.0

• Fixed rendering of grouped checkboxes and radio inputs in the Bootstrap 4 template pack. (#1155)
• Introduced new input_size argument to AppendedText, PrependedText and PrependedAppendedText. This allows the size of these grouped inputs to be changed in the Bootstrap 4 template pack. (#1114)
• Confirmed support for Django 3.2
• Dropped support for Python 3.5
• Dropped support for Django 3.0

See the 1.12.0 Milestone for the full change list.

• Added HTML parsing tools to help testing of template packs (#1128)
• Fixed rendering of all widget attributes for file fields (#1130)

See the 1.11.2 Milestone for the full change list.

• Added custom-select for select widgets within prepended and appended fields (#1116)

See the 1.11.1 Milestone for the full change list.

• Implemeneted custom-select for Select widgets in the Bootstrap4 Template Pack (#1091)
• Fixed data-parent in AccodrianGroup (#1091)
• Documentation improvements

See the 1.11.0 Milestone for the full change list

1.10.0 (18.11.2020)

• Fixed test causing SystemCheckError in some cases. (#1075)
• Radio and Checkbox now respect the field's disabled attribute when using the Bootstrap4 template pack. (#1057)
• A number of documentation improvements.

See the 1.10.0 Milestone for the full change list

1.9.2 (2020-07-11)

• Fixed FileField UI bug

See the 1.9.2 Milestone for the full change list.

1.9.1 (2020-05-16)

• Added Bootstrap 4 styling for clearable file widget.
• Fixed FileField UI bug.
• Project now uses GitHub actions for testing.

See the 1.9.1 Milestone for the full change list.

• Removed support for Python 2.
• Removed support for Django versions prior to 2.2.
• CSS for Column layout object in Bootstrap 4 template pack changed to 'col-md'. Default is now over ridden when another 'col' class is added to css_class.

See the 1.9.0 Milestone for the full change list.

1.8.1 (2019-11-22)

• Fixing FileField UI bug introduced with 1.8.0
• Remove is-valid css class for radio (bug introduced with 1.8.0)
• Various alignment and margin fixes for Bootstrap 4 template pack
• Documentation : using read-the-docs template, documenting how to run test suite, documenting use_custom_control help attributes

1.8.0 (2019-10-17)

• Updated compatibility for Django 1.11, 2.1, 2.2 and 3.0 in line with Django's supported versions policy.

• Numerous improvements to the Bootstrap 4 template pack, which may now be considered mature.

  Here are some changes that might affect custom templating you already have in place when using Bootstrap 4 :

  • Using Custom Forms for radio and checkbox. You may disable this by setting FormHelper.use_custom_control = False.
  • Using Bootstrap 4 "form-row" class in place of "row".
  • Fixing layout hierarchy between input and its label for checkbox and radio.

  <small>Links are to the relevant Bootstap 4 docs.</small>

See the 1.8.0 Milestone for the full change list.

• Bugfixes following v1.7.1

See 1.7.1 Milestone for full issue list.

• Bootstrap 4 template pack.

See 1.7.1 Milestone for full issue list.

• Fixes compatibility with Django 2.0
• Various other fixes.

See 1.7 Milestone for full issue list.

• Updates compatibility for Django 1.10
• A number of small Bootstrap 4 fixes.

See 1.6.1 Milestone for full issue list.

Adds Bootstrap 4 template pack. Improves compatibility with Django 1.9. Other small fixes.

Full changes: https://github.com/maraujop/django-crispy-forms/compare/1.5.2...1.6.0

Recommended.

Fixes a couple of bugs including a KeyError: u'wrapper_class' when using multiple crispy forms on a page.

Recommended.

Massive overhaul of the test suite and a quick bug fix. Recommended.

The highlights here are compatibility with Python 3 and all currently supported versions of Django (1.4, 1.7, 1.8). We've also extended the CI coverage to all supported Python/Django combinations and are running against Django master to pick up future problems early.

Special thanks in this release to James Friedman <a href="https://github.com/jamesmfriedman">@jamesmfriedman</a>, for his amazing support in PR #213, adding initial Bootstrap 3 support.

• Bootstrap 3 inline forms support and docs for inline forms with Bootstrap 3, see #233.
• update_attributes can now work with a field name, see docs.
• Adjusted unicode checkings for Python 3, see #231.
• Adjusted how bootstrap Tab layout object attributes are applied to make sense, see #228.
• Major refactor of testing suite architecture, breaking huge tests.py file into several and also splitting tests for different template packs into different tests cases, runners for template packs updated.
• Added support for horizontal forms in bootstrap3, see #209.
• Fixed spaces missing when rendering several submit inputs continued, see #211.
• Fixed checkboxes and radios for Bootstrap3, adjusted multiple inline radios and checkboxes, see #225.
• Update accordion markup for bootstrap3 compatibility, see #229.
• Moved UneditableField to bootstrap module, place where it should live, no backwards compatible import left behind.
• Added bootstrap3 template pack thanks to James Friedman, see #213 and #209.
• RadioSelect and CheckboxSelectMultiple widget values and texts were being localized, when they shouldn't bee, see #214.
• If Django widget attrs where set for RadioSelect or CheckboxSelectMultiple they were not being rendered by crispy-forms, see #206.
• form_show_labels wasn't working correctly with some layout objects, see #193.

• Labels were not being rendered with |crispy filter, see #202.

• Fix default value for form_show_labels in case FormHelper doesn't define it, see #199.
• Added a backported version of override_settings for testing django 1.3.7 and adding it to Travis-ci matrix.

Special thanks in this release to Charlie Denton <a href="https://github.com/meshy">@meshy</a>, for his amazing support in PRs #189 and #190, long due.

• Deprecated Tab and TabHolder imports from layout.py module, they now live in bootstrap.py module.
• Removed Python 2.5 compatibility.
• Added disable_csrf helper attribute, see docs.
• Travis-ci support thanks to Charlie Denton, see #190.
• Python 3 compatibility thanks to Charlie Denton, see #189 and #190.
• Added a settings variable named CRISPY_ALLOWED_TEMPLATE_PACKS for adding easily support for new template packs, see #192.
• Added {% crispy_addon %} tag, see #195.
• Make CRISPY_TEMPLATE_PACK optional for tests
• Make tests run the same exactly way with runtests.py and manage.py test, see #183.
• Bug fix for wrap_together when using it with partial slices.
• Fixes for KeepContext context manager, see #180.
• Added FormHelper.field_template attribute, for easily override field template for a specific form/formset, see docs.
• Added a template for rendering formsets inline within tables named bootstrap/table_inline_formset.html, that can be easily used in conjunction with FormHelper.template.
• Added FormHelper.template attribute, that easily allows to override form/formset general structure template, see docs.
• Added form_show_labels helper attribute.
• Redoing filters to use isinstance instead of hacky internal name checking, this way subclasses of standard fields will work out of the box with crispy-forms, see #176.

• Bug fix for KeepContext context manager, when crispy-forms used with Jingo/Jinja2 templates, see #179.
• Some formset tests were breaking in some Django versions. Also added a make test for easily running project tests, see #178.

• Bug fix for model formsets and inline formsets, when being rendered with a FormHelper with a layout set, where some hidden formset management fields would be missing, breaking saving to database.
• Added render_hidden_fields attribute to FormHelper, see docs.
• Added render_hidden_fields attribute to FormHelper, see docs.

• Fixes to Container and TabHolder, affecting class variable helpers with layouts containing TabHolder or AccordionGroup objects, see #172.
• Bug fix for KeepContext context manager, see #172.

• Avoid raising Exceptions in |as_crispy_field filter when not in DEBUG mode.
• Popping css_id to avoid having a css-id attribute, see #167.
• Fixed a bug in dynamic layout API, when wrapping layout objects that had arguments passed after fields. Moving LayoutSlice to layout_slice module.
• Fixed test failing when tests runned from manage.py test.
• Fixed testing name conflict, see #130.

• Added wrapper_class kwarg to Field layout object, see #163.
• Added Accordion and AccordionGroup bootstrap layout objects, see #162.
• Bug fix in render_crispy_form to avoid override existing context, see #153.
• Use formset iterator instead of forms list attribute, see #152.
• Don't display fieldset legend if empty, see #147 and #155.
• Bug fix for pickling crispy forms by powderflask, see #107.
• Switched from django.form.utils.flatatt to internal flatatt utils implementation, this allows adding data-attrs to FormActions and StrictButton.
• render_field now uses a context manager to avoid side effects when layout objects update template context. This makes context mutability safe within layout objects.
• Added greedy kwarg to filter dynamic API.
• Fixing error logging on |as_crispy_field filter, see #135.
• Implemented __delitem__, __len__ and __setitem__ in LayoutObject and DynamicLayoutHandler, this avoids pylint warnings, see #114.
• Docs folder no longer included when installing crispy-forms, see #132.
• Added wrap_once, update_attributes, map and pre_map to LayoutSlice.

• Fixed imports to be relative to package, avoiding namespace collisions.
• Removed circular dependency between layout and bootstrap, see #129.
• Bug fix, adapted use of inspect module in utils.py to avoid breaking Python 2.5 compatibility.

• Bug fix, reduction of white space in crispy-forms output could mess within tags, see #127, reverting part of this reduction.
• Renamed AppendedPrependedText to PrependedAppendedText.
• Moved Tab and TabHolder to bootstrap.py.

• Bug fix help_text_inline set to True, see #117.
• New fix for the space between buttons problems, see #62.
• Reduced importantly whitespace in html generated by crispy-forms, forms are now more compact.
• Added support for specifying a template pack per form, see #66 and #109.
• Removed clearfix class from bootstrap templates, not necessary anymore, see #105.
• Space cleanup in bootstrap templates, thanks to Si Feng, see #122.
• Fixed MultiField to work with form_show_errors helper attribute.
• Fixed a bug in MultiField that set error class when there were form errors, no matter if the fields with errors were contained within, see #120.
• FieldWithButtons now supports Field layout object as its first parameter, for setting input attributes.
• Bug fixes for FieldWithButtons, field label, help_text or error messages were not being rendered, see #121.
• Fixed a bug that was making crispy-forms render extra fields with ModelForms that didn't have Meta.fields defined, thanks to Jean-Baptiste Juin for reporting it.
• Fixed a bug that was breaking Django 1.2 compatibility when copying context variables, thanks to Alex Yakovlev for submitting a patch, see #108.
• Fixed a bug for AppendedText, PrependedText and AppendedPrependedText layout objects, thanks to Bojan Mihelac, see #104.
• Fixed a bug in appended and prepended text layout objects for respecting hidden fields, thanks to Bojan Mihelac, see #103.
• Added two new bootstrap layout objects: FieldWithButtons and StrictButton.
• Added checks and better error messages for dynamic API.
• Fixed get_layout_objects recursive call for Python2.5 compatibility, thanks to Can Başçıl for reporting it.

• Update prepended and appended templates to respect hidden fields, thanks to Bojan Mihelac, see #GH-103.
• Added InlineCheckboxes to bootstrap layout objects, for rendering checkboxes inline.
• BaseInput subclasses, like Submit can now have its value set to a context variable.
• Rendering inputs added with add_input in bootstrap using the right templates, see #GH-95.
• Improved formsets rendering docs thanks to Samuel Goldszmidt, see #GH-92.
• Added Tab and TabHolder layout objects thanks to david-e, see #GH-91.
• Fixed default bootstrap button default classes thanks to david-e, see #GH-90.
• Fixed some flaws in new testing structure by Markus Hametner.
• Added helper attribute error_text_inline thanks to Lee Semel for controlling how to render form errors, as a block or inline, see #GH-87.
• Support ModelMultipleChoiceField on checkboxselectmultiple, see #GH-86.
• Redoing testing structure a little bit, to run uni_form and bootstrap tests separately. They share most of the code base, but templates pack are separate and we need to care both have the same quality assurance.
• AppendedText, PrependedText and AppendedPrependedText were not respecting form_show_errors helper attribute, see #GH-77.
• Added a version string to the app under root init, see #GH-76.
• Added html5_required helper attribute for rendering required fields using HTML5 required attribute within the input, see #GH-72. Thanks to Lloyd Philbrook.
• Some docs typos and errors fixed, also a major upgrade to docs covering the new functionality.
• Adding a utils.render_crispy_form function, that renders a form the crispy way in Python code. This might be useful with AJAX, testing or text generation/manipulation, see #GH-64.
• Tiny cosmetic fix, that adds an space after a button, see #GH-62.
• MultiField and Fieldset layout objects can now have any kind of attribute defined, thanks to Lloyd Philbrook, see #GH-71.
• Making Fieldset, MultiField & HTML contents lazy translatable thanks to Rivo Laks, see #GH-69.
• Fixing radioselect checked status when used for a FK in a ModelForm, see #GH-68.
• Fixing form.Meta usage, using instance fields instead of static Meta definition, so that it works when updating forms on the go, see #GH-59.
• Added a low level manipulation API for layout and layout objects. Added a LayoutObject base class that creates an interface. This allows to access nested fields easily and use list methods without know internals of the system.
• Added a |classes filter that returns field's classes.
• Now FormHelper can accept a form instance as an optional first argument, from which it can build a default layout.
• Added an API for manipulating dynamic layouts and programmatic layout building.
• Added UneditableField bootstrap layout object for uneditable fields.
• Support for hiding fields using Field('field_name', type="hidden"), see #GH-55.
• Avoid template context pollution of variable form after using {% crispy %} tag, see #GH-54.
• Added an attrs helper attribute, for more flexible form attributes, see #GH-48.
• New AppendedPrependedText layout object thanks to Samuel Goldszmidt, see #GH-45.
• Removal of some whitespace in crispy form's HTML generated, see #GH-42.
• New MultiWidgetField layout object by Michal Kuffa, see #GH-39.

• Multithread safety improvements for BasicNode.
• Security fix: Thread safety fixes to CrispyFieldNode thanks to Paul Oswald. This avoids leaking information between requests in multithreaded WSGI servers.
• Added css class control-label to AppendedText and PrependedText layout object's templates.
• {% crispy field %} tag can now pass attrs to MultiWidget subclasses by Michal Kuffa. attrs are set for sub-widgets. Also attrs can now be an iterable for passing different attributes to different sub-widgets. For example,this way MultiWidget's widgets get css classes set correctly.
• Turning underscores into hyphens for Field layout objects.
• Fix for ChoiceFields using non-string choices with radio buttons thanks to Rudy Mutter. See #GH-46, #GH-43 and #GH-35.

• |crispy and |as_crispy_field filters were not rendering errors. Thanks to @ximi for reporting it and submitting a patch. See issue #GH-28.
• Fixing a test that was breaking when language was not English. Thanks to @gaftech, see #GH-30.
• Fixing radioselect.html and checkboxselectmultiple.html templates. Thanks to Christopher Petrilli for submitting a patch for radioselect. See issue #GH-35.
• HTML attributes can now be set in BaseInput subclasses like Button by @jamesmfriedman. See #GH-32.
• Fix for dynamic crispy-forms with Meta classes by Jeroen Vloothuis. See #GH-37.
• Labels now use id_for_label instead of auto_id to avoid ids breaking on multiwidgets. by Daniel Izquierdo. See #GH-38.
• Adding a flatatt custom function in utils.py for flatting extra HTML attributes.
• HTML attributes can now be set in Div layout object.
• Adding tests for new functionality and bugs.

• input name attribute is no longer slugified if only one word is provided, respecting caps.
• Changes in bootstrap global error templates by David Bennett.
• Added class control-label to labels, for horizontal layout thanks to bitrut.
• Using {{ field.html_name }} instead of {{ field.name }} in field templates, so that they work with form prefixes (formwizard) by Patrick Toal.
• Fixing error rendering in bootstrap AppendedText and PrependedText.
• Applying field.css_classes in bootstrap field.html instead of widget classes.
• Fixes for bootstrap simple checkbox input to be wrapped correctly.

• Fixing a critical bug in bootstrap templates, that was breaking {% load crispy_forms_tags %}

• Using baseinput.html template within whole_uni_form.html, to be DRY and consistent.
• BaseInput subclasses like Submit can now have ids set, using css_id
• Adding a simplified alternative syntax for {% uni_form %} tag. We can now do {% uni_form form %} for rendering a form using a helper, instead of {% uni_form form form.helper %}, if the FormHelper attribute attached to the form is named helper.
• Improving rendered_fields checking performance.
• Layouts are now rendered strictly. We don't render fields missed in the layout. If the form has a Meta class with fields or exclude, then we follow Django standards.
• Added Field layout object. You can wrap name fields within and set all kind of attributes easily or override widget template.
• Fixed #GH-111 we were not rendering all the classes in |with_class filter
• Moving django-uni-form to django-crispy-forms. Renaming tags, filters and modules. Updating tests and so on. Adding migration instructions.
• More work on simpler and easier docs.
• Adding form_show_errors helper attribute, that controls whether to render or not form.errors
• Improving template hierarchy for more template code reusability.

CHANGELOG for django-uni-form