Skip to content

Commit

Permalink
fixed upgrade notes in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
guruofgentoo committed Dec 12, 2022
1 parent f54c6cc commit 514b8ff
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions docs/source/getting-started.rst
Expand Up @@ -130,25 +130,32 @@ While we attempt to preserve backward compatibility, some KegElements versions d
breaking changes. This list should provide information on needed app changes.

- 0.8.0

- ``pytest`` removed support for nose-style methods, so base test classes (e.g. ``EntityBase``)
now use ``setup_method`` instead of ``setup``
now use ``setup_method`` instead of ``setup``

- MethodsMixin's ``testing_create`` renamed to ``fake`` for brevity
- Bootstrap 4 "horizontal" form templates had been broken and were displaying forms in the
vertical style instead. This has been resolved, which means forms will change to showing with
horizontal layout. If this is not desired, you will need to override the form templates/macros.
vertical style instead. This has been resolved, which means forms will change to showing with
horizontal layout. If this is not desired, you will need to override the form templates/macros.

- Tab index setting has been removed from the form macro templates. tabindex > 0 is not
recommended for accessibility. The _field_order attribute of the form should be used to
indirectly control tab order, instead of setting tabindex explicitly.
recommended for accessibility. The _field_order attribute of the form should be used to
indirectly control tab order, instead of setting tabindex explicitly.

- Template files now follow keg's more recent naming scheme to use dashes instead of underscores.
E.g. ``keg_elements/forms/horizontal_b4.html`` became ``keg-elements/forms/horizontal-b4.html``
E.g. ``keg_elements/forms/horizontal_b4.html`` became ``keg-elements/forms/horizontal-b4.html``

- The older Bootstrap 3 macro template (``horizontal.html``) has been renamed for
namespacing to ``horizontal-b3.html``.
namespacing to ``horizontal-b3.html``.

- ``keg-elements/form-view.html`` and ``keg-elements/grid-view.html`` are now available, but
need a config value (either ``BASE_TEMPLATE`` or ``KEG_BASE_TEMPLATE``) set to represent the
parent to extend.
need a config value (either ``BASE_TEMPLATE`` or ``KEG_BASE_TEMPLATE``) set to represent the
parent to extend.

- forms now have an ident field built-in to assist in identifying the form from POSTed data.
If a form's render is customized in the template layer, the ident field may be missing. A few
options for moving forward:
If a form's render is customized in the template layer, the ident field may be missing. A few
options for moving forward:

- add the field in render (identified by the result of the form's ``_form_ident_key`` method)
- turn off ident validation by setting ``_form_ident_strict`` to ``False`` on the form class
Expand Down

0 comments on commit 514b8ff

Please sign in to comment.