Hopiu/django-select2
1
0
Fork 0
mirror of https://github.com/Hopiu/django-select2.git synced 2026-04-05 22:50:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
This is a Django integration for Select2
242 commits 3 branches 55 tags 8.1 MiB
Python 96.9%
JavaScript 2.4%
HTML 0.7%
Find a file
Razi Alsayyed b576bcdd9e Made widget media a dynamic property 
Symptoms:
While using AutoModelSelect2Field in admin site, I noticed that css files are rendered only at the first request to the add or edit forms, after that the widget is rendered but without loading any css files from get_select2_css_libs.

Solution:
I changed assets loading from Assets as a static definition to Media as a dynamic property as described at Django docs:
https://docs.djangoproject.com/en/1.8/topics/forms/media/#media-as-a-dynamic-property

Closed #179

Squashed commit of the following:

commit f925ed4a118687b82b6f61d21a9104ccf00859c8
Author: Razi Alsayyed <razi.sayed@gmail.com>
Date:   Fri Jun 19 01:39:47 2015 +0300

    remove trailing whitespace from docstrings

commit b3f6553e422e19c8e065e026511c4ffd91ffee42
Author: Razi Alsayyed <razi.sayed@gmail.com>
Date:   Fri Jun 19 01:35:15 2015 +0300

    Remove blank lines from docstrings

commit 4490b78572a25069472933c88ebee48445b59972
Author: Razi Alsayyed <razi.sayed@gmail.com>
Date:   Fri Jun 19 01:19:38 2015 +0300

    construct Media the right way

    Remove code that access private attributes of Media class.

commit 6697cd734daca62ff099be73d0685ce6af32e53d
Author: Razi Alsayyed <razi.sayed@gmail.com>
Date:   Tue Jun 16 00:11:29 2015 +0300

    fix

    change _media to _get_media

    I hope it is the final commit :)

commit 59bda01aed44e5658825a1bfe37ad09c5760a3ad
Author: Razi Alsayyed <razi.sayed@gmail.com>
Date:   Tue Jun 16 00:09:35 2015 +0300

    get_select2_heavy_js_libs

    change get_select2_js_libs to get_select2_heavy_js_libs

commit 993e201355c9d5a6012e6f67cfa64462576c2570
Author: Razi Alsayyed <razi.sayed@gmail.com>
Date:   Tue Jun 16 00:07:57 2015 +0300

    fix

    fix

commit f66e5f40b9f4df295bc5aaa7f2aafe588b2c41bb
Author: Razi Alsayyed <razi.sayed@gmail.com>
Date:   Mon Jun 15 23:55:53 2015 +0300

    fix

    fix

commit d33d90278345bc32e80e20bdf782fd9ac5eb1800
Author: Razi Alsayyed <razi.sayed@gmail.com>
Date:   Mon Jun 15 23:47:25 2015 +0300

    fix

    fix

commit f6d956149d2e99ee504c7b2c110f959f7472a181
Author: Razi Alsayyed <razi.sayed@gmail.com>
Date:   Mon Jun 15 23:45:09 2015 +0300

    fix

    fix

commit 6d737a78cc07507c5b9b91736f6662b5f6f31c57
Author: Razi Alsayyed <razi.sayed@gmail.com>
Date:   Mon Jun 15 23:40:01 2015 +0300

    global name 'Media' is not defined

    global name 'Media' is not defined

commit 661a817b092dc72bfa8df1a5458d474599c0a50e
Author: Razi Alsayyed <razi.sayed@gmail.com>
Date:   Mon Jun 15 23:27:27 2015 +0300

    Media as a dynamic property

    **Symptoms:**
    While using AutoModelSelect2Field in admin site, I noticed that css files are rendered only at the first request to the add or edit forms, after that the widget is rendered but without loading any css files from get_select2_css_libs.

    **Solution:**
    I changed assets loading from [Assets as a static definition](https://docs.djangoproject.com/en/1.8/topics/forms/media/#media-as-a-dynamic-property) to [Media as a dynamic property](https://docs.djangoproject.com/en/1.8/topics/forms/media/#media-as-a-dynamic-property) as described at Django docs.
2015-06-19 14:49:51 +02:00
django_select2 Made widget media a dynamic property 2015-06-19 14:49:51 +02:00
docs update capitalization of proper nouns 2013-11-19 19:09:19 -06:00
testapp Fix "No reverse match" issue with template. 2015-04-13 18:45:25 +02:00
tests Added failing test for HeavySelect2MultipleWidget 2015-06-01 10:21:01 +01:00
.gitignore Added initial tests 2015-03-29 22:32:19 +02:00
.travis.yml Changed travis tests to supported versions 2015-06-17 17:06:20 +02:00
Internal_Notes.md Fixing setup.py and releasing 4.3.0. 2015-04-27 22:19:15 +05:30
LICENSE.txt v3.1.5 2012-12-18 09:54:55 +05:30
MANIFEST.in Fixing setup.py and releasing 4.3.0. 2015-04-27 22:19:15 +05:30
pytest.ini Added six types and fixed setup 2015-03-31 10:22:03 +02:00
README Version 4.3.1 2015-04-29 01:14:11 +05:30
README.md Version 4.3.1 2015-04-29 01:14:11 +05:30
requirements_dev.txt Added six types and fixed setup 2015-03-31 10:22:03 +02:00
runtests.py Added initial tests 2015-03-29 22:32:19 +02:00
setup.py Fixed bug in minify pre-setup function 2015-04-28 17:35:55 +03:00
UK_Advanced_Cryptics_Dictionary_Licensing_Information.txt v3.1.3 released. 2012-11-26 23:17:15 +05:30

README.md

Django-Select2 Build Status

This is a Django integration of Select2.

The app includes Select2 driven Django Widgets and Form Fields.

Installation

  1. Install django_select2

     pip install django_select2

  2. Add django_select2 to your INSTALLED_APPS in your project settings.

  3. When deploying on production server, run :-

     python manage.py collectstatic

  4. Add django_select to your urlconf if you use any 'Auto' fields.

     url(r'^select2/', include('django_select2.urls')),

Documentation

Documentation available at http://django-select2.readthedocs.org/.

More details

More details can be found on my blog at - http://blog.applegrew.com/2012/08/django-select2/.

External Dependencies

  • Django - This is obvious.
  • jQuery - This is not included in the package since it is expected that in most scenarios this would already be available.
  • Memcached (python-memcached) - If you plan on running multiple python processes with GENERATE_RANDOM_SELECT2_ID enabled, then you need to turn on ENABLE_SELECT2_MULTI_PROCESS_SUPPORT. In that mode it is highly recommended that you use Memcached, to minimize DB hits.

Example Application

Please see testapp application. This application is used to manually test the functionalities of this package. This also serves as a good example.

You need only Django 1.4 or above to run that. It might run on older versions but that is not tested.

Special Thanks

  • Samuel Goldszmidt (@ouhouhsami) for reporting many fundamental issues with the code, because of which versions 2.0 and 2.0.1 were released.

Official Contributors

  • Johannes Hoppe (@codingjoe)

Changelog Summary

v4.3.1

  • Build failure fix.

v4.3.0

  • Now the package supports both Python2 and Python3.
  • Django 1.8 support added.
  • Many bug fixes.

v4.2.2

  • Misc fixes and enhancements - 61, 64.

v4.2.1

  • Finally fixed performance issue#54 (and issue#41) in widgets when backing field is based on models and the field has an initial value.

v4.2.0

v4.1.0

  • Updated Select2 to version 3.4.1. Please note, that if you need any of the Select2 locale files, then you need to download them yourself from http://ivaynberg.github.com/select2/ and add to your project.
  • Address isssue#36 - Fix importerror under django1.6.
  • Fixed the way setup.py handles Unicode files while minifying them during package build.
  • Address isssue#39 - MultipleSelect2HiddenInput.render() should use mark_safe().
  • Address isssue#45 - MultipleSelect2HiddenInput returns bad has_changed value.

v4.0.0

  • Main version number bumped to bring your attention to the fact that the default Id generation scheme has now changed. Now Django Select2 will use hashed paths of fields to generate their Ids. The old scheme of generating random Ids are still there. You can enable that by setting GENERATE_RANDOM_SELECT2_ID to True.

v3.3.1

  • Addressed issue#30.
  • Merged pull request#31.
  • Added light parameter to import_django_select2_js, import_django_select2_css and import_django_select2_js_css template tags. Please see doc's "Getting Started", for more details.

v3.3.0

  • Updated Select2 to version 3.3.1.
  • Added multi-process support. (Issue#28).
  • Addressed issue#26.
  • Addressed issue#24.
  • Addressed issue#23.
  • Addressed some typos.

v3.2.0

  • Fixed issue#20. Infact while fixing that I realised that heavy components do not need the help of cookies, infact due to a logic error in previous code the cookies were not being used anyway. Now Django Select2 does not use cookies etc.
  • Few more bugs fixed in heav_data.js.
  • Now production code will use minimized versions of js and css files.
  • Codes added in setup.py to automate the task of minimizing js and css files, using a web service.

v3.1.5

  • Merged pull request (issue#17). Which allows the user to pass some extra data to Select2 clients-side component.
  • Updated License. The previous one was inadequently worded. Now this project use Apache 2.0 license.

v3.1.4

  • Manually merged changes from pull request (issue#16).
  • Django Select2 widgets now allow passing of any Select2 Js options. Previously it used to allow only white-listed options. Now it will block only black-listed options. For example, Light Select2 widgets won't allow you to set multiple option, since it is an error to set them when Select2 Js is bound to <select> fields.

v3.1.3

  • Addressed enhancement issue#12.
  • Addressed enhancement issue#11.
  • Addressed performance issue#8.

v3.1.2

  • Fixed issue#7.

v3.1.1

  • Bumping up minor version since Select2 JS has been updated to version 3.2. It seems Select2 JS now includes new higher resolution icons for Retina displays.
  • Fixed an issue in setup.py because of which templatetags directory was not included in last PIP releases' tar file.

v3.0.2

  • Added AUTO_RENDER_SELECT2_STATICS settings. This, when specified and set to False in settings.py then Django_Select2 widgets won't automatically include the required scripts and stylesheets. When this setting is True (default) then every Select2 field on the page will output <script> and <link> tags to include the required JS and CSS files. This is convinient but will output the same JS and CSS files multiple times if there are more than one Select2 fields on the page.
  • Added django_select2_tags template tags to manually include the required JS and CSS files, when AUTO_RENDER_SELECT2_STATICS is turned off.

v3.0.1

  • Revised the design of heavy fields. The previous design didn't quite make it easy to back heavy fields by big data sources. See fields.HeavyChoiceField class and its methods' docs for more info.
  • Updated docs.
  • Some more fixes for issue#4.
  • Updated Select2 JS to version 3.1.

v3.0

  • Added docs.
  • Some bug fixes. See issue#4.
  • widgets.Select2Mixin.__init__ now accepts select2_options kwarg to override its options settings. Previously attrs were being used for this too. This means backward compatibility has been broken here. attrs will no longer override options values. The major release version has been changed to 3, because of this backward incompatible change.

v2.0.1

  • Auto id registration fixes.

v2.0

  • Mostly major bug fixes in code and design. The changes were many, raising the possibility of backward incompatibility. However, the backward incompatibility would be subtle.

  • Auto fields (sub-classes of AutoViewFieldMixin) now accepts auto_id parameter. This can be used to provide custom id for the field. The default is 'module.field_class_name'. Ideally only the first instance of an auto field is registered. This parameter can be used to force registration of additional instances by passing a unique value.

License

Copyright 2012 Nirupam Biswas

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this project except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.