Web Tutorial PR: trcaz

awesome_dashboard/__manifest__.py

@@ -25,6 +25,9 @@
         'web.assets_backend': [
             'awesome_dashboard/static/src/**/*',
         ],
+        'awesome_dashboard.dashboard': [
+            'awesome_dashboard/static/src/dashboard/**/*'
+        ]
     },
     'license': 'AGPL-3'
 }

awesome_dashboard/static/src/dashboard/dashboard.js

@@ -0,0 +1,73 @@
+/** @odoo-module **/
+
+import { Component, useState } from "@odoo/owl";
+import { registry } from "@web/core/registry";
+import { Layout } from "@web/search/layout";
+import { useService } from "@web/core/utils/hooks";
+import { _t } from "@web/core/l10n/translation";
+import { DashboardItem } from "./dashboard_item";
+import { PieChart } from "./pie_chart/pie_chart";
+import { browser } from "@web/core/browser/browser";
+import { Dialog } from "@web/core/dialog/dialog";
+import { CheckBox } from "@web/core/checkbox/checkbox";
+
+class AwesomeDashboard extends Component {
+    static template = "awesome_dashboard.AwesomeDashboard";
+    static components = { Layout, DashboardItem, PieChart };
+
+    setup() {
+        this.action = useService("action");
+        this.stats = useState(useService("awesome_dashboard.statistics"));
+        this.items = registry.category("awesome_dashboard").getAll();
+        this.dialog = useService("dialog");
+        this.state = useState({ itemsNotShown: browser.localStorage.getItem("itemsNotShown")?.split(",") || []});
+    }
+
+    openPartners() {
+        this.action.doAction("base.action_partner_form");
+    }
+
+    async openLeads() {
+        this.action.doAction({
+            type: 'ir.actions.act_window',
+            name: _t('All Leads'),
+            res_model: 'crm.lead',
+            views: [
+                [false, 'list'], 
+                [false, 'form']
+            ],
+        });
+    }
+
+    openSettingsDialog() {
+        this.dialog.add(SettingsDialog, {
+            items: this.items,
+            dashboard: this,
+        });
+    }
+}
+
+registry.category("lazy_components").add("awesome_dashboard.dashboard", AwesomeDashboard);
+
+class SettingsDialog extends Component {
+    static template = "awesome_dashboard.SettingsDialog";
+    static components = { Dialog, CheckBox };
+    static props = ["dashboard", "items"];
+
+    setup() {
+        this.items = useState(this.props.items);
+        this.items.forEach((item) => { item.shown = !this.props.dashboard.state.itemsNotShown.includes(item.id)});
+    }
+
+    toggleItem (isChecked, item) {
+        item.shown = isChecked;
+
+        const newItemsNotShown = Object.values(this.items)
+            .filter((i) => !i.shown)
+            .map((i) => i.id)
+
+        browser.localStorage.setItem("itemsNotShown", newItemsNotShown);
+
+        this.props.dashboard.state.itemsNotShown = newItemsNotShown;
+    }
+}

awesome_dashboard/static/src/dashboard/dashboard.scss

@@ -0,0 +1,3 @@
+.o_dashboard {
+    background-color: purple
+}

awesome_dashboard/static/src/dashboard/dashboard.xml

@@ -0,0 +1,41 @@
+<?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="() => this.openPartners()">
+                    Customers
+                </button>
+                <button class="btn btn-primary" t-on-click="() => this.openLeads()">
+                    Leads
+                </button>
+            </t>
+
+            <t t-set-slot="control-panel-additional-actions">
+                <button t-on-click="() => this.openSettingsDialog()" class="">
+                    <i class="fa fa-cog"/>
+                </button>
+            </t>
+
+            <t t-foreach="items" t-as="item" t-key="item.id">
+                <DashboardItem size="item.size" t-if="!this.state.itemsNotShown.includes(item.id)">
+                    <t t-set="itemProp" t-value="item.props ? item.props(this.stats) : {'data': this.stats}"/>
+                    <t t-component="item.Component" t-props="itemProp" />
+                </DashboardItem>
+            </t>
+        </Layout>
+    </t>
+
+    <t t-name="awesome_dashboard.SettingsDialog">
+        <Dialog title="'Configure your dashboard'">
+            Choose which items you want to display
+            <t t-foreach="items" t-as="item" t-key="item.id">
+                <CheckBox value="item.shown" onChange="(ev) => this.toggleItem(ev, item)">
+                    <t t-esc="item.description"/>
+                </CheckBox>
+            </t>
+        </Dialog>
+    </t>
+
+</templates>

awesome_dashboard/static/src/dashboard/dashboard_action.js

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

awesome_dashboard/static/src/dashboard/dashboard_item.js

@@ -0,0 +1,13 @@
+import { Component } from "@odoo/owl";
+
+export class DashboardItem extends Component {
+    static template = "awesome_dashboard.DashboardItem"
+    static props = { 
+        size: {type: Number, optional: true},
+        slots: {optional: true}
+    };
+
+    setup() {
+        this.size = this.props.size || 1;
+    }
+}

awesome_dashboard/static/src/dashboard/dashboard_item.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+
+    <t t-name="awesome_dashboard.DashboardItem">
+        <div class="dashboard_item d-inline-block m-2" t-att-style="'width: ' + (18 * this.size) + 'rem; border: 1px solid black; border-radius: 5px'">
+            <div class="dashboard_item-body">
+                <h5 class="dashboard_item-title"><t t-esc="this.title"/></h5>
+                <p class="dashboard_item-text">
+                    <t t-slot="default"/>
+                </p>
+            </div>
+        </div>
+    </t>
+
+</templates>

awesome_dashboard/static/src/dashboard/dashboard_items.js

@@ -0,0 +1,65 @@
+import { NumberCard } from "./number_card/number_card"
+import { PieChartCard } from "./pie_chart_card/pie_chart_card"
+import { registry } from "@web/core/registry";
+
+const items = [
+    {
+        id: "average_quantity",
+        description: "Average amount of t-shirt",
+        Component: NumberCard,
+        props: (data) => ({
+            title: "Average amount of t-shirt by order this month",
+            value: data.average_quantity,
+        })
+    },
+    {
+        id: "average_time",
+        description: "Average time for an order",
+        Component: NumberCard,
+        props: (data) => ({
+            title: "Average time for an order to go from 'new' to 'sent' or 'cancelled'",
+            value: data.average_time,
+        })
+    },
+    {
+        id: "number_new_orders",
+        description: "New orders this month",
+        Component: NumberCard,
+        props: (data) => ({
+            title: "Number of new orders this month",
+            value: data.nb_new_orders,
+        })
+    },
+    {
+        id: "cancelled_orders",
+        description: "Cancelled orders this month",
+        Component: NumberCard,
+        props: (data) => ({
+            title: "Number of cancelled orders this month",
+            value: data.nb_cancelled_orders,
+        })
+    },
+    {
+        id: "amount_new_orders",
+        description: "amount orders this month",
+        Component: NumberCard,
+        props: (data) => ({
+            title: "Total amount of new orders this month",
+            value: data.total_amount,
+        })
+    },
+    {
+        id: "pie_chart",
+        description: "Shirt orders by size",
+        Component: PieChartCard,
+        size: 2,
+        props: (data) => ({
+            title: "Shirt orders by size",
+            values: data.orders_by_size,
+        })
+    }
+]
+
+items.forEach(i => {
+    registry.category("awesome_dashboard").add(i.id, i);
+});

awesome_dashboard/static/src/dashboard/dashboard_service.js

@@ -0,0 +1,28 @@
+import { registry } from "@web/core/registry";
+import { memoize } from "@web/core/utils/functions";
+import { rpc } from "@web/core/network/rpc";
+import { reactive } from "@odoo/owl";
+
+const dashboardService = {
+    start() {
+        let stats = reactive({
+            average_quantity: 0, 
+            average_time: 0, 
+            nb_cancelled_orders: 0,
+            nb_new_orders: 0,
+            orders_by_size: {},
+            total_amount: 0 
+        });
+        async function loadData() {
+            const newStats = await rpc("/awesome_dashboard/statistics");
+            Object.assign(stats, newStats);
+        }
+        setInterval(loadData, 2*1000);
+        loadData();
+
+        return stats;
+    },
+};
+
+
+registry.category("services").add("awesome_dashboard.statistics", dashboardService);

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.NumberCard"
+    static props = {
+        title: String,
+        value: Number,
+    };
+}

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

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

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

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

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

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

awesome_dashboard/static/src/dashboard/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.PieChartCard";
+    static components = { PieChart };
+    static props = {
+        title: String,
+        values: {optional: false},
+    };
+}

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

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<templates xml:space="preserve">
+
+    <t t-name="awesome_dashboard.PieChartCard" owl="1">
+        <t t-esc="props.title"/>
+        <PieChart data="props.values" label="''"/>
+    </t>
+
+</templates>

awesome_owl/static/src/card/card.js

@@ -0,0 +1,19 @@
+import { Component, useState } from "@odoo/owl";
+
+export class Card extends Component {
+    static template = "awesome_owl.card";
+    static props = { 
+        title: String,
+        slots: {
+            type: Object,
+            shape: {
+                default: true
+            },
+        } 
+    }
+
+    setup() {
+        this.state = useState({open: true});
+        this.title = this.props.title;
+    }
+}