list_display - boolean icons for methods

Question

When defining the list_display array for a ModelAdmin class, if a BooleanField or NullBooleanField is given the UI will use nice looking icons instead of True/False text in the column. If a method that returns a boolean is given, however, it simply prints out True/False.

Is there a way to make it use the pretty icons for a boolean method?

score 280 · Accepted Answer · edited Aug 17 '16 at 15:01

280

This is documented, although it's a bit hard to find - go a couple of screens down from here, and you'll find this:

If the string given is a method of the model, ModelAdmin or a callable that returns True or False Django will display a pretty "on" or "off" icon if you give the method a boolean attribute whose value is True.

and the example given is:

def born_in_fifties(self):
    return self.birthday.strftime('%Y')[:3] == '195'
born_in_fifties.boolean = True

edited Aug 17 '16 at 15:01

maciek

3,198
2
26
33

answered Nov 22 '11 at 12:47

Daniel Roseman

588,541
66
880
895

14

Any idea how to do it when you use the @property decorator?: "AttributeError: 'property' object has no attribute 'boolean'" – Kye Mar 19 '15 at 08:27
4

@Kye http://stackoverflow.com/questions/12842095/how-to-display-a-boolean-property-in-the-django-admin – Jason McClellan Apr 02 '15 at 16:52
1

Do not forget that this only works if the method is not static! – therealak12 Dec 24 '20 at 11:19

score 21 · Answer 2 · edited Apr 22 '21 at 05:57

Thanks to @daniel-roseman (rtfm)
Since Django 3.2 there is a decorator @admin.display(boolean=True):

If the string (in list_display) given is a method of the model, ModelAdmin or a callable that returns True, False, or None, Django will display a pretty “yes”, “no”, or “unknown” icon if you wrap the method with the display() decorator passing the boolean argument with the value set to True:

class Person(models.Model):
    birthday = models.DateField()

    @admin.display(boolean=True)
    def born_in_fifties(self):
        return 1950 <= self.birthday.year < 1960

score 2 · Answer 3 · answered Dec 10 '21 at 23:32

I got this to work for me (Django 3.1.10)

class MyAdmin(MyModel):
    list_display = ("field_as_boolean", )
    
    def field_as_boolean(self, obj):
        return True if obj.field else False
    field_as_boolean.boolean = True
    field_as_boolean.short_description = "field_name"

list_display - boolean icons for methods

3 Answers3

Linked