Posts tagged usability
… how to make usable drop-downs with Django CMS pages
Problem: some times when you create custom applications or plugins for Django CMS you need a property that connects the current item to a page in the CMS. Nothing simple than this – you just add a ForeignKey in your model that points to the Page model and everything is (almost)fine. Example:
from cms.models import Page class MyModel(models.Model): # some model attributes here page = models.ForeignKey(Page)
If you registered your model in Django admin or just add a model form to it you will see something like this:
Cool right? Not exactly. The problem is that these pages are in hierarchical structure and listing them in a flat list may be/is little confusing. So let’s indent them accordingly to their level in the hierarchy.
Solution: The easies way to achieve this indentation is to overwrite the choices list of the ForeignKey field in the ModelForm __init__ method.
class MyModelForm(forms.ModelForm): class Meta: model = MyModel def __init__(self, *args, **kwargs): super(MyModelForm, self).__init__(*args, **kwargs) choices = [self.fields['page'].choices.__iter__().next()] for page in self.fields['page'].queryset: choices.append( (page.id, ''.join(['-'*page.level, page.__unicode__()])) ) self.fields['page'].choices = choices
The magic lies between lines 7 and 11, on line 7 we create a list with one element the default empty option for the drop down. The need to use “__iter__().next()” comes from the fact that the choices attribute of the fields is django.forms.models.ModelChoiceIterator object which is iterable, but not indexable i.e. you can not just use self.fields['url'].choices.
After we had the empty choice now it is time to add the real ones, so we iterate over the queryset(8th line) that holds them and for each item we add a tuple to our choices list(10). The first item of the tuple is the page id – nothing special, but the second one… here the python magic comes. We multiple the minus sign(‘-’) by the page level and join the result with the page title. The only thing left is to replace the field choices(line 12) and here is the result:
Final words: For me this is much more usable than the flat list. Of course you can modify the queryset to return only published pages or filter the results in other way and still use the identation code from above.
I’ll be happy to hear your thoughts on this.