How do I bind a checkbox to a boolean in Play! framework

Question

An app I\'m working on using the Play! Framework has an object called gift with a boolean property, called Taken. How do I show the state of this value as a checkbox on my view

Answer 1

The accepted answer is actually not 100% correct as it doesn't handle the "unchecked" case. To handle both cases you need a hidden field:

Note that the placement seems to be important, so the hidden field must be after the checkbox.

Writing a custom template tag for this, makes it easy not to forget the hidden input (put this into views/tags/checkbox.html):

Then call this template like this:

#{checkbox id:'gift_Taken', name: 'gift.Taken', checked: gift.Taken /}

See also the related discussion on the play framework list: https://groups.google.com/forum/?fromgroups=#!topic/play-framework/HygQuYF3a8E