Web framework tutorial

addons/awesome_dashboard/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+
+from . import controllers
+from . import models

awesome_dashboard/__manifest__.py → addons/awesome_dashboard/__manifest__.py

@@ -23,7 +23,10 @@
     ],
     'assets': {
         'web.assets_backend': [
-            'awesome_dashboard/static/src/**/*',
+            'awesome_dashboard/static/src/dashboard_action.js',
+        ],
+        'awesome_dashboard.assets_dashboard': [
+            'awesome_dashboard/static/src/dashboard/**/*',
         ],
     },
     'license': 'AGPL-3'

awesome_dashboard/controllers/controllers.py → addons/awesome_dashboard/controllers/controllers.py

@@ -8,6 +8,7 @@
 
 logger = logging.getLogger(__name__)
 
+
 class AwesomeDashboard(http.Controller):
     @http.route('/awesome_dashboard/statistics', type='jsonrpc', auth='user')
     def get_statistics(self):
@@ -34,3 +35,10 @@ def get_statistics(self):
             'total_amount': random.randint(100, 1000)
         }
 
+    @http.route('/awesome_dashboard/save_config', type='jsonrpc', auth='user')
+    def save_config(self, config):
+        request.env.user.dashboard_config = config
+
+    @http.route('/awesome_dashboard/load_config', type='jsonrpc', auth='user')
+    def load_config(self):
+        return request.env.user.dashboard_config

addons/awesome_dashboard/models/__init__.py

@@ -0,0 +1 @@
+from . import res_users

addons/awesome_dashboard/models/res_users.py

@@ -0,0 +1,7 @@
+from odoo import models, fields
+
+
+class ResUsers(models.Model):
+    _inherit = 'res.users'
+
+    dashboard_config = fields.Char(string='Dashboard Configuration', default='[]')

addons/awesome_dashboard/static/src/dashboard/charts/pie_chart/pie_chart.js

@@ -0,0 +1,30 @@
+import {Component, onWillStart, onMounted, useRef} from "@odoo/owl";
+import {loadJS} from "@web/core/assets";
+
+
+export class PieChart extends Component {
+    static template = "awesome_dashboard.pie_chart";
+    static props = {
+        data: Object,
+    }
+
+    setup() {
+        this.canvasRef = useRef("canvas");
+
+        onWillStart(async () => {
+            await loadJS("/web/static/lib/Chart/Chart.js")
+        })
+
+        onMounted(() => {
+            new Chart(this.canvasRef.el, {
+                type: "pie",
+                data: {
+                    labels: Object.keys(this.props.data),
+                    datasets: [{
+                        data: Object.values(this.props.data),
+                    }]
+                },
+            })
+        })
+    }
+}

awesome_dashboard/static/src/dashboard.xml → addons/awesome_dashboard/static/src/dashboard/charts/pie_chart/pie_chart.xml

@@ -1,8 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 <templates xml:space="preserve">
-
-    <t t-name="awesome_dashboard.AwesomeDashboard">
-        hello dashboard
+    <t t-name="awesome_dashboard.pie_chart">
+        <canvas t-ref="canvas"/>
     </t>
 
 </templates>

addons/awesome_dashboard/static/src/dashboard/charts/pie_chart_card/pie_chart_card.js

@@ -0,0 +1,11 @@
+import {Component} from "@odoo/owl";
+import {PieChart} from "../pie_chart/pie_chart";
+
+export class PieChartCard extends Component {
+    static template = "awesome_dashboard.pie_chart_card";
+    static props = {
+        title: {type: String, optional: true},
+        data: {type: Object},
+    };
+    static components = {PieChart}
+}

addons/awesome_dashboard/static/src/dashboard/charts/pie_chart_card/pie_chart_card.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.pie_chart_card">
+        <t t-esc="props.title"/>
+        <PieChart data="props.data"/>
+    </t>
+</templates>

addons/awesome_dashboard/static/src/dashboard/config_dialog/config_dialog.js

@@ -0,0 +1,36 @@
+import {Component, useState} from "@odoo/owl";
+import {Dialog} from "@web/core/dialog/dialog";
+import {rpc} from "@web/core/network/rpc";
+
+export class ConfigDialog extends Component {
+    static template = "awesome_dashboard.config_dialog";
+    static props = {
+        items: {type: Array},
+        close: {type: Function},
+        onApply: {type: Function},
+        disabledItems: {type: Array},
+    };
+    static components = {Dialog}
+
+    setup() {
+        this.state = useState({
+            disabledItems: [...this.props.disabledItems]
+        })
+    }
+
+    async apply() {
+        await rpc("/awesome_dashboard/save_config", {
+            config: JSON.stringify(this.state.disabledItems)
+        });
+        this.props.onApply(this.state.disabledItems);
+        this.props.close();
+    }
+
+    toggleItem(id, isChecked) {
+        if (isChecked) {
+            this.state.disabledItems = this.state.disabledItems.filter(i => i !== id);
+        } else {
+            this.state.disabledItems = [...this.state.disabledItems, id];
+        }
+    }
+}

addons/awesome_dashboard/static/src/dashboard/config_dialog/config_dialog.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.config_dialog">
+        <Dialog title="'Dashboard Configuration'">
+            <span>Which cards do you wish to see?</span>
+            <t t-foreach="props.items" t-as="item" t-key="item.description">
+                <div>
+                    <input
+                            type="checkbox"
+                            t-att-checked="!state.disabledItems.includes(item.description)"
+                            t-on-change="(ev) => this.toggleItem(item.description, ev.target.checked)"
+                    />
+                    <span t-esc="item.description" class="p-2"/>
+                </div>
+            </t>
+            <t t-set-slot="footer">
+                <button class="btn btn-primary" t-on-click="apply">Apply</button>
+            </t>
+        </Dialog>
+    </t>
+</templates>

addons/awesome_dashboard/static/src/dashboard/dashboard/dashboard.js

@@ -0,0 +1,62 @@
+import {Component, useState, onWillStart} from "@odoo/owl";
+import {registry} from "@web/core/registry";
+import {Layout} from "@web/search/layout";
+import {useService} from "@web/core/utils/hooks";
+import {DashboardItem} from "../dashboard_item/dashboard_item";
+import {PieChart} from "../charts/pie_chart/pie_chart";
+import "./dashboard_items";
+import {PieChartCard} from "../charts/pie_chart_card/pie_chart_card";
+import {NumberCard} from "../number_card/number_card";
+import {ConfigDialog} from "../config_dialog/config_dialog";
+import {rpc} from "@web/core/network/rpc";
+
+
+class AwesomeDashboard extends Component {
+    static template = "awesome_dashboard.AwesomeDashboard";
+    static components = {Layout, DashboardItem, PieChart, PieChartCard, NumberCard, ConfigDialog};
+
+
+    setup() {
+        this.action = useService("action");
+        const {statistics} = useService("awesome_dashboard.statistics");
+        this.statistics = useState(statistics);
+        this.items = registry.category("awesome_dashboard").getAll();
+        this.dialog = useService("dialog")
+        this.state = useState({disabledItems: []})
+
+        onWillStart(async () => {
+            const config = await rpc("/awesome_dashboard/load_config");
+            this.state.disabledItems = JSON.parse(config || "[]");
+        });
+
+    }
+
+    openCustomerView() {
+        this.action.doAction("base.action_partner_form");
+    }
+
+    openLeads() {
+        this.action.doAction({
+            type: "ir.actions.act_window",
+            res_model: "crm.lead",
+            views: [[false, "list"], [false, "form"]],
+            name: "All leads",
+        });
+    }
+
+    get visibleItems() {
+        return this.items.filter(item => !this.state.disabledItems.includes(item.description));
+    }
+
+    openSettings() {
+        this.dialog.add(ConfigDialog, {
+            items: this.items,
+            disabledItems: this.state.disabledItems,
+            onApply: (disabledItems) => {
+                this.state.disabledItems = disabledItems;
+            }
+        });
+    }
+}
+
+registry.category("lazy_components").add("AwesomeDashboard", AwesomeDashboard);

addons/awesome_dashboard/static/src/dashboard/dashboard/dashboard.scss

@@ -0,0 +1,9 @@
+.o_dashboard {
+  background-color: grey;
+
+  @media (max-width: 768px) {
+    .card {
+      width: 100% !important;
+    }
+  }
+}

addons/awesome_dashboard/static/src/dashboard/dashboard/dashboard.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+        <t t-name="awesome_dashboard.AwesomeDashboard">
+            <Layout className="'o_dashboard h-100'" display="{controlPanel: {}}">
+                <t t-set-slot="layout-buttons">
+                    <button class="btn btn-primary" t-on-click="openCustomerView">Customers</button>
+                    <button class="btn btn-primary" t-on-click="openLeads">Leads</button>
+                    <button class="btn btn-primary" t-on-click="openSettings"><i class="fa fa-gear"/></button>
+                </t>
+                <div class="d-flex flex-wrap gap-3 p-3">
+                    <t t-foreach="visibleItems" t-as="item" t-key="item.description">
+                        <DashboardItem size="item.size || 1">
+                            <t t-set="itemProp" t-value="item.props ? item.props(statistics) : {'data': statistics}"/>
+                            <t t-component="item.Component" t-props="itemProp" />
+                        </DashboardItem>
+                    </t>
+                </div>
+            </Layout>
+        </t>
+</templates>

addons/awesome_dashboard/static/src/dashboard/dashboard/dashboard_items.js

@@ -0,0 +1,57 @@
+import {NumberCard} from "../number_card/number_card";
+import {PieChartCard} from "../charts/pie_chart_card/pie_chart_card";
+import {registry} from "@web/core/registry";
+import {_t} from "@web/core/l10n/translation";
+
+
+registry.category("awesome_dashboard").add("average_quantity", {
+    description: _t("Average amount of t-shirt by order this month"),
+    Component: NumberCard,
+    size: 1.5,
+    props: (data) => ({
+        title: _t("Average amount of t-shirt by order this month"),
+        value: data.average_quantity,
+    })
+});
+registry.category("awesome_dashboard").add("average_time", {
+    description: _t("Average time for an order to go from 'new' to 'sent' or 'cancelled'"),
+    Component: NumberCard,
+    size: 2,
+    props: (data) => ({
+        title: _t("Average time for an order to go from 'new' to 'sent' or 'cancelled'"),
+        value: data.average_time,
+    })
+});
+registry.category("awesome_dashboard").add("nb_new_orders", {
+    description: _t("Number of new orders this month"),
+    Component: NumberCard,
+    props: (data) => ({
+        title: _t("Number of new orders this month"),
+        value: data.nb_new_orders,
+    })
+});
+registry.category("awesome_dashboard").add("nb_cancelled_orders", {
+    description: _t("Number of cancelled orders this month"),
+    Component: NumberCard,
+    props: (data) => ({
+        title: _t("Number of cancelled orders this month"),
+        value: data.nb_cancelled_orders,
+    })
+});
+registry.category("awesome_dashboard").add("total_amount", {
+    description: _t("Total amount of new orders this month"),
+    Component: NumberCard,
+    props: (data) => ({
+        title: _t("Total amount of new orders this month"),
+        value: data.total_amount,
+    })
+});
+registry.category("awesome_dashboard").add("orders_by_size", {
+    id: "orders_by_size",
+    description: _t("Shirt orders by size"),
+    Component: PieChartCard,
+    props: (data) => ({
+        data: data.orders_by_size,
+        title: _t("Shirt orders by size"),
+    })
+});

addons/awesome_dashboard/static/src/dashboard/dashboard_item/dashboard_item.js

@@ -0,0 +1,12 @@
+import {Component} from "@odoo/owl"
+import {NumberCard} from "../number_card/number_card";
+
+
+export class DashboardItem extends Component {
+    static template = "awesome_dashboard.dashboard_item";
+    static props = {
+        size: {type: Number, optional: true, default: 1},
+        slots: {type: Object, optional: true, default: null},
+    };
+    static components = {NumberCard};
+}

addons/awesome_dashboard/static/src/dashboard/dashboard_item/dashboard_item.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+
+    <t t-name="awesome_dashboard.dashboard_item">
+        <div class="card" t-att-style="'width: ' + (props.size || 1) * 18 + 'rem'">
+            <div class="card-body border border-dark rounded-3 fw-bold d-flex flex-column align-items-center justify-content-center text-center">
+                <t t-slot="default">
+                </t>
+            </div>
+        </div>
+    </t>
+
+</templates>

addons/awesome_dashboard/static/src/dashboard/number_card/number_card.js

@@ -0,0 +1,9 @@
+import {Component} from "@odoo/owl";
+
+export class NumberCard extends Component {
+    static template = "awesome_dashboard.number_card";
+    static props = {
+        title: {type: String},
+        value: {type: Number},
+    };
+}

addons/awesome_dashboard/static/src/dashboard/number_card/number_card.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.number_card">
+        <span><t t-esc="props.title"/></span>
+        <p class="text-success fw-bold fs-1">
+            <t t-esc="props.value"/>
+        </p>
+    </t>
+</templates>

addons/awesome_dashboard/static/src/dashboard/services/statistics_service.js

@@ -0,0 +1,22 @@
+import {registry} from "@web/core/registry";
+import {rpc} from "@web/core/network/rpc";
+import {reactive} from "@odoo/owl"
+
+
+const statisticsService = {
+    start() {
+        const statistics = reactive({});
+
+        async function loadStatistics() {
+            const data = await rpc("/awesome_dashboard/statistics");
+            Object.assign(statistics, data)
+        }
+
+        loadStatistics();
+        setInterval(loadStatistics, 10000);
+
+        return {statistics};
+    }
+}
+
+registry.category("services").add("awesome_dashboard.statistics", statisticsService);

addons/awesome_dashboard/static/src/dashboard_action.js

@@ -0,0 +1,10 @@
+import {Component, xml} from "@odoo/owl";
+import {registry} from "@web/core/registry";
+import {LazyComponent} from "@web/core/assets";
+
+class DashboardAction extends Component {
+    static components = {LazyComponent};
+    static template = xml`<LazyComponent bundle="'awesome_dashboard.assets_dashboard'" Component="'AwesomeDashboard'"/>`;
+}
+
+registry.category("actions").add("awesome_dashboard.dashboard", DashboardAction);