boolean_icon
A boolean drawn as a single icon rather than a checkbox or a switch. One option changes the glyph, and the label comes from the field's own string.
August 27, 2026Updated August 27, 20265 min read
| Technical name | boolean_icon |
|---|---|
| Field types | boolean |
| Views | form, list, kanban |
| Module | web, present in every Odoo database |
| Used in core | Used where a boolean reads better as a symbol than as a control |
| Versions | Odoo 20.0, Odoo 19.0, Odoo 18.0, Odoo 17.0 |
| No-code setup | No. Studio offers a checkbox or a toggle; this variant is set in view XML |
| Alternatives | boolean, boolean_toggle, boolean_favorite, task_done_checkmark |
What the boolean icon field does
What this means for your team
Supported options in Odoo 19
| Option | Type | What it does |
|---|---|---|
icon | string | The icon class rendered for the field. Passed straight through to the template, so any glyph the interface supports works.(default: a checked-square glyph)(since Odoo 17.0) |
string | string (attribute) | Not an option but the source of the label. The extractor takes the field's string, so the standard attribute controls the text beside the icon.(since Odoo 17.0) |
There is no autosave option here. Unlike the toggle widget, this one simply updates the record and leaves saving to the form, so on a list it behaves like any other editable cell rather than committing on click.
Working examples
Where the label actually comes from
Version compatibility
| Version | Status | Notes |
|---|---|---|
| Odoo 20.0 | In development | Not released. The icon convention is updated on the development branch. |
| Odoo 19.0 | Verified | Verified against the shipped source. Identical to Odoo 18. |
| Odoo 18.0 | Verified | Identical behavior. |
| Odoo 17.0 | Verified | First version. |
| Odoo 16.0 | Not available | Widget does not exist. |
Upgrade note. The widget arrived in Odoo 17 and the Odoo 18 and Odoo 19 files are identical, so views carry over unchanged. It does not exist in Odoo 16, where the same effect required a custom widget.
What is changing in Odoo 20
Common problems and fixes
| Symptom | Cause and fix |
|---|---|
| No label appears | The field has no string in the view and no label to fall back on. Set the string attribute on the field. |
| The icon does not change | The option name or the icon class is wrong. Check the spelling of the option and use an icon class the interface actually ships. |
| Clicking does not save | This widget has no autosave; it updates the record and leaves saving to the form. Save the form, or use the toggle widget with its autosave option. |
| It looks the same read-only | There is no separate read-only rendering. Use an invisible expression if the field should be hidden rather than shown inert. |
| It will not attach to my field | The declared supported type is boolean only. Point it at a boolean field. |
| The icon looks wrong after upgrading | The icon convention changes in the next version. Update the icon option to the newer set. |
Boolean icon field vs the alternatives
| Widget | Best for | Key difference |
|---|---|---|
boolean_icon | Booleans that describe a record rather than configure it | A single clickable icon with the field's own label, and no autosave |
| boolean | Values the user ticks | A checkbox, which reads as a form control |
| boolean_toggle | Settings that are on or off | A switch, with an autosave option |
| boolean_favorite | Marking a record as a favorite | A star with fixed labels and immediate saving |
task_done_checkmark | Completion flags in Project | Saves immediately in lists and kanbans |
Frequently asked questions
How do I change the icon?+
Where does the label come from?+
Does clicking save the record?+
When should I use it over a checkbox?+
Which versions have it?+
Screens that show state without looking like a form
Icons, badges and color are how a dense list stays readable, and the choice differs per screen. We tune Odoo interfaces around what your team scans for, on versions 16 through 19.
Book a free consultation