django-selectable-select2 0.1.4

Installation and usage

• install django-selectable (you can ommit the part regarding jquery-ui)

• add selectable_select2 to INSTALLED_APPS. So it look like this:

  INSTALLED_APPS = (
      ...
      'selectable',
      'selectable_select2',
      ...
  )

• define your lookup class

• in your forms you can use selectable_select2.widgets.AutoCompleteSelect2Widget like so:

  from selectable_select2.widgets import AutoCompleteSelect2Widget
  from django import forms
  
  from myapp.models import MyModel  # example model with a ForeignKey called ``myfk``
  from myapp.lookups import MyModelLookup  # the lookup defined in previous step
  
  class MyModelForm(forms.ModelForm):
  
      class Meta:
          model = MyModel
          widgets = {
              'myfk' : AutoCompleteSelect2Widget(MyModelLookup, placeholder='select related item')
          }

Check the example project for more details.

TODO

check out TODO.rst

A note about my version of select2.js

In my version of select2.js I’ve added an option that allows to not escape the markup. Basically it adds one option to the defaults called ‘doEscapeMarkup’. Everything else should be working fine though. If you want to use this version do it like this:

<script src="{{ STATIC_URL }}selectable_select2/js/select2.min.js"></script>

See https://github.com/ivaynberg/select2/pull/355 for details.