boolean_favorite
The clickable star on products, journals and applicants. The boolean_favorite widget looks like a toggle and behaves like a save button, which is exactly what teams need to know before adopting it.
| Technical name | boolean_favorite |
|---|---|
| Field types | boolean |
| Views | form, list, kanban |
| Module | web, present in every Odoo database |
| Used in core | 14 occurrences across 6 modules, including product, hr_recruitment, account, stock, repair, mrp |
| Versions | Odoo 20.0, Odoo 19.0, Odoo 18.0 |
| No-code setup | No. Studio's Checkbox widgets are Button and Toggle; the star requires widget="boolean_favorite" in XML. |
| Alternatives | boolean_toggle, boolean, priority |
What the Favorite star does
What this means for your team
Supported options in Odoo 19
| Option | Type | What it does |
|---|---|---|
autosave | boolean | When true, the default, clicking the star saves the entire record immediately, pending edits and validations included. Set false to make the toggle an ordinary edit that waits for the Save button. Removed on the Odoo 20 development branch.(default: true) |
The autosave default is true, and it saves the record, not the field. A click calls the record update with save enabled, committing every pending edit on the form along with the star. On a form where users star mid-edit, that can save half-finished work. Set options="{'autosave': False}" to make the star a normal dirty-field edit that waits for the Save button.
Working examples
Readonly, empties and what the click really saves
Version compatibility
| Version | Status | Notes |
|---|---|---|
| Odoo 20.0 | In development | Not released. The development branch removes autosave and switches icon sets. Details below. |
| Odoo 19.0 | Verified | Verified against the shipped source. Autosave defaults to true. |
| Odoo 18.0 | Verified | Byte identical source file to 19.0. Same option, same default. |
Upgrade note for 18 to 19. Nothing to do: the 18.0 and 19.0 source files are byte for byte identical, options and defaults included. Views and muscle memory carry over unchanged.
What is changing in Odoo 20
Common problems and fixes
| Symptom | Cause and fix |
|---|---|
| Clicking the star saved my half-finished form edits | Autosave defaults to true and commits the whole record, not just the star. Set options autosave to False on that form's field. |
| A validation error pops up when starring a record | The instant save runs full record validation, and a required field is empty. Complete the required fields, or disable autosave so starring waits for Save. |
| The star does not react to clicks | The field is readonly on this record, and the widget ignores clicks silently by design. Check the readonly modifier or field definition. |
| Stars show for everyone, not per user | The widget toggles a plain shared boolean; per-user behavior needs a computed field over a user relation. Model the favorite as a many2many of users with a computed boolean, as core does. |
| Empty cells expected in the list, but outlined stars render everywhere | The widget hardcodes isEmpty to false so the clickable star always shows. Expected behavior; hide the column conditionally if stars should not appear. |
| Starring on kanban cards stops instant-saving after a future upgrade | The Odoo 20 branch removes the autosave mechanism. Retest star flows during the upgrade and adjust training. |
Favorite star vs the alternatives
| Widget | Best for | Key difference |
|---|---|---|
boolean_favorite | One-click personal or team flags | Star iconography with instant record save by default |
| boolean_toggle | On and off settings users flip in place | Switch styling, same whole-record autosave behavior |
boolean | Plain data entry checkboxes | Standard checkbox, no instant save, no iconography |
| priority | Graded importance instead of a yes or no flag | Multiple stars backed by a selection field |
Frequently asked questions
What does the boolean_favorite widget do in Odoo?+
Does clicking the favorite star save the record?+
Can I add the favorite star from Odoo Studio?+
Why is the star not clickable on some records?+
How do I make favorites personal to each user?+
Is boolean_favorite different in Odoo 16, 17 or 18?+
What happens to boolean_favorite in Odoo 20?+
Little widgets, big workflow consequences
An instant-saving star sounds trivial until it commits half-entered invoices or becomes a shadow status field. We review how your teams actually use Odoo's small interactions, then tune views, defaults and training so the UI nudges people toward clean data instead of surprises.
Book a free consultation