[IMP] web, project: Add topbar actions #158441

luve-odoo · 2024-03-20T16:32:16Z

This update introduces the implementation of topbar actions, enabling
the addition of a topbar in the control panel for seamless toggling
among various actions.

Functionnal specifications:

This task aims to centralize and access models related to the current
parent model.
We introduce the concept of topbar action. If a model has topbar
actions, then a button with an 'eye' icon is displayed in the control
panel.
When the user clicks the button, the topbar appears.
The top bar consists of the various topbar actions chosen as visible
by the user. By default, the topbar only displays the current action
(or the first available).
There is a dropdown button to the right of the topbar that displays
all the actions available to the user. These actions depend on the model
, but it's also possible that there is a domain on these actions making
them invisible. For example, a project without the 'allow timesheets'
option will not display the 'Timesheets' action.
The default actions cannot be deleted by the user; they can only
decide whether to display them or not. The visibility of actions is
different for each model but also for each model ID, meaning, for
example, that the actions visible in one project will not be the same
for another.
Each user can also save the current view and thus create a new topbar
action. They can decide to share this topbar action so that it is
visible to everyone, or not. The view type and filters are saved when
creating a new topbar action. Those saved filters are saved as favorites
filters that cannot be deleted while the topbar action exists.
If the user has the rights, they can also drag and drop the actions to
reorder them. This order will be the same for everyone, and if the
concerned actions are default actions, the order will also be common to
all records of the concerned model.
On Mobile, only a dropdown is displayed with the current action. When
the dropdown is unfolded, all available actions are displayed. It is
not possible to drag and drop. Deleting is always available, as well as
the creation of new actions.
The breadcrumbs should never push new items. When navigating between
topbar actions, the breadcrumbs should be replaced.

In order to create a new default topbar action for a model, the
developer has to create an xml record of that structure:

<record id="<id>" model="ir.actions.topbar">
    <field name="res_model"><parent_res_model></field>
    <field name="parent_action_id" ref="<xml_id_parent_action>"/>

    <!--
        for the triggered action, the developer can either choose
        between a xml action id or a python action
    -->
    <field name="action_id" ref=<triggered_action_id>/>
    <field name="python_action"><python_action></field>

    <!-- name is optionnal if the an action_id is declared -->
    <field name="name"><name_of_the_topbar_action></field>

    <!-- optionnal -->
    <field name="sequence"><sequence_order_integer></field>
    <field name="domain"><domain_to_filter_topbar_actions></field>
    <field name="context"><additional_context_keys></field>
    <field name="default_view_mode"><default_view></field>
</record>

taskid:3750721

I confirm I have signed the CLA and read the PR guidelines at www.odoo.com/submit-pr

robodoo · 2024-03-20T16:34:37Z

Pull request status dashboard.

auon-odoo

Very nice work, thanks a lot! 🔥 🔥

addons/web/static/src/search/control_panel/control_panel.scss

addons/web/static/src/search/control_panel/control_panel.js

odoo/addons/base/models/ir_topbar_actions.py

addons/web/static/src/search/search_bar_menu/search_bar_menu.js

addons/web/static/src/search/control_panel/control_panel.js

auon-odoo

We're getting there 🔥

auon-odoo · 2024-03-28T07:29:51Z

addons/web/static/src/search/control_panel/control_panel.js

+                showTopBar: !!this.env.config.fromParentAction,
+                topBarActions: this.env.config.topBarActions,
+                newActionIsShared: false,
+                newActionName: `${this.currentTopBarAction?.name} Custom`,


this.currentTopBarAction can't be undefined, can it?
But looks like .name could be, in which case we would have undefined Custom.
I think we should do ${this.currentTopBarAction.name || <find the name of the model> || 'Action'} Custom,
or something like that. Am I missing something?

Ignore my first line 🙈

Indeed, this.currentTopBarAction can be undefined when the component is mounted, you can try, and I agree that we should put a fallback default name I case of no currentTopBarAction. I would go for directly putting "Action" and not try to find the name of the model, which could sometimes be undeterministic and pprovide strange results.

addons/web/static/src/search/control_panel/control_panel.js

auon-odoo · 2024-03-28T08:07:40Z

addons/web/static/src/webclient/actions/action_service.js

+        const topBarActions =
+            view.type === "form" ? [] : context.parentActionChildren || action.children_ids;
+        const fromParentAction = (view.type !== "form" && context.fromParentAction) || false;
+        const parentActionId = topBarActions?.[0]?.parent_action_id[0];


Can topBarActions be undefined?

yes, if there is no parentActionChildren or children_ids in the context, which is happening when no topbar_actions is defined

auon-odoo · 2024-03-28T08:08:14Z

odoo/addons/base/models/ir_filters.py

@@ -25,6 +25,7 @@ class IrFilters(models.Model):
                                     "When left empty the filter applies to all menus "
                                     "for this model.")
    active = fields.Boolean(default=True)
+    topbar_action_id = fields.Many2one('ir.actions.topbar', string="The topbar action this filter is applied to", ondelete="cascade")


odoo/addons/base/models/ir_topbar_actions.py

auon-odoo · 2024-03-28T08:13:50Z

odoo/addons/base/models/ir_topbar_actions.py

+            if "action_id" in vals and isinstance(vals["action_id"], list):
+                vals["action_id"] = vals["action_id"][0]
+            if "parent_action_id" in vals and isinstance(vals["parent_action_id"], list):
+                vals["parent_action_id"] = vals["parent_action_id"][0]


I guess the call is in your code. Can't we change it?
What is usually the value of a many2one in the vals of a create?

odoo/addons/base/models/ir_topbar_actions.py

luve-odoo · 2024-03-28T09:47:23Z

addons/web/static/src/search/control_panel/control_panel.js

+        const { action_id, parent_action_id } = currentTopBarAction;
+        const values = {
+            ...currentTopBarAction,
+            parent_action_id: parent_action_id[0],
+            action_id: action_id[0],


@auon-odoo follow-up to my previous comment that is saying where I added lines to delete the crappy logic in the python model file.

Well now that I delete the lines, the response to the comment does not appear :/ the "crappy logic" reference to the logic in the override of the create method in the model ir.actions.topbar_actions

luve-odoo · 2024-03-28T09:47:39Z

addons/web/static/src/search/control_panel/control_panel.js

+        const enrichedNewTopBarAction = {
+            ...values,
+            parent_action_id,
+            action_id,
+            id: topBarActionId,
+        };


@auon-odoo And here also

auon-odoo

Thank you very much 🎖️

This update introduces the implementation of topbar actions, enabling the addition of a topbar in the control panel for seamless toggling among various actions. Functionnal specifications: * This task aims to centralize and access models related to the current parent model. * We introduce the concept of topbar action. If a model has topbar actions, then a button with an 'eye' icon is displayed in the control panel. * When the user clicks the button, the topbar appears. * The top bar consists of the various topbar actions chosen as visible by the user. By default, the topbar only displays the current action (or the first available). * There is a dropdown button to the right of the topbar that displays all the actions available to the user. These actions depend on the model , but it's also possible that there is a domain on these actions making them invisible. For example, a project without the 'allow timesheets' option will not display the 'Timesheets' action. * The default actions cannot be deleted by the user; they can only decide whether to display them or not. The visibility of actions is different for each model but also for each model ID, meaning, for example, that the actions visible in one project will not be the same for another. * Each user can also save the current view and thus create a new topbar action. They can decide to share this topbar action so that it is visible to everyone, or not. The view type and filters are saved when creating a new topbar action. Those saved filters are saved as favorites filters that cannot be deleted while the topbar action exists. * If the user has the rights, they can also drag and drop the actions to reorder them. This order will be the same for everyone, and if the concerned actions are default actions, the order will also be common to all records of the concerned model. * On Mobile, only a dropdown is displayed with the current action. When the dropdown is unfolded, all available actions are displayed. It is not possible to drag and drop. Deleting is always available, as well as the creation of new actions. * The breadcrumbs should never push new items. When navigating between topbar actions, the breadcrumbs should be replaced. ------------------------------------------------------------------------ In order to create a new default topbar action for a model, the developer has to create an xml record of that structure: <record id="<id>" model="ir.actions.topbar"> <field name="res_model"><parent_res_model></field> <field name="parent_action_id" ref="<xml_id_parent_action>"/>  <field name="action_id" ref=<triggered_action_id>/> <field name="python_action"><python_action></field>  <field name="name"><name_of_the_topbar_action></field>  <field name="sequence"><sequence_order_integer></field> <field name="domain"><domain_to_filter_topbar_actions></field> <field name="context"><additional_context_keys></field> <field name="default_view_mode"><default_view></field> </record> taskid:3750721

xavierbol · 2024-04-24T12:28:09Z

odoo/addons/base/models/ir_actions.py

    def _get_readable_fields(self):
        return super()._get_readable_fields() | {
            "context", "mobile_view_mode", "domain", "filter", "groups_id", "limit",
-            "res_id", "res_model", "search_view_id", "target", "view_id", "view_mode", "views",
+            "res_id", "res_model", "search_view_id", "target", "view_id", "view_mode", "views", "children_ids",


create a one2many to have a real field. 🙂

C3POdoo requested review from a team, xmo-odoo, HydrionBurst, Iucapad and fdardenne and removed request for a team March 20, 2024 16:38

C3POdoo added the RD research & development, internal work label Mar 20, 2024

luve-odoo force-pushed the master-top-bar-actions-luve branch 2 times, most recently from 7077a9a to 8fd69b7 Compare March 21, 2024 10:33

auon-odoo requested changes Mar 22, 2024

View reviewed changes

luve-odoo force-pushed the master-top-bar-actions-luve branch 5 times, most recently from 092762e to e3ed922 Compare March 27, 2024 09:57

auon-odoo approved these changes Mar 28, 2024

View reviewed changes

luve-odoo force-pushed the master-top-bar-actions-luve branch from e3ed922 to 7b7835f Compare March 28, 2024 09:45

luve-odoo commented Mar 28, 2024

View reviewed changes

auon-odoo approved these changes Mar 28, 2024

View reviewed changes

luve-odoo force-pushed the master-top-bar-actions-luve branch 2 times, most recently from 4a0b525 to af4ffeb Compare April 5, 2024 14:22

luve-odoo force-pushed the master-top-bar-actions-luve branch 2 times, most recently from a6d4689 to 007f245 Compare April 8, 2024 12:09

luve-odoo force-pushed the master-top-bar-actions-luve branch 5 times, most recently from 9a61433 to 62a07ff Compare April 12, 2024 09:49

luve-odoo force-pushed the master-top-bar-actions-luve branch 3 times, most recently from be29afb to 21bd35f Compare April 23, 2024 10:02

luve-odoo added 2 commits April 24, 2024 13:11

[IMP] web: topbar actions tests

c96be45

luve-odoo force-pushed the master-top-bar-actions-luve branch from 21bd35f to c96be45 Compare April 24, 2024 11:11

xavierbol reviewed Apr 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[IMP] web, project: Add topbar actions #158441

[IMP] web, project: Add topbar actions #158441

luve-odoo commented Mar 20, 2024 •

edited

robodoo commented Mar 20, 2024

auon-odoo left a comment

auon-odoo left a comment

auon-odoo Mar 28, 2024

auon-odoo Mar 28, 2024

luve-odoo Mar 28, 2024

auon-odoo Mar 28, 2024

luve-odoo Mar 28, 2024

auon-odoo Mar 28, 2024

auon-odoo Mar 28, 2024

luve-odoo Mar 28, 2024

luve-odoo Mar 28, 2024

luve-odoo Mar 28, 2024

auon-odoo left a comment

xavierbol Apr 24, 2024

[IMP] web, project: Add topbar actions #158441

Are you sure you want to change the base?

[IMP] web, project: Add topbar actions #158441

Conversation

luve-odoo commented Mar 20, 2024 • edited

robodoo commented Mar 20, 2024

auon-odoo left a comment

Choose a reason for hiding this comment

auon-odoo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

auon-odoo left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

luve-odoo commented Mar 20, 2024 •

edited