Iterating over checkboxes in CheckboxSelectMultiple should be possible

[Malcolm Tredinnick]

Right now, if you have a form field that is using the CheckboxSelectMultiple widget, there's no way in a template (or even in Python code) to iterate over the constituent pieces. This is a missing feature, since it prevents designers or designer-targeted template tags from working with the "bits".

This is a feature-add, not a piece of broken functionality, so it's only for trunk.

[Matthijs]

Please have a look at: ​http://www.zoia.org/blog/2007/03/24/iterating-over-items-of-selection-fields-in-django-templates-using-newforms/
This solution works for me.

[Eric Holscher]

I trust malcolm and ben know what they're talking about. Setting to accepted :)

[Rob Hudson <treborhudson@…>]

I just hit a use-case where this would be nice, so a +1 as a feature request from me. The workaround posted wasn't helpful... I want to customize the display of the label tag given the choices object, so it's not the default __unicode__ output, but something else.

[lbolognini]

This would be a nice to have feature: right now i wanted to display an image next to each checkbox part of this widget.

[BradMcGonigle]

I also just ran into a use-case for this so another +1.

[DataGreed]

+1
I cannot design nrmally a nice Two-Column list of checkboxes

[Reto Aebersold]

I wrote a small patch to solve this problem. Needless to say that we have to update all the 'choice' widgets the provide a solid solution.
This is a minimal solution intended as a basis for discussion.
An iteratable widget could look like this:

class MyCheckboxSelectMultiple(CheckboxSelectMultiple):
    
    def get_iterator(self, name, value, attrs):
        """
        Alternatively we could pre-render here all the choices and store them in a list. 
        """
        self.item = 0
        self.name = name
        self.attrs = attrs
        if value is None: value = []
        self.value = value        
        self.str_values = set([force_unicode(v) for v in value])
        self.has_id = attrs and 'id' in attrs
        self.final_attrs = self.build_attrs(attrs, name=name)        
        return self
    
    def next(self):
        
        if self.item >= len(self.choices):
            raise StopIteration
        
        if self.has_id:
                final_attrs = dict(self.final_attrs, id='%s_%s' % (self.attrs['id'], self.item))
                label_for = u' for="%s"' % final_attrs['id']
        else:
            label_for = ''
        
        (option_value, option_label) = self.choices[self.item]
        cb = CheckboxInput(final_attrs, check_test=lambda value: value in self.str_values)
        option_value = force_unicode(option_value)
        rendered_cb = cb.render(self.name, option_value)
        option_label = conditional_escape(force_unicode(option_label))
        
        self.item += 1
        return mark_safe(u'<label%s>%s %s</label>' % (label_for, rendered_cb, option_label))

[Reto Aebersold]

Iterating over choice widgets

[skylar.saveland@…]

this comes up all the time for me. I use this nasty widget that I made: ​http://skyl.org/log/post/skyl/2011/01/wherein-the-inner-workings-of-the-deathstarwidget-are-revealed/

[Skylar Saveland]

I have been told that this works: ​http://djangosnippets.org/snippets/2159/

[Baptiste Mispelon]

Unless I'm mistaken, this is a duplicate of #4592.

[Gerben Morsink]

This is my first post here, so sorry if I'm doing it wrong.

I'm trying to iterate over my checkboxes (using Django 1.7.7) where I'm using an ModelFormSet to generate multiple forms.

My original code is:

{%if field.name == "repeat_weekday" %}
     <td>{{field}}<td>
 {% endif %}

Now I have made:

{% for choice, choice_label in field.field.widget.choices %}
                        <td> <input checked={{choice.checked}} id="id_form-0-repeat_weekday_0" name="form-0-repeat_weekday" type="checkbox" value="{{ choice }}"> {{choice_label}} </td>
                    {% endfor %} 

but I don't know how to find the = checked and id and name via the field.

Easier would IMO be to do something like the thing below (and I would say that would be a genuine fix of the issue in this ticket):

{% for checkbox, label in field.checkboxes %}
{{ checkbox }}   <!-- Renders the checkbox completely
{{ label }} <!-- Renders the label completely
{% endfor %}

Ok, found the documentation: ​https://docs.djangoproject.com/en/1.7/ref/forms/widgets/#django.forms.RadioSelect

However, if I update my template to:

            {% for field in form.visible_fields %}

                {% for checkbox in field.repeat_weekday %}
                   <td>{ {field} }<td>

                {% endfor%}

            {% endfor %}

It still does not work.

[Gerben Morsink]

I have checked the documentation a 100 times, but for me it does not work as expected.

The {{field.repeat_weekday}} is always empty in my template, so looping over it wont work to create the checkboxes.

I have overriden the render method in my widget, but that should not matter I think since I only change the value and then call the original render:

class BinaryMultipleSelectBox(forms.CheckboxSelectMultiple):
    def render(self, name, value, attrs=None, choices=()):
        if value is None:
            value = []
        else:
            value = TemplateEventMeta.WEEKDAYS.get_selected_values(value)
        return forms.CheckboxSelectMultiple.render(self, name, value, attrs=attrs, choices=choices)

[Baptiste Mispelon]

Hi,

The best place to go for questions like these would rather be the django-users mailing list: ​https://groups.google.com/forum/#!forum/django-users.

Thanks.

[Claude Paroz <claude@…>]

In 97e1160:

Refs #9230 -- Added complementary tests for widget iterations