Release Notes¶
v0.9.0 (Released 2014-10-21)¶
This release primarily addresses incompatibility with Django 1.7. The app-loading refactor both broke the previous registration and at the same time provided better utilities in Django core to make it more robust.
- Compatibility with Django 1.7. Thanks to Calvin Spealman for the fixes.
- Fixes for Python 3 support.
Backwards Incompatible Changes¶
- Dropped support for jQuery < 1.7
v0.8.0 (Released 2014-01-20)¶
- Widget media references now include a version string for cache-busting when upgrading django-selectable. Thanks to Ustun Ozgur.
- Added compatibility code for *SelectWidgets to handle POST data for the default SelectWidget. Thanks to leo-the-manic.
- Development moved from Bitbucket to Github.
- Update test suite compatibility with new test runner in Django 1.6. Thanks to Dan Poirier for the report and fix.
- Tests now run on Travis CI.
- Added French and Chinese translations.
Backwards Incompatible Changes¶
- Support for Django < 1.5 has been dropped. Most pieces should continue to work but there was an ugly JS hack to make django-selectable work nicely in the admin which too flakey to continue to maintain. If you aren’t using the selectable widgets in inline-forms in the admin you can most likely continue to use Django 1.4 without issue.
v0.7.0 (Released 2013-03-01)¶
This release features a large refactor of the JS plugin used by the widgets. While this
over makes the plugin more maintainable and allowed for some of the new features in this
release, it does introduce a few incompatible changes. For the most part places where you
might have previously used the autocomplete
namespace/plugin, those references should
be updated to reference the djselectable
plugin.
This release also adds experimental support for Python 3.2+ to go along with Django’s support in 1.5. To use Python 3 with django-selectable you will need to use Django 1.5+.
- Experimental Python 3.2+ support
- Improved the scope of
prepareQuery
andformatLabel
options. Not fully backwards compatible. Thanks to Augusto Men. - Allow passing the Python path string in place of the lookup class to the fields and widgets. Thanks to Michael Manfre.
- Allow passing JS plugin options through the widget
attrs
option. Thanks to Felipe Prenholato. - Tests for compatibility with jQuery 1.6 through 1.9 and jQuery UI 1.8 through 1.10.
- Added notes on Bootstrap compatibility.
- Added compatibility with Grappelli in the admin.
- Added Spanish translation thanks to Manuel Alvarez.
- Added documentation notes on testing.
Bug Fixes¶
- Fixed bug with matching hidden input when the name contains ‘_1’. Thanks to Augusto Men for the report and fix.
- Fixed bug where the enter button would open the combobox options rather than submit the form. Thanks to Felipe Prenholato for the report.
- Fixed bug with using
allow_new=True
creating items when no data was submitted. See #91. - Fixed bug with widget
has_changed
when there is no initial data. See #92.
Backwards Incompatible Changes¶
- The JS event namespace has changed from
autocomplete
todjselectable
. data('autocomplete')
is no longer available on the widgets on the client-side. Usedata('djselectable')
instead.- Combobox button was changed from a
<button>
to<a>
. Any customized styles you may have should be updated. - Combobox no longer changes the
minLength
ordelay
options.
v0.6.2 (Released 2012-11-07)¶
Bug Fixes¶
- Fixed bug with special characters when highlighting matches. Thanks to Chad Files for the report.
- Fixed javascript bug with spaces in
item.id
. Thanks to @dc for the report and fix.
v0.6.1 (Released 2012-10-13)¶
Features¶
- Added Polish translation. Thanks to Sławomir Ehlert.
Bug Fixes¶
- Fixed incompatibility with jQuery UI 1.9.
v0.6.0 (Released 2012-10-09)¶
This release continues to clean up the API and JS. This was primarily motivated by Sławomir Ehlert (@slafs) who is working on an alternate implementation which uses Select2 rather than jQuery UI. This opens the door for additional apps which use the same lookup declaration API with a different JS library on the front end.
Python 2.5 support has been dropped to work towards Python 3 support. This also drops Django 1.2 support which is no longer receiving security fixes.
Features¶
- Initial translations (pt_BR). Thanks to Felipe Prenholato for the patch.
- Upgraded default jQuery UI version included by the template tags from 1.8.18 to 1.8.23
- Added
djselectableadd
anddjselectableremove
events fired when items are added or removed from a mutliple select
Bug Fixes¶
- Cleaned up JS scoping problems when multiple jQuery versions are used on the page. Thanks Antti Kaihola for the report.
- Fixed minor JS bug where text input was not cleared when selected via the combobox in the multiselect. Thanks Antti Kaihola for the report and Lukas Pirl for a hotfix.
Backwards Incompatible Changes¶
get_item_value
andget_item_id
are no longer marked as safe by default.- Removed AutoComboboxSelectField and AutoComboboxSelectMultipleField. These were deprecated in 0.5.
- Dropping official Python 2.5 support.
- Dropping official Django 1.2 support.
paginate_results
signature changed as part of the lookup refactor.SELECTABLE_MAX_LIMIT
can no longer beNone
.
v0.5.2 (Released 2012-06-27)¶
Bug Fixes¶
- Fixed XSS flaw with lookup
get_item_*
methods. Thanks slafs for the report. - Fixed bug when passing widget instance rather than widget class to
AutoCompleteSelectField
orAutoCompleteSelectMultipleField
.
v0.5.1 (Released 2012-06-08)¶
Bug Fixes¶
- Fix for double
autocompleteselect
event firing. - Fix for broken pagination in search results. Thanks David Ray for report and fix.
v0.4.2 (Released 2012-06-08)¶
Bug Fixes¶
- Backported fix for double
autocompleteselect
event firing. - Backported fix for broken pagination in search results.
v0.5.0 (Released 2012-06-02)¶
Features¶
- Template tag to add necessary jQuery and jQuery UI libraries. Thanks to Rick Testore for the initial implementation
- Lookup decorators for requiring user authentication or staff access to use the lookup
- Additional documentation
- Minor updates to the example project
Backwards Incompatible Changes¶
- Previously the minimal version of jQuery was listed as 1.4.3 when it fact there was a bug a that made django-selectable require 1.4.4. Not a new incompatibility but the docs have now been updated and 1.4.3 compatibility will not be added. Thanks to Rick Testore for the report and the fix
- Started deprecation path for AutoComboboxSelectField and AutoComboboxSelectMultipleField
v0.4.1 (Released 2012-03-11)¶
Bug Fixes¶
- Cleaned up whitespace in css/js. Thanks Dan Poirier for the report and fix.
- Fixed issue with saving M2M field data with AutoCompleteSelectMultipleField. Thanks Raoul Thill for the report.
v0.4.0 (Released 2012-02-25)¶
Features¶
- Better compatibility with AutoCompleteSelectWidget/AutoComboboxSelectWidget and Django’s ModelChoiceField
- Better compatibility with the Django admin add another popup
- Easier passing of query parameters. See the Additional Parameters section
- Additional documentation
- QUnit tests for JS functionality
Backwards Incompatible Changes¶
- Support for
ModelLookup.search_field
string has been removed. You should use theModelLookup.search_fields
tuple instead.
v0.3.0 (Released 2012-02-15)¶
Features¶
- Multiple search fields for model based lookups
- Support for highlighting term matches
- Support for HTML in result labels
- Support for client side formatting
- Additional documentation
- Expanded examples in example project
Backwards Incompatible Changes¶
- The fix for #24 changed the remove items from a button to an anchor tag. If you were previously using the button tag for additional styling then you will need to adjust your styles.
- The static resources were moved into a selectable sub-directory. This makes the media more in line with the template directory conventions. If you are using the widgets in the admin there is nothing to change. If you are using
{{ form.media }}
then there is also nothing to change. However if you were including static media manually then you will need to adjust them to include the selectable prefix.
v0.2.0 (Released 2011-08-13)¶
Features¶
- Additional documentation
- Positional configuration for multiple select fields/widgets
- Settings/configuration for limiting/paginating result sets
- Compatibility and examples for Admin inlines
- JS updated for jQuery 1.6 compatibility
- JS hooks for updating query parameters
- Chained selection example
v0.1.1 (Release 2011-03-21)¶
Bug Fixes¶
- Fixed/cleaned up multiple select fields and widgets
- Added media definitions to widgets
Features¶
- Additional documentation
- Added update_query_parameters to widgets
- Refactored JS for easier configuration
v0.1 (Released 2011-03-13)¶
Initial public release