[ADD] awesome_owl, awesome_dashboard: basic client-side modules for todos and t-shirt sales dashboard

awesome_dashboard/__manifest__.py

@@ -1,30 +1,28 @@
-# -*- coding: utf-8 -*-
 {
-    'name': "Awesome Dashboard",
-
-    'summary': """
+    "name": "Awesome Dashboard",
+    "summary": """
         Starting module for "Discover the JS framework, chapter 2: Build a dashboard"
     """,
-
-    'description': """
+    "description": """
         Starting module for "Discover the JS framework, chapter 2: Build a dashboard"
     """,
-
-    'author': "Odoo",
-    'website': "https://www.odoo.com/",
-    'category': 'Tutorials',
-    'version': '0.1',
-    'application': True,
-    'installable': True,
-    'depends': ['base', 'web', 'mail', 'crm'],
-
-    'data': [
-        'views/views.xml',
+    "author": "Odoo",
+    "website": "https://www.odoo.com/",
+    "category": "Tutorials",
+    "version": "0.1",
+    "application": True,
+    "installable": True,
+    "depends": ["base", "web", "mail", "crm"],
+    "data": [
+        "views/views.xml",
     ],
-    'assets': {
-        'web.assets_backend': [
-            'awesome_dashboard/static/src/**/*',
+    "assets": {
+        "web.assets_backend": [
+            "awesome_dashboard/static/src/dashboard_action.js",
+        ],
+        "awesome_dashboard.dashboard": [
+            "awesome_dashboard/static/src/dashboard/**/*",
         ],
     },
-    'license': 'AGPL-3'
+    "license": "AGPL-3",
 }

awesome_dashboard/static/src/dashboard/dashboard.js

@@ -0,0 +1,52 @@
+import { Component, useState } from "@odoo/owl";
+import { _t } from "@web/core/l10n/translation"
+import { Layout } from "@web/search/layout"
+import { registry } from "@web/core/registry";
+import { useService } from "@web/core/utils/hooks";
+import { DashboardItem } from "./dashboard_item";
+import { PieChart } from "./pie_chart";
+import { DashboardConfigDialog } from "./dashboard_config_dialog";
+
+class AwesomeDashboard extends Component {
+    static template = "awesome_dashboard.AwesomeDashboard";
+
+    static components = { Layout, DashboardItem, PieChart, DashboardConfigDialog };
+
+    setup() {
+        this.action = useService("action");
+        this.statisticsService = useService("awesome_dashboard.statistics")
+        this.dialog = useService("dialog");
+        this.statistics = useState(this.statisticsService);
+        this.configState = useState({
+            disabledItems: JSON.parse(localStorage.getItem("disabled_dashboard_items") || "[]")
+        });
+    }
+
+    get items() {
+        const allItems = registry.category("awesome_dashboard").getAll();
+        return allItems.filter(item => !this.configState.disabledItems.includes(item.id));
+    }
+
+    openConfiguration() {
+        this.dialog.add(DashboardConfigDialog, {
+            onConfigSaved: () => {
+                this.configState.disabledItems = JSON.parse(localStorage.getItem("disabled_dashboard_items") || "[]");
+            }
+        });
+    }
+
+    openCustomers() {
+        this.action.doAction("base.action_partner_form");
+    }
+
+    openLeads() {
+        this.action.doAction({
+            type: "ir.actions.act_window",
+            name: _t("Leads"),
+            res_model: "crm.lead",
+            views: [[false, "list"], [false, "form"]],
+        });
+    }
+}
+
+registry.category("lazy_components").add("AwesomeDashboard", AwesomeDashboard);

awesome_dashboard/static/src/dashboard/dashboard.scss

@@ -0,0 +1,9 @@
+.o_dashboard {
+    background-color: #f0f2f5;
+    display: flex;
+    flex-direction: column;
+}
+.o_dashboard .display-1 {
+    color: var(--primary);
+    font-weight: 500;
+}

awesome_dashboard/static/src/dashboard/dashboard.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.AwesomeDashboard">
+        <Layout display="{controlPanel: {} }" className="'o_dashboard h-100'">
+            <t t-set-slot="control-panel-always-buttons">
+                <button class="btn btn-primary" t-on-click="openCustomers">Customers</button>
+                <button class="btn btn-primary" t-on-click="openLeads">Leads</button>
+            </t>
+            <t t-set-slot="control-panel-additional-actions">
+                <button class="d-print-none btn lh-sm p-0 border-0" t-on-click="openConfiguration">
+                    <i class="fa fa-fw fa-cog"/>
+                </button>
+            </t>
+            <div class="d-flex flex-wrap">
+                <t t-foreach="items" t-as="item" t-key="item.id">
+                    <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>

awesome_dashboard/static/src/dashboard/dashboard_config_dialog.js

@@ -0,0 +1,32 @@
+/** @odoo-module **/
+import { Component, useState } from "@odoo/owl";
+import { Dialog } from "@web/core/dialog/dialog";
+import { registry } from "@web/core/registry";
+
+export class DashboardConfigDialog extends Component {
+    static components = { Dialog };
+    static template = "awesome_dashboard.DashboardConfigDialog";
+
+    setup() {
+        this.allItems = registry.category("awesome_dashboard").getAll();
+
+        const disabledItems = JSON.parse(localStorage.getItem("disabled_dashboard_items") || "[]");
+
+        const initialStatus = {};
+        for (const item of this.allItems) {
+            initialStatus[item.id] = !disabledItems.includes(item.id);
+        }
+
+        this.state = useState(initialStatus);
+    }
+
+    onApply() {
+        const disabledIds = Object.keys(this.state).filter(id => !this.state[id]);
+
+        localStorage.setItem("disabled_dashboard_items", JSON.stringify(disabledIds));
+
+        this.props.onConfigSaved();
+
+        this.props.close();
+    }
+}

awesome_dashboard/static/src/dashboard/dashboard_config_dialog.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.DashboardConfigDialog">
+        <Dialog title="'Dashboard items configuration'">
+            <div class="p-3">
+                <p class="text-muted">Which cards do you wish to see?</p>
+                <div t-foreach="allItems" t-as="item" t-key="item.id" class="form-check my-2">
+                    <input 
+                        class="form-check-input" 
+                        type="checkbox" 
+                        t-model="state[item.id]" 
+                        t-att-id="'check_' + item.id"
+                    />
+                    <label class="form-check-label" t-att-for="'check_' + item.id" t-out="item.description"/>
+                </div>
+            </div>
+            <t t-set-slot="footer">
+                <button class="btn btn-primary" t-on-click="onApply">Apply</button>
+                <button class="btn btn-secondary" t-on-click="props.close">Cancel</button>
+            </t>
+        </Dialog>
+    </t>
+</templates>

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: { type: Object, optional: true },
+    }
+    static defaultProps = {
+        size: 1,
+    }
+}

awesome_dashboard/static/src/dashboard/dashboard_item.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.DashboardItem">
+        <div class="p-2 col-12" t-attf-class="col-lg-#{ (props.size || 1) * 3 }">
+            <div class="o_dashboard_item card shadow-sm h-100">
+                <div class="card-body">
+                    <t t-slot="default"/>
+                </div>
+            </div>
+        </div>
+    </t>
+</templates>

awesome_dashboard/static/src/dashboard/dashboard_items.js

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

awesome_dashboard/static/src/dashboard/number_card.js

@@ -0,0 +1,16 @@
+import { Component, xml } from "@odoo/owl";
+
+export class NumberCard extends Component {
+    static props = {
+        title: String,
+        value: { optional: true },
+    };
+
+    static template = xml`
+    <t t-name="awesome_dashboard.NumberCard">
+    <div class="d-flex flex-column align-items-center">
+        <h3 t-out="props.title" class="text-muted"/>
+        <div class="display-1" t-out="props.value"/>
+    </div>
+    </t>`;
+}

awesome_dashboard/static/src/dashboard/pie_chart.js

@@ -0,0 +1,54 @@
+import { Component, onWillStart, useRef, onMounted, onWillUnmount, useEffect } from "@odoo/owl";
+import { loadJS } from "@web/core/assets";
+
+export class PieChart extends Component {
+    static props = {
+        data: Object
+    }
+
+    static template = "awesome_dashboard.PieChart";
+
+    setup() {
+        this.canvasRef = useRef("canvas");
+        this.chart = null;
+        onWillStart(async () => {
+            await loadJS("/web/static/lib/Chart/Chart.js");
+        });
+        onMounted(() => {
+            this.renderChart();
+        });
+        onWillUnmount(() => {
+            this.chart?.destroy();
+        });
+        useEffect(() => {
+            this.renderChart();
+        }, () => [this.props.data]);
+    }
+
+    renderChart() {
+        if (!this.props.data) {
+            return; 
+        }
+        if (this.chart) {
+            this.chart.destroy();
+        }
+        const config = {
+            type: 'pie',
+            data: {
+                labels: Object.keys(this.props.data),
+                datasets: [{
+                    label: 'T-shirt sizes',
+                    data: Object.values(this.props.data),
+                    backgroundColor: [
+                        'rgb(255, 99, 132)',
+                        'rgb(54, 162, 235)',
+                        'rgb(255, 205, 86)',
+                        'rgb(75, 192, 192)',
+                        'rgb(153, 102, 255)'
+                    ],
+                }],
+            },
+        };
+        this.chart = new Chart(this.canvasRef.el, config);
+    }
+}

awesome_dashboard/static/src/dashboard/pie_chart.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.PieChart">
+        <div class="pie-chart-container d-flex justify-content-center" style="position: relative; height:40vh;">
+            <canvas t-ref="canvas"/>
+        </div>
+    </t>
+</templates>