django-multiselectfield 0.1.7

Install with pip

$ pip install django-multiselectfield

Configure your models.py

from multiselectfield import MultiSelectField

# ...

MY_CHOICES = (('item_key1', 'Item title 1.1'),
              ('item_key2', 'Item title 1.2'),
              ('item_key3', 'Item title 1.3'),
              ('item_key4', 'Item title 1.4'),
              ('item_key5', 'Item title 1.5'))

MY_CHOICES2 = ((1, 'Item title 2.1'),
               (2, 'Item title 2.2'),
               (3, 'Item title 2.3'),
               (4, 'Item title 2.4'),
               (5, 'Item title 2.5'))

class MyModel(models.Model):

    # .....

    my_field = MultiSelectField(choices=MY_CHOICES)
    my_field2 = MultiSelectField(choices=MY_CHOICES2,
                                 max_choices=3,
                                 max_length=3)

In your settings.py

Only you need it, if you want the translation of django-multiselectfield

INSTALLED_APPS = (
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.sites',
    'django.contrib.admin',

    #.....................#

    'multiselectfield',
)

Customizing templates

It is possible to customize the HTML of this widget in your form template. To do so, you will need to loop through form.{field}.field.choices. Here is an example that displays the field label underneath/after the checkbox for a MultiSelectField called providers:

{% for value, text in form.providers.field.choices %}
  <div class="ui slider checkbox">
    <input id="id_providers_{{ forloop.counter0 }}" name="{{ form.providers.name }}" type="checkbox" value="{{ value }}"{% if value in checked_providers %} checked="checked"{% endif %}>
    <label>{{ text }}</label>
  </div>
{% endfor %}

Django REST Framework

Django REST Framework comes with a MultipleChoiceField that works perfectly with this:

from rest_framework import fields, serializers

from myapp.models import MY_CHOICES, MY_CHOICES2

class MyModelSerializer(serializers.HyperlinkedModelSerializer):
    # ...
    my_field = fields.MultipleChoiceField(choices=MY_CHOICES)
    my_field2 = fields.MultipleChoiceField(choices=MY_CHOICES2)
    # ...

0.1.6 (2017-05-10)

• Added support for Django 1.11

• Added support for Python 3.6

• Improved rendering in Django admin

• Improved documentation

• Thanks to:

  • atten

  • ixc

  • LeilaniAnn

0.1.5 (2017-01-02)

• Added support for Django 1.8-1.10

• Added support for named groups in choices

• Added support for min_choices argument

• Various fixes

• More tests

• Thanks to:

  • danilogbotelho

  • dmitry-krasilnikov

  • Kamil Dębowski

0.1.4 (2016-02-23)

• Fixed warning about SubfieldBase

• Added support for Django 1.8+

• Added support for named groups

• We now play nice with django-dynamic-fixture

• More tests

0.1.3 (2014-10-13)

• Support to Django 1.7 (I’m sorry to the delay)

• Adding get_FIELD_list function

• Fix an error when a MultiSelectField was reandonly at the admin site

• Thanks to:

  • Hernil

  • Vasyl Stanislavchuk

  • Litchfield

  • Chris-erickson

0.1.2 (2014-04-04)

• Include the spanish translations to the pypi egg

• Improvements in the readme file

• Windows OS compatibility

• Thanks to:

  • StillNewb

  • Diego Yungh

0.1.1 (2013-12-04)

• Move the multiselectfield app to parent folder

• Details

0.1.0 (2013-11-30)

• Test/example project

• Now works if the first composant of the list of tuple is an integer

• Now max_length is not required, the Multiselect field calculate it automatically.

• The max_choices attr can be a attr in the model field

• Refactor the code

• Spanish translations

• Support to python2.6

• Thanks to:

  • Daniele Procida

0.0.3 (2013-09-11)

• Python 3 compatible

• Fix an error, the snippet had another error when the choices were translatables

• Improvements in the README file

0.0.2 (2012-09-28)

• Fix an error, the snippet had an error.

0.0.1 (2012-09-27)

• Initial version from the next snippet