Changelog

7.11.2 (2025-03-11)

• The previously hardcoded menu CSS class on the MainMenu has been moved to the style definition, and the default changed to main_menu.

• The main menu template variable menu was renamed main_menu.

7.11.1 (2025-03-08)

• Introduce Style.icon_formatter to handle creating icons across icon libraries. So far only implemented in MainMenu.

• MainMenu external URLs fix

7.11.0 (2025-03-05)

• New MainMenu component added. This is marked as experimental, which means it can contain breaking changes in minor versions of iommi.

• Translation fixes for multi-language installs.

• The select2 component got some style fixes for bootstrap 5 dark mode.

• Respect declaration order of EvaluatedRefinable

7.10.1 (2025-02-18)

• Fixed missing end tag in error output for Table

7.10.0 (2025-02-17)

• Add scroll restore for Form

• Support IntegerField with choices

• Advanced filter js, and css as separate assets

• Stable ordering when paginating by adding automatic sorting on ordering plus pk

• Using auto__rows without model on an EditTable crashed

• Fixed incorrect rendering of global errors on Table

• Fixed invalid HTML output on error feedback page for EditTable

• Move declarations of assets and endpoints from Traversable down to Part. This can fix some obscure errors during style definitions.

• non_editable_input attrs__disabled moved to base style + added textarea. This will make some styling possible that was not possible before.

7.9.1 (2025-01-17)

• Fixed crash when specifying Field.parsed_data callback and the field was not editable

• Improved error messages for evaluation

7.9.0 (2025-01-14)

• Add support for related_query_name

• auto_rowspan on a generator gives an empty table

• Admin: configurable grouping of models

7.8.0 (2024-12-12)

• Allow throwing str and Template into Form.fields

• Add root object into evaluate parameters to easier be able to access sibling components

• Allow Table DataRetrievalMethods to be specified as a string

• Fix empty QuerySet on invalid Query. To not make e.g. .annotate in postprocess_rows trip up.

• Required as a lambda on a Field was broken

• Query: on errors on ajax reload, show the errors

7.7.2 (2024-11-26)

• Add support for “T” separator in datetime_iso_formats

• Fix Field.hardcoded to be hidden even when Field has template styling

• Table: header__template=None and header__include should both stop the header from rendering

7.7.1 (2024-11-20)

• Added back extra__is_create

• SQL trace: links to switch SQL trace output mode easily

7.7.0 (2024-10-22)

• Upgrade bootstrap to 5.3.3 and enable automatic dark mode

• Profiler middleware can now detect some incorrect middleware ordering

• Field.email should force lowercase

7.6.0 (2024-10-15)

• New crud_views() function added

• New login, logout, and create_password views added. You can install them all with auth_views()

• Fixed a crash in Form.delete()

• Don’t crash on label mapping missing

• Added “Vanilla CSS” CSS framework

• Make it possible to target the <thead> of a table with configuration

7.5.2 (2024-09-30)

• attrs__class/attrs__style didn’t evaluate lambdas for class names that contained __

• Enable inserting child parts into Field.label

7.5.1 (2024-09-28)

• Tables: format TextField.choices according to the display name from the model

• extra_params was not evaluated if path decoding was not performed

• Enable translations for js_select_all.html: “Select all” etc.

• Drop support for IE11

7.5.0 (2024-09-19)

• Optimized fragment rendering. This can have very significant performance improvement across all iommi views.

• Added style definition for US Web Design System

• Fix Action.icon rendering and customization. It now matches the api of Column.icon more closely.

• Nested forms save post handler should also save EditTables

7.4.0 (2024-08-21)

• Table.empty_message and Table.invalid_form_message now supports callables

• Invalid filters should present empty search results in tables

• Support css class names containing __

7.3.0 (2024-08-06)

• Added Form.create_or_edit shortcut.

• The default filter behavior for Column.datetime now filters on the date and not the exact microsecond.

7.2.2 (2024-07-15)

• EditTable support for one-to-one fields

• Chinese translation fix

7.2.1 (2024-06-18)

• Fix field grouping in bootstrap5 style

• Respect advanced search query in bulk operations

7.2.0 (2024-06-11)

• Make custom row templates more useful by allowing to call the default rendering, and access the column count easily

7.1.1 (2024-05-07)

• Namespace separation for evaluate_member. If you had a param named obj or key you could get a namespace conflict and a crash.

7.1.0 (2024-05-06)

• user is now included in the evaluate parameters

• All params from params are now included in evaluate parameters

• Fix bulk form render when not needed

• Admin: remove default bulk delete

• Select all fixed

• Admin all models list should be Table, not EditTable

7.0.0 (2024-04-15)

• EditTable`s `EditColumn.edit namespace is now called field. This is a breaking change. There was a namespace conflict between Column.edit and EditColumn.edit.

• EditTable and bulk editing and filtering now compose cleanly

• Changed default style to Bootstrap 5

• Allow styling of EditTable/EditColumn

• Nested forms respect if the parent form is non-editable

• SQL trace for N+1 problems will now print the last found query+traceback instead of the first. This should increase the odds of it showing something useful.

• Removed deprecated JavaScript functions

6.8.0 (2024-03-27)

• table.Column.boolean changed from fontawesome icon to unicode check mark

• <meta> viewport by default

• SearchVectorField default None factory

• select2 change triggers form change, but field can be outside a form for js purpose

• Move the data-endpoint and data-iommi-id html attributes to the table container. This is to avoid them being over-written by any empty_message provided resulting in no table tag being rendered

• added IommiBase.getContainer in JS

• default_sort_order should be indicated in the table header

• Don’t fail on non-integer pk values on pk lookup

• Fix for rare synthetic traceback issue

6.7.0 (2024-01-24)

• Added support for DurationTime db field type

• Add missing parameters to attrs and tag callbacks (#501)

• Added option to pass kwargs for csv.writer (#503)

• Field.is_valid() respecting model field validators by default (#506)

• Fixed profiler output for function names (#502)

• Removing preserved page, to always jump to the first page after filtering (#500)

6.6.0 (2024-01-15)

• Add new callback Filter.pk_lookup_to_q for building custom filter even when filter value is a model object.

6.5.0 (2024-01-09)

• Improved HTML output of profiler. Clickable links for functions, and sorting.

• Preserving filters from other table filters and sorting (fixes #496)

• If you had ?order= in your URL without value, you got IndexError (string index out of range) (fixes #495)

• Documentation fixes by first time contributor Viktor <dpedesigns@hotmail.com>

6.4.0 (2023-12-13)

• Django 5.0 support

• New debug tools: Templates used. You can use this to see what templates were used, and jump to them.

• Form based choice_queryset should go pk in the query always (fixes #443)

• Translation update (fixes #457)

• Updated Swedish translation

• Debug: Don’t shorten paths, as this makes links un-clickable in pycharm console

• Optimizations

6.3.0 (2023-10-24)

• Edit table: support non-rendered and hardcoded column

• Edit table: create rows in the order given in the GUI

• Improvements to transaction handling in the middleware: The middleware should have the same atomic behaviour as django BaseHandler.make_view_atomic

• You can now use iommi’s profiler on form POST requests. Click the “Profile POST” button then press submit on the form you wish to profile.

• Tables/queries: Filtering on numbers broken

• Fixed bootstrap styling to style numeric input as right aligned

6.2.0 (2023-09-26)

• Added iommi_head_contents_last block to base.html

• Fixed models.CharField(choices=..., blank=True, null=False) validation

• Column.select didn’t handle models with UUID primary keys

• Datetime rendering should be in local time format, not UTC

• Fixed for Python 3.11

• Sort links on table ajax reloads

• Fixed lazy capitalization of titles

• Added Czech translation

• Warn if user has forgotten to add iommi to INSTALLED_APPS

• Fixed translation context for “Filter” (The verb and the noun are the same in English, so there was some confusion)

• Fixed translations

• Prevent double save on files/images when over the in-memory limit

• Added Form.fields_template

• Avoid crash on admin pages when running without iommi.middleware

6.1.1 (2023-08-25)

• JSONField was incorrectly handled in Django 3.1+

• Dropped support for Django 3.0

6.1.0 (2023-08-21)

• Field.checkboxes added

• parse_empty_string_as_none not working properly with choice

• Fix EmailField / URLField with required=False

• Allow inheritance for class Meta

• JS crash on inter-page link navigation (like foo/#something)

• Don’t crash if page_size not integer (Thanks to new contributor Oana!)

6.0.0 (2023-08-16)

• JS refactoring of table filtering. This drops Axios as a dependency. (Thanks Bery!)

• Field.is_valid callback should handle raised ValidationError

• Added Field.hardcoded

• Fix setting display_name on freetext_search field implying required

• Fixed filter form reset (thanks Bery!)

• Dropped invoke_deprecated_callback

• Removed support for deprecated arguments checked and checkbox_name for Column.select

• Removed deprecated register_advanced_path_decoding, and the corresponding old syntax for register_path_decoding

5.13.0 (2023-05-10)

• Fix regression in 5.12.0 where tables fail to calculate filter choices on optional columns.

5.12.0 (2023-04-26)

• More blocks to customize the base template: iommi_html_tag_attrs and iommi_html_tag_attrs

• Added Table.table_tag_wrapper for when you want to wrap the <table> tag but not the paginator. This is useful for making apps work better on phone layouts.

• Insert the language code into the <html> tag.

• Generate deprecation warnings in all places not yet passing standard callback parameters

• Choices now passes correctly downstream from Column(choices=...) to the filter, the filters form, and bulk fields.

• The admin now can be inserted into the url patterns inside a named app (thanks Mickey McClellan)

5.11.0 (2023-04-08)

• Ukrainian language support (Thanks Yury Bulka!)

5.10.1 (2023-04-06)

• OneToOneField reverse mapping should use the singular field name. This was a regression introduced in 5.8.0 when ManyToMany reverse support was fixed. (Thanks Yury Bulka!)

5.10.0 (2023-04-05)

• Fix issue with filter fields not being hidden when the corresponding column is hidden.

• Fix extra__redirect not getting all parameters.

• Fix Form.editable to have truthy semantics, not requiring strictly False

• CRUD Form default title should be done lazily, since instance might be a lambda

5.9.0 (2023-03-28)

• iommi.forms.save_nested_form added. This is useful for when you want to save multiple forms with one submit button.

• Fixed admin defaults to have lower priority so you can properly override them.

• Added dummy factory registration to not crash on GenericRelation and GenericForeignKey

• Forms: check model.validate_constraints() on Django 4.1+ (Thanks Yury Bulka!)

• Enable users to disable full form state sending on select2 ajax. To disable, set the data-select2-full-state attribute to false on the form.

5.8.1 (2023-02-28)

• Fix bug where form submit include dispatch parameters e.g. bulk forms break after table tbody reload.

5.8.0 (2023-02-14)

• ManyToMany reverse support

• Live editing of styles

• Fixed crash when using form field groups and bootstrap

• Basic support for the UIKit CSS framework added

5.7.1 (2023-02-08)

• Add request parameter to extra_params callback.

5.7.0 (2023-02-01)

• Make Column.select() more suitable to customization

• Unify callback parameters for cell__value and cell__format

• Make .as_view be lazy with refine_done to not explode import times

• Added extra_params callback to sneak in parameters while porting old-style view code

• Added Field.non_rendered shortcut

• sort_after raises SortAfterException instead of KeyError to improve error message rendering in debug page (KeyError did repr(message))

• Bootstrap style fix for grouped fields when using select2

• Fixed examples project scrape code

• Move Form style template definition to be more of an overridable default

5.6.2 (2022-12-16)

• CSV export and row_group didn’t work together

5.6.1 (2022-12-08)

• Row grouping on EditTable now works.

5.6.0 (2022-12-06)

• Added row grouping feature on Table

• Allow pre-invoking .refine_done() on parts of pages for optimization.

• Optimization of excessive attempts to invoke callbacks

5.5.0 (2022-11-30)

• Support reverse foreign key relationships

• Improved handling of unknown database field types: don’t crash if they are not included anyway

• API docs are much improved, and all docs have been improved with updated tooling to automatically catch future errors

• Admin: copy to clipboard of conf. This should make it even faster to customize your admin.

• Profiling page: links to graph and snakeviz profiling views

• Render “loaded templates” where templates are normally accepted

• Fix missing crud form header when not using auto__

• Add default message to delete form when there are no specified fields

• Fix Column.from_model still require model parameter

• Make h_tag respect sort_after

• Admin: Fixed display of help text

• Derive missing config when from_model only gets model_field parameter

• Some optimizations when you can reuse an object from on_refine_done.

• Minor bootstrap5 style fixes

• Fix cache key snafu in parameter matching cache for evaluate

5.4.0 (2022-10-26)

• Add sorter configuration to Table for when rows need special handling on sorting.

5.3.1 (2022-10-24)

• Fix regression in 5.3.0 moving javascript assets

5.3.0 (2022-10-20)

• New path decoding API

• Form data for filled fields should be sent with select2 ajax callbacks (the documentation said we did this :P)

• Fix EditTable save on ManyToMany fields

• The default SQL tracer didn’t output to the console

• If a create form is not valid the save post handler should not try to build an instance

• Drop support for django <3.0, Add tests for django 4.1

• Drop python 3.7

• Introduce Traversable.invoke_callback(…) helper function with better error reporting

5.2.1 (2022-10-03)

• Fix regression in 5.2.0 after fixing include directive on filter form fields

5.2.0 (2022-09-16)

• Insert arbitrary parts in Table. There is a namespace outer on table where you can insert things.

• Filter form fields failed to respect include directive from filter

• Fix for live edit when used with iommi path decoding

• Fixed a crash in the debug tree that sometimes happened if you had an non-editable Field

• Live edit internal API is now a bit more flexible, making it possible to adapt it to your own use cases better

5.1.2 (2022-09-02)

• Late evaluation of Field.editable, so you can now give a lambda for editable

• Rare crash when Field.on_bind tries to access form.all_fields, that is removed

• Admin debug message was shown in non-debug

5.1.1 (2022-08-25)

• Add group name of form group specifier to lambda args when rendering the corresponding tags

5.1.0 (2022-08-12)

• Admin: respect django permissions system

• Compatibility with Python 3.11

• Enable usage of reverse_lazy with redirect_to

• Allow redirect_to to be an instance of django.utils.functional.Promise that is a proxy for a string (which is what reverse_lazy returns)

• Admin delete page should present 404 page on non-existing object

• Menus should attempt to respect query parameters when doing set_active

5.0.0 (2022-05-12)

• Dependencies tri.declarative and tri.struct are merged into iommi and are thus no longer required. You should remove them from your project and fix your imports to only import from iommi if you had imports from tri_struct or tri_declarative.

• Fixes for how style definitions are merged. This fixes an issue where select2 wasn’t used properly in table filters.

• Refurbished priority for settings on refinable objects. E.g style settings can now overwrite things declared by shortcuts.

• Fixed paginator and select2/choice/radio control when django is configured to use thousands separator

• Drop Field parameters choice_to_option and empty_choice_tuple

• Drop Style parameter assets. Assets parameters now strictly go in root__assets

• Silenced deprecation warning from Django for app configs

• Improved error messages

• Workaround for crash deep in pytest internals when using synthetic traceback

• Separate Form.edit from auto__ machinery

• Introduced new decorator @with_defaults for giving parameters in shortcuts in a more natural way.

• Introduced new decorator @superinvoking_classmethod to enable a classmethod to call a base class implementation with the same name. Useful when declaring more specific shortcuts when customizing using inheritance.

4.7.0 (2022-04-01)

• Improved exceptions: you now get an exception frame that points to the declaration if you use the declarative style. This makes it much easier to know what code is responsible for a crash.

• Fixed CSV rendering endpoint and added an example for it

• EditTable is no longer experimental!

• Fix rendering of choices in filter select widgets from CharField with choices

• Bulk editing: fields should be default None, even if the model has a default value

• Fixed rendering of disabled checkbox

4.6.0 (2022-03-02)

• Chinese translation

• Base style no longer includes the select2 assets

• h_tag should be possible to set to None and to set include=False

• Fixed default handling for get_sql_debug

• Fixed issue where you couldn’t set non-editable input tag to ‘input’

• Fix auto rowspan. It was broken if you did multiple bind() on the same object

• Live edit improvements: Handle slower pages MUCH better, and editing of classes works

• Fixed styling for non-editable select2

4.5.1 (2022-01-12)

• Minor fix for SQL tracing when function names could not be retrieved

4.5.0 (2022-01-11)

• Path decoding feature added. See https://docs.iommi.rocks//path.html

• New style: bootstrap5. Thanks to Nigel Metheringham!

• Expose perform_dispatch for legacy FBVs. See https://docs.iommi.rocks//legacy_fbv.html for how to use it.

• Forms: Some asserts to make redirect/redirect_to more fool proof

• Forms: A little check to make setting search_fields on a Field more fool proof

4.4.0 (2021-12-22)

• Send full state of current form when doing ajax select2 callback, enabling more advanced filtering

• Fixed bug where auto__include=['fk__charfield'] crashes

• Fixed bug where style application on an object only had an effect on the child objects

• Form.delete will now show a nice error message if the object can’t be deleted due to restricted rows

• EditTable: Add row feature added

• EditTable: Delete row feature added

• EditTable: field on an EditColumn now match the behavior of field for a normal Form

4.3.3 (2021-12-09)

• EditTable: Fixed auto__rows

• EditTable: if instance.pk < 0, treat this as a create

• Passing search_fields to a Field.choice_queryset did nothing

4.3.2 (2021-12-06)

• EditTable can now be nested inside a Form, similar to how forms can be nested in forms.

• Make it possible to turn off freetext_search query form field by passing None as config.

• Optimized writing for EditTable

• Several fixes for EditTable. Basically it works now :)

4.3.1 (2021-11-30)

• Due to a mistake in packaging the experimental feature EditTable was not included in previous release. This is now fixed.

4.3.0 (2021-11-30)

• Freetext field could be shown when it shouldn’t, causing a crash on search

• Experimental feature: EditTable. Import iommi.experimental.edit_table.EditTable. This API can change at any time and also move away from experimental.

• Logout redirect for Form.edit/Form.create now follows settings.LOGOUT_REDIRECT_URL

• Nicer error message for missing parso install

• Fixed error for when you specify conf in a way that isn’t supported. This would silently ignore the configuration before.

4.2.0 (2021-11-18)

• Field groups in forms. There is a new string group member on Field that is used to group, a group namespace on Form you can use to set attrs, tag, etc. Global styling for form groups is done via the FieldGroup class. The bootstrap style has been updated to support this feature out of the box.

• Validation could be bypassed for forms if they have been saved via form.refine_done(). This became the default behavior for .as_view() in iommi 4.1 so that release is broken.

4.1.0 (2021-11-15)

• as_view() calls refine_done, giving you a nice little performance win for free

• Introduce @iommi_render view decorator. Use this to get correct behavior when using transactions by default in views. The iommi middleware will now produce an error if you try to use it incorrectly.

• Re-initializable select2 enhancement. If you dynamically modify with javascript you can call iommi_init_all_select2 to re-initialize iommi select2 components

• Break out the select2 enhancement from the base style into a separate select2_enhanced_forms style, and added it to all the built in styles. If you have a custom style that extended base you must now also add select2_enhanced_forms to that style to get the same behavior as before.

• should_ignore_frame() is more robust against acrobatic frames. This is a rather obscure bug that won’t affect normal iommi usage.

4.0.0 (2021-11-01)

• Dropped support for __ in names of declared columns/fields/filters (deprecated since 3.2.0)

• Big internal refactoring. You should see some performance improvements across the board.

3.4.0 (2021-10-22)

• Ability to customize the Cell and Cells classes used by Table rendering

• Improved ability to customize Table.tbody. You can now add html after or before the rows from the table itself

• Template-based rendering should get iommi_evaluate_parameters as context. This was the case in some cases but not all, most notably when rendering a Fragment.

3.3.0 (2021-10-20)

• Added snakeviz profiling (use it by passing _iommi_prof=snake as a url parameter)

• Fixed stack traces in SQL tracing

• Fixed jump to code for several scenarios

• German translation fixes and updates

• Improved error message for invalid admin config

• write_nested_form_to_instance now takes keyword arguments

3.2.2 (2021-10-01)

• Fix bug causing any endpoint invocation of table fields to force a bind of the paginator (Which should be lazy)

3.2.1 (2021-09-24)

• Fix enforcement on required=True on Field.multi_choice and others where value is a list.

3.2.0 (2021-08-23)

• Names with underscore are deprecated and will be removed in the next major version. This means you can no longer write this:

class MyTable(Table):
    foo__bar = Column()

You must now instead write:

class MyTable(Table):
    some_name = Column(attr='foo__bar')

Using foo__bar had some weird consequences like you not being able to later target that name without getting ambiguities in what __ meant.

3.1.1 (2021-06-18)

• Expand ajax reload on filter change of tables to also include the bulk form. If not done, the bulk options are not in sync with the filtering.

• Remove reference to non-existent errors.html in bootstrap style

• Make Table.visible_rows non-lazy and not a property

• Table.rows is no longer a property

3.1.0 (2021-06-09)

• Form: Evaluate parameters now contain instance

• Use the same redirect logic for delete as create/edit. This means you can now use extra__redirect and extra__redirect_to for delete too

• When stopping the live editing, a full runserver restart is now triggered so you get the new code you just edited

3.0.0 (2021-05-24)

• Styles have a new sub_styles parameter. This change greatly simplifies how you set up a custom style for your project if you want to customize the query form.

• IOMMI_DEFAULT_STYLE can now be a Style object

• Breaking change: The horizontal styles are removed and replaced with the substyle feature. If you use for example 'bootstrap_horizontal', you need to replace it with 'horizontal'.

• Mixed case filter fields didn’t work

• Respect browsers preferred dark/light mode for profiler and sql tracer

2.8.12 (2021-05-18)

• Major bug: tables based on querysets would implicitly use the django result cache. This resulted in the contents of the table not changing until after process restart

2.8.11 (2021-05-07)

• Fragment should have @with_meta

• Fixed nesting tables inside forms. This would previously crash with a strange error message.

• Avoid infinite loop in sort_after on too large indices

2.8.10 (2021-04-28)

• Read defaults from model for initial of fields

• Increased log level of SQL logging from 11 to 21 (DEBUG+1 -> INFO+1)

• Added null factory for JSONField

• Fixed live editing code to use the same logic as ‘jump to code’ to find the code

• Fixed one case where live edit broke

• Prettier debug menu for live editing

• Prettier query help text (thanks new contributor flying_sausages!)

2.8.9 (2021-03-08)

• Fixed bad html escape in SQL trace magnitude graph (this is not a security problem, as it’s a developer tool with very restricted access)

• Renamed freetext to freetext_search. It was too easy to collide with a user defined model with a field called freetext

2.8.8 (2021-02-23)

• Automatically generating a Query from a model with a foreign key was broken in cases where the name field wasn’t the same as name field of the parent model

2.8.7 (2021-02-22)

• Make it possible to pass a lambda to title of Page/Form/Table

• Improved error when trying to register an already registered style

2.8.6 (2021-02-19)

• Revert to the old (pre 2.8.2) way of using search_fields to compose queries.

  The new approach failed for cases when there was a custom value_to_q definition. A proper fix needs to have a unified approach also when using .pk format.

2.8.5 (2021-02-17)

• Render title of Page objects. To turn off the rendering of the title pass h_tag__include=False.

• Removed the register_search_fields warning, it was 90% annoying and 10% useful

2.8.4 (2021-02-15)

• Form: support passing instance as a lambda, even in combination with auto__model

2.8.3 (2021-02-14)

• Removed bad assert that prevented passing instance as a lambda for auto__model of Form

• SQL trace was broken for postgres

• query_from_indexes should automatically generate filters for foreign keys. This especially affected the admin.

2.8.2 (2021-02-09)

• Avoid using search_fields when composing queries from model filter values. Always using the .pk fallback approach is more stable when the search field values might not be unique. This will remove a bunch of warnings that weren’t very helpful too.

• Fixed crash when setting query__include=False on Table

• capitalize() now handles safe strings properly. This will enable you to pass safe strings to title for example.

• Translation of Yes/No

• Fixed error message for register_search_fields

• Updated to fontawesome 4.7

• Renamed live edit asset to not conflict with the name ‘custom’ which might be fairly common

• Nicer title in the admin for apps

2.8.1 (2021-02-01)

• Auto generated tables had “ID” as the column name for foreign keys, instead of the name of the remote model.

• Profiler fixed: the bind and render of iommi objects that were handled by the middleware weren’t profiled

• Fixed live edit to work for views with URL arguments

• Handle settings.BASE_DIR as Path objects

• fix bulk__include = False on table

• Make DebugMenu created on demand to avoid setting of breakpoints when debugging your own code

• Models in admin are now in alphabetical order

• Field is not a Tag, so you can render a Form as a div if you want.

• The root menu item for the iommi admin was broken if you inherited from Admin

• Force the live edit view to be bootstrap. This avoids the live edit feature looking a big broken for your own custom styles.

• Minor bootstrap styling fix for non-editable fields

2.8.0 (2021-01-13)

• Nested forms

• The paginator is now lazy. This means we can avoid a potentially expensive .count() database hit in many situations

• Added Table.bulk_container

• Table.post_bulk_edit takes evaluate parameters now

• Column.include=False implies that the column shouldn’t get anything in the bulk form. If you want bulk editing without a visible column use Column.render_column=False

• Support auto__include=[‘pk’]

• Fix reinvoke/reinvoke_new_defaults when shortcut is changed

• Date/datetime parsing bugs fixed after mutation testing

• Do not do form post_validation if we are in initial display mode

• Forms now don’t create a submit button by default. If you have a post handler you will get a submit button though.

• SQL trace bugfixes

• Custom raw_data callback should have same semantics as constant value (and parsed_data callback)

• Improved error message on disallowed unbound object access

• Documentation improvements, for example new pages for dev tools, and styles

• Live editing on .as_view() style views work in the case of an explicitly declared class

• Fixed bug where the ajax enhanced table didn’t work if you used Table.div or otherwise changed the tag of Table

• Fixed auto__model column/filter for CharField with choices

2.7.0 (2020-12-14)

• A Form can now contain non-Field parts. Iterate over everything to render with form.parts and all the fields to be validated with form.fields. Fields that are not direct children are also collected, so you can easily add extra structure by wrapping a bunch of fields in a html.div for example.

• Support Django’s CharField.choices feature

• You can now customize the name shown in the advanced search via Filter.query_name

• Form submit buttons (Actions.submit) are now rendered as <button> not as <input type="submit">.

• Added SQL trace feature

• You can now apply styles on the root object. Example: root__assets__my_asset=Asset(...)

• Edit button only present in debug menu when the edit middleware is installed

• Added profile button to debug menu

• Make collected assets more accessible when rendering iommi in your own templating environment: you can now access them on the iommi objects: my_iommi_obj.iommi_collected_assets()

• Removed broken validation of sort columns. This validation prevented sorting on annotations which was very confusing as it worked in debug mode

• Make it possible to target the live edit page with styles (via LiveEditPage)

• The live edit view can be flipped between horizontal and vertical layouts

• The debug tree view is slimmed down (by not including endpoints and assets on lots of things)

• Field.raw_data_list is removed. You can know if it’s a list or not by checking is_list, so raw_data covers the uses cases.

• Include decorators in live edit

• The debug jump to code feature should work for some more scenarios, and it will not display if it has no good guess.

• DEPRECATED: Field.choice_to_option. This is replaced by choice_id_formatter and choice_display_name_formatter

2.6.1 (2020-12-01)

• Fixed live editing to work when distributing iommi

2.6.0 (2020-12-01)

• Live editing of function based views in DEBUG. Works for both iommi views and normal django views.

• Added ajax enhanced table filtering

• You can now turn off the advanced mode on queries: Table(query__advanced__include=False)

• Query has two new refinables: filter and post_process. These are hook points if you need to further customize what query is generated.

• Enable profiling when DEBUG mode is on, even if you’re not staff

• Fixed multiselect on empty list

• Added missing get_errors() member function on Field

• Fixed select2 widget when the base url do not end with /

• Styling fixes. Primarily for bulma.

2.5.0 (2020-11-19)

• include=False on a Column should imply not generating the query filter and bulk field. If you want to not render a column but still want the filters, use the render_column=False feature

• Added callbacks for saving a form: extra__pre_save_all_but_related_fields, extra__on_save_all_but_related_fields, extra__pre_save

• Added extra__new_instance callback to Form.create for custom object creation

• The errors list has been changed. You should always use add_error() to add an error on a Field or a Form

• It is now possible to call is_valid() and get_errors() and get what you expect from post_validation on Field and Form

• Query forms can now have additional fields, that are ignored by the filter handling code (when you want to do additional filtering outside of the query logic)

• Bug fixes with state leaking between binds

• Fixed jump to code

• Improved error message for is_valid_filter

• Added a nice error message if you try to shoot in style or class as raw strings

• Fixed empty table message, and invalid query form messages

2.4.0 (2020-11-04)

• The given rows queryset and filtering were not respected for the “Select all rows” bulk feature. This could produce some pretty bad bugs!

• Support custom bulk post_handlers on lists and not just querysets

• Table has a few new members:

  • initial_rows: the rows you pass (or that gets created by auto__model) is stored unchanged here

  • sorted_rows: initial_rows + sorting applied

  • sorted_and_filtered_rows: sorted_rows + filtering applied

  • visible_rows: sorted_and_filtered_rows + pagination applied

  • rows: this is now a property and will map to the old behavior which is the “most applied” member that exists

• Fixed passing dunder paths to auto__include. You got a weird crash if the target of the path was a foreign key. There are still issues to be resolved adjacent to this, but the base case now works.

• Fixed the “select all” feature for pages with multiple tables.

2.3.0 (2020-10-30)

• Every part can now have assets that are added to the assets of the style and included in the head. This is particularly useful for bundling small pieces of javascript or css with the components that need them and thereby gets us closer to being able to write truly self contained “component”. As a proof of concept I did so for the tables javascript parts. The naming takes care of deduplication of assets.

• Only include select2 assets when needed (possible because of the point above)

• Filtering on booleans was very broken. It always returned empty querysets and didn’t produce errors when you tried to do stuff like my_boolean<3

• It’s now possible to configure stuff on the freetext field of a query

• iommi will now grab the root page title from the text from Header instances in addition to Part.title

• Render date fields as such

• Fixed date and time formatting

• Support for optgroups in forms

• Make it possible to insert fields into the form of a query, and filters into a query

• Differentiate between primary and other actions. This should make iommi pages look more in line with the majority of design systems. If you have a custom style you probably want to add a style definition for Action.primary.

• Fixed a case of a silent overwrite that could be surprising. This was found during reading the code and has never happened to us in practice.

• Style fixes for bulma

2.2.0 (2020-10-16)

• Fix so that style application does not alter definitions destructively. This could lead to some strange behavior if you tried to switch between styles, and it could leak over definitions between things you would not expect.

• The title of Table is None when there is no model

• Assets as first class concept. You can now insert asset definitions into your style with assets__js=... instead of defining a base_template. This change also removes the base templates for all the built in styles as they are now obsolete.

• Made it easy to hide the label of a Field by setting display_name=None, or include=False

2.1.0 (2020-10-07)

• Internationalization! iommi now has i18n support and ships with English, German and Swedish languages out of the box. We welcome more translations.

• Out of the box support for the Bulma CSS framework

• Make auto__include specifications allow foreign key paths

• By default we now grab display_name from the model fields verbose_name (if applicable)

• Sometimes you got reordering of parts when doing a post to a form for example, this is now fixed

• The traversable argument to lambdas is now the leaf and not the root. This was a bug.

• Support reverse_lazy as url argument to MenuItem

• Two id attributes were rendered on the input tags in forms (thanks Benedikt Grundmann for reporting!)

2.0.1 (2020-09-22)

• delete_object__post_handler accessed instance.id which might be valid. It should have accessed instance.pk which is always valid.

2.0.0 (2020-09-22)

• BACKWARDS INCOMPATIBLE: Style must now take a base_template argument. This replaces the setting IOMMI_BASE_TEMPLATE.

• BACKWARDS INCOMPATIBLE: IOMMI_CONTENT_BLOCK is removed. Replaced by the content_block setting for Style.

• Allow table rows to be provided from a generator. (Disabling paginator)

• Added blocks (iommi_head_contents, iommi_top, and iommi_bottom) as useful hook points to add custom data in the templates if you don’t need a totally new template but want to just customize a little bit.

• The default sort_key on a Column.foreign_key now looks at the searchable field of the remote field (‘name’ by default). This means by default sorting will mostly be more what you expect.

• Changed the error from get_search_field() for non-unique name to a warning.

• Removed <table> for layout in query advanced/simple stuff.

• Don’t warn for missing register_search_fields when attr=None

• Set admin to bootstrap by default.

• Added form for changing password. Used by the admin but also usable from your code.

• Added form for login. Used by the admin but also usable from your code.

• Fixed foundation styling for query form.

• Introduced Field.help. This is the fragment that renders the help text for a Field. This means you can now style and customize this part of forms more easily. For example set a CSS class: Field(help__attrs__class__foo='foo'.

• Use django default date and time formatting in tables.

• New shortcut for Table: Table.div for when you want to render a Table as a bunch of divs. This is useful because a Table is really a view model of a sequence of stuff, not just a <table>.

• Possibility to set Actions.tag to None to not get a wrapping html tag.

• Added Table.outer as a tag you can style that encompasses the entire table part.

• Moved Form.h_tag rendering inside the form tag to make it stylable as a coherent whole.

• Grab html title from first part if no title is given explicitly. This means you’ll get the <title> tag filled more often by what you expect automatically.

• Template instances are now collected properly by Part.

• Read admin config from modules.

• The Admin is now opt in, not opt out.

• The admin is now MUCH prettier and better.

• Actions for Table are now rendered above the table by default. Set actions_below to True to render them the old way.

• Many misc improvements

1.0.3 (2020-08-24)

• Changed Table.bulk_form to Table.bulk. The old name was a mistake as the name was always bulk. This meant that styling didn’t work like you expected and the pick feature also lead you down the wrong path.

1.0.2 (2020-08-21)

• Support user inputted relative dates/datetimes

• Support more time formats automatically

• Introduced Filter.parse() which is a hook point for handling special parsing in the query language. The query language will no longer try to convert to integers, floats and dates for you. You have to specify a parse() method.

• Added traversable key to evaluate parameters. Think of it like something similar to self.

• cell__format now gets all evaluate parameters like you’d expect

• Filters: If attr is None but you’ve specified value_to_q then your filter is now included

• Various bug fixes

1.0.1 (2020-06-24)

• Optimizations

• Use select2 as the default for multi_choice

• Improved usability: Make icon column behavior on falsy values more guessable

• Accidentally changed default style to foundation, change back to bootstrap

• Improved usability: Don’t fall back to default template name if the user specified an explicit template name: fail on TemplateNotFound

• Style on root uses correct base template

• Allow model fields called context

1.0.0 (2020-06-10)

• Backwards incompatible: register_search_fields replaces register_name_field. This new system is a list of field names and not just a single field. There is also new searching and filtering behavior based on this that means you will get better search results

• Backwards incompatible: field_name as used by model factories is replaced with model_field_name. If you used register_factory you will need to change this. The field names on Column, Field and Filter are also renamed.

• Support fields named keys, value or items on Django models

• Added basic styling support for CSS frameworks Water and Foundation

• Fix include to make None mean False

• Change Filter.text to search using icontains instead of iexact by default in the basic search mode

• Change post_validation callback to receive standard evaluate parameters

• Improved help text for queries

• Field.radio was broken in the bootstrap style: it specified the input template as the template for the entire field, so the label got erased

0.7.0 (2020-05-22)

• Fixed default text argument to Fragment

• Fixed issue where endpoint dispatch parameter was left over in the pagination and sorting links

• Parts that are None should not be collected. This affected the admin where it printed “None” below the “Admin” link.

• Added header for bulk edit form in tables

• Fixed textarea readonly when field is not editable

• Fixed is_paginated function on Paginator

• Add request to evaluate parameters

• Make evaluate and evaluate_recursive match even the **_ case by default

• No dispatch command on a POST is invalid and will now produce an error

• Lazy bind() on members. This is a performance fix.

• Fixed bug where display_name could not be overridden with a lambda due to incorrect evaluate handling

• Removed Table.rendered_columns container. You have to look at the columns and check if they have render_column=False

0.6.2 (2020-04-22)

• Fixed data-endpoint attribute on table

0.6.1 (2020-04-21)

• Fixed tbody endpoint and added a div to make the endpoint easier to use

0.6.0 (2020-04-17)

• Fixed an issue where fragments couldn’t be customized later if built with the html builder

• Action inherits from Fragment. This should be mostly transparent.

• You can now pass multiple argument to Fragment/html.foo(). So html.div('foo', 'bar') is now valid and creates two child nodes child0 and child1

• Uncouple auto__* from row parameter. auto__ only suggests a default. This avoids some confusion one could get if mixing auto__rows, auto__models and rows in some ways.

• Fixed setting active on nested submenus where the parent had url None

0.5.0 (2020-04-01)

• Include iommi/base_bootstrap.html and iommi/base_semantic_ui.html in package, and use them if no base.html is present. This improves the out of the box experience for new projects a lot

• Support mixing of auto__model/auto__row based columns and declarative columns

• Support attrs__class and attrs__style as callables

• Added support for context namespace on Page, which is passed to the template when rendering (for now only available on the root page)

• Fixed how we set title of bulk edit and delete buttons to make configuration more obvious

0.4.0 (2020-03-30)

• Fixed rendering of grouped actions for bootstrap

• Respect auto__include order

• boolean_tristate should be the default for the Field of a Column.boolean

• New class Header that is used to automatically get h1/h2/etc tags according to nesting of headers

• Table.rows should be able to be evaluated

• Added feature that you can type ‘now’ into date/datetime/time fields

• Feature to be able to force rendering of paginator for single page tables

• Paginator fixes: it’s now no longer possible to use the Django paginator, but the iommi paginator is more full features in trade.

• Removed jQuery dependency for JS parts

• Big improvements to the Menu component

• filters that have freetext mode now hide their field by default

• Added “pick” in the debug toolbar. This is a feature to quickly find the part of the document you want to configure

• Introduced Form.choice_queryset.extra.create_q_from_value

• Changed so that Query defaults to having the Field included by default

• Renamed BoundRow/bound_row to Cells/cells

• Major improvements to the admin

• Lots and lots of cleanup and bug fixes