A Django widget with [Select2](http://ivaynberg.github.com/select2/) integration.
JavaScript HTML CSS Python
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
select2
.gitignore
LICENSE
MANIFEST.in
README.md
__init__.py
fabfile.py
setup.py

README.md

twentytab-select2

A Django widget with Select2 integration.

Installation

Use the following command: pip install twentytab-select2

Configuration

  • Settings.py

Open settings.py and add select2 to your INSTALLED_APPS:

INSTALLED_APPS = {
    ...,
    'select2',
    ...
}

twentytab-select2 will set his own jquery plugin. If you already use yours you have to define the following parameters in your settings:

STATIC_URL = u'/static/'
JQUERY_LIB = 'path_to_jquery'
SELECT2_LIB = 'path_to_select2_js'
SELECT2_CSS_LIB = 'path_to_select2_css'
  • Static files

Run collectstatic command or map static directory.

Usage

  • forms.py
from testapp.models import ModelTest
from django import forms
from select2.widgets import SelectAutocomplete, SelectMultipleAutocomplete


class TestForm(forms.ModelForm):
    class Meta:
        model = ModelTest
        widgets = {
            'myfield': SelectAutocomplete(),
            'mymultiplefield': SelectMultipleAutocomplete(),
        }

Both widgets take a parameter called "plugin_options". It's a dictionary and it can take all select2 options.