[IMP] awesome_dashboard: make dashboard items dynamic and reusable

This commit restructures the dashboard to render items dynamically based on a centralized configuration list. This approach enables easier extension and reuse of dashboard item types, improving maintainability and scalability. Key changes include: Introduction of dashboard_items.js to define a list of item configurations, including type, title, and props. This enables dynamic rendering of dashboard widgets like NumberCard and PieChartCard. The DashboardItem component now acts as a dynamic wrapper that loads and renders the appropriate child component based on its type. This is achieved using Owl's dynamic component syntax and t-component. Separation of each card type into its own file (NumberCard, PieChartCard) to promote single-responsibility design and reuse across modules. All components continue to use Bootstrap utility classes and maintain responsive, clean, and modern styling. This change lays the foundation for a fully extensible dashboard architecture, where new visualizations can be added without modifying the core dashboard view.
odoo · raaa-odoo · May 7, 2025 · May 8, 2025 · May 29, 2025 · May 12, 2025
commit 4c06dbdff8aa014a5ffe4842b4c6923b2b963068
diff --git a/awesome_dashboard/static/src/dashboard.js b/awesome_dashboard/static/src/dashboard.js
diff --git a/awesome_dashboard/static/src/dashboard.scss b/awesome_dashboard/static/src/dashboard.scss
@@ -0,0 +1,15 @@
+.dashboard-card-wrapper {
+    transition: transform 0.3s ease, box-shadow 0.3s ease;
+  }
+
+  .dashboard-card {
+    border-radius: 1rem;
+    transition: all 0.3s ease-in-out;
+    cursor: pointer;
+  }
+
+  .dashboard-card:hover {
+    transform: translateY(-5px);
+    box-shadow: 0 10px 20px rgba(0, 0, 0, 0.12);
+  }
+
diff --git a/awesome_dashboard/static/src/dashboard.xml b/awesome_dashboard/static/src/dashboard.xml
diff --git a/awesome_dashboard/static/src/dashboard/components/dashboard_item/dashboard.scss b/awesome_dashboard/static/src/dashboard/components/dashboard_item/dashboard.scss
@@ -0,0 +1,29 @@
+// .o_dashboard_cards {
+//   display: flex;
+//   flex-wrap: wrap;
+//   gap: 1rem;
+// }
+
+.dashboard-item {
+  background: white;
+  padding: 1.5rem;
+  border-radius: 0.75rem;
+  box-shadow: 0 2px 6px rgba(0, 0, 0, 0.1);
+  min-height: 150px;
+  display: flex;
+  flex-direction: column;
+  justify-content: center;
+  align-items: center;
+
+  h5 {
+      font-size: 1rem;
+      margin-bottom: 0.5rem;
+      text-align: center;
+  }
+
+  p {
+      font-size: 1.5rem;
+      font-weight: bold;
+      color: green;
+  }
+}
diff --git a/awesome_dashboard/static/src/dashboard/components/dashboard_item/dashboard_item.js b/awesome_dashboard/static/src/dashboard/components/dashboard_item/dashboard_item.js
@@ -0,0 +1,6 @@
+import { Component } from "@odoo/owl";
+
+export class DashboardItem extends Component {
+    static template = "awesome_dashboard.DashboardItem";
+    static props = { size: { type: Number, optional: true, default: 1 } };
+}
diff --git a/awesome_dashboard/static/src/dashboard/components/dashboard_item/dashboard_item.xml b/awesome_dashboard/static/src/dashboard/components/dashboard_item/dashboard_item.xml
@@ -0,0 +1,10 @@
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.DashboardItem">
+      <div class="card p-3 m-1 h-100 shadow-sm dashboard-card animate-hover">
+        <div class="card-body overflow-auto">
+          <t t-slot="default"/>
+        </div>
+      </div>
+    </t>
+  </templates>
+
diff --git a/awesome_dashboard/static/src/dashboard/components/number_card/number_card.js b/awesome_dashboard/static/src/dashboard/components/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 = {
+        label: String,
+        value: [Number, String],
+    };
+}
diff --git a/awesome_dashboard/static/src/dashboard/components/number_card/number_card.xml b/awesome_dashboard/static/src/dashboard/components/number_card/number_card.xml
@@ -0,0 +1,10 @@
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.NumberCard">
+        <h4 class="text-nowrap">
+            <t t-out="props.label"/>
+        </h4>
+        <p class="fs-2 fw-bold">
+            <t t-out="props.value"/>
+        </p>
+    </t>
+</templates>
diff --git a/awesome_dashboard/static/src/dashboard/components/pie_chart/pie_chart.js b/awesome_dashboard/static/src/dashboard/components/pie_chart/pie_chart.js
@@ -0,0 +1,62 @@
+/** @odoo-module **/
+
+import { Component, useRef, onWillStart, onMounted, onWillUpdateProps } from '@odoo/owl';
+import { loadJS } from "@web/core/assets";
+
+export class PieChart extends Component {
+    static template = 'awesome_dashboard.PieChart';
+
+    static props = {
+        data: Object,
+    };
+
+    setup() {
+        this.canvasRef = useRef('chartCanvas');
+        this.chart = null;
+
+        onWillStart(async () => {
+            await loadJS("/web/static/lib/Chart/Chart.js");
+        });
+
+        onMounted(() => {
+            this.renderChart();
+        });
+
+        onWillUpdateProps((nextProps) => {
+            if (this.chart) {
+                // Update dataset data with new props
+                this.chart.data.labels = Object.keys(nextProps.data);
+                this.chart.data.datasets[0].data = Object.values(nextProps.data);
+                this.chart.update(); // ✅ Trigger re-render
+            }
+        });
+    }
+
+    renderChart() {
+        const ctx = this.canvasRef.el.getContext('2d');
+        this.chart = new Chart(ctx, {
+            type: "pie",
+            data: {
+                labels: Object.keys(this.props.data),
+                datasets: [
+                    {
+                        label: "Orders by T-shirt Size",
+                        data: Object.values(this.props.data),
+                        backgroundColor: [
+                            "#3498db", "#2ecc71", "#f1c40f", "#e67e22", "#9b59b6"
+                        ],
+                        borderWidth: 1
+                    }
+                ]
+            },
+            options: {
+                responsive: true,
+                plugins: {
+                    legend: {
+                        position: "right"
+                    }
+                }
+            }
+        });
+    }
+}
diff --git a/awesome_dashboard/static/src/dashboard/components/pie_chart/pie_chart.xml b/awesome_dashboard/static/src/dashboard/components/pie_chart/pie_chart.xml
@@ -0,0 +1,5 @@
+<t t-name="awesome_dashboard.PieChart" owl="1">
+    <div class="w-100 h-100">
+        <canvas t-ref="chartCanvas" style="width: 100%; height: 300px;"></canvas>
+    </div>
+</t>
diff --git a/awesome_dashboard/static/src/dashboard/dashboard.js b/awesome_dashboard/static/src/dashboard/dashboard.js
@@ -0,0 +1,55 @@
+import { Component, useState, onWillStart } from "@odoo/owl";
+import { useService } from "@web/core/utils/hooks";
+import { registry } from "@web/core/registry";
+import { Layout } from "@web/search/layout";
+import { DashboardItem } from "./components/dashboard_item/dashboard_item";
+import { NumberCard } from "./components/number_card/number_card";
+import { PieChart } from "./components/pie_chart/pie_chart";
+import { SettingDialog } from "./setting/setting_dialog";
+
+class AwesomeDashboard extends Component {
+    static template = "awesome_dashboard.AwesomeDashboard";
+    static components = { Layout, DashboardItem, NumberCard, PieChart };
+
+    setup() {
+        this.dialogService = useService("dialog");
+        this.action = useService("action");
+        this.statisticsService = useService("awesome_dashboard.statistics");
+        this.statistics = useState(this.statisticsService.data);
+        this.state = useState({ hiddenItems: JSON.parse(localStorage.getItem("awesome_dashboard_hidden_items")) || [] });
+    }
+
+    openCustomers = () => {
+        this.action.doAction("base.action_partner_customer_form", {
+            views: [[false, "kanban"]],
+        });
+    }
+
+    openLeads = () => {
+        this.action.doAction({
+            type: "ir.actions.act_window",
+            name: "Leads",
+            res_model: "crm.lead",
+            views: [
+                [false, "list"],
+                [false, "form"]
+            ]
+        });
+    }
+
+    getFilteredItems = () => {
+        const hiddenSet = new Set(this.state.hiddenItems);
+        return registry.category("awesome_dashboard.items").getAll().filter(item => !hiddenSet.has(item.id));
+    }
+
+    openSettings = () => {
+        this.dialogService.add(SettingDialog, {
+            onApply: (hiddenItems) => {
+                localStorage.setItem("awesome_dashboard_hidden_items", JSON.stringify(hiddenItems));
+                this.state.hiddenItems = hiddenItems;
+            }
+        });
+    }
+}
+
+registry.category("lazy_components").add("awesome_dashboard.dashboard", AwesomeDashboard);
diff --git a/awesome_dashboard/static/src/dashboard/dashboard.xml b/awesome_dashboard/static/src/dashboard/dashboard.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.AwesomeDashboard">
+        <div class="o_action">
+            <Layout display="{ controlPanel: {} }" className="'o_dashboard '">
+                <t t-set-slot="control-panel-create-button">
+                    <button class="btn btn-primary" t-on-click="openCustomers"> Customers</button>
+                    <button class="btn btn-secondary" t-on-click="openLeads"> Leads </button>
+                </t>
+                <t t-set-slot="control-panel-additional-actions">
+                    <button class="btn p-0" t-on-click="openSettings">
+                        <i class="fa fa-cog">Settings</i>
+                    </button>
+                </t>
+                <div class="d-flex flex-wrap text-center">
+                    <t t-foreach="getFilteredItems()" t-as="item" t-key="item.id">
+                        <DashboardItem size="item.size || 1">
+                            <t t-set="itemProps" t-value="item.props ? item.props(statistics) : {'data': statistics}"/>
+                            <t t-component="item.component" t-props="itemProps"/>
+                        </DashboardItem>
+                    </t>
+                </div>
+            </Layout>
+        </div>
+    </t>
+</templates>
diff --git a/awesome_dashboard/static/src/dashboard/dashboard_items.js b/awesome_dashboard/static/src/dashboard/dashboard_items.js
@@ -0,0 +1,73 @@
+import { registry } from "@web/core/registry"
+import { NumberCard } from "./components/number_card/number_card";
+import { PieChart } from "./components/pie_chart/pie_chart";
+import { _t } from "@web/core/l10n/translation";
+
+const dashboardRegistry = registry.category("awesome_dashboard.items");
+
+
+dashboardRegistry.add("average_quantity", {
+    id: "average_quantity",
+    description: _t("Average amount of t-shirt"),
+    component: NumberCard,
+    size: 2,
+    props: (data) => ({
+        label: _t("Average Quantity"),
+        value: data.average_quantity,
+    }),
+});
+
+dashboardRegistry.add("average_time", {
+    id: "average_time",
+    description: _t("Average order processing time"),
+    component: NumberCard,
+    size: 2,
+    props: (data) => ({
+        label: _t("Average time"),
+        value: data.average_time,
+    }),
+});
+
+dashboardRegistry.add("nb_new_orders", {
+    id: "nb_new_orders",
+    description: _t("New orders this month"),
+    component: NumberCard,
+    size: 1,
+    props: (data) => ({
+        label: _t("New orders this month"),
+        value: data.nb_new_orders,
+    }),
+});
+
+dashboardRegistry.add("nb_cancelled_orders", {
+    id: "nb_cancelled_orders",
+    description: _t("Cancelled orders this month"),
+    component: NumberCard,
+    size: 1,
+    props: (data) => ({
+        label: _t("Number of Cancelled Orders this month"),
+        value: data.nb_cancelled_orders,
+    }),
+});
+
+dashboardRegistry.add("total_amount", {
+    id: "total_amount",
+    description: _t("Total sales amount"),
+    component: NumberCard,
+    size: 1,
+    props: (data) => ({
+        label: _t("Total amount of new Orders This Month"),
+        value: data.total_amount,
+    }),
+});
+
+dashboardRegistry.add("orders_by_size", {
+    id: "orders_by_size",
+    description: _t("Shirt orders by size"),
+    component: PieChart,
+    size: 2,
+    props: (data) => ({
+        label: _t("Shirt orders by size"),
+        data: data.orders_by_size,
+    }),
+});
diff --git a/awesome_dashboard/static/src/dashboard/services/statistics.js b/awesome_dashboard/static/src/dashboard/services/statistics.js
@@ -0,0 +1,36 @@
+import { registry } from "@web/core/registry";
+import { rpc } from "@web/core/network/rpc";
+import { reactive } from "@odoo/owl";
+import { memoize } from "@web/core/utils/functions";
+
+
+export const statisticsService = {
+
+    start() {
+        const stats = reactive({
+            nb_new_orders: 0,
+            total_amount: 0,
+            average_quantity: 0,
+            nb_cancelled_orders: 0,
+            average_time: 0,
+            orders_by_size: { m: 0, s: 0, xl: 0 }
+        });
+
+        const loadStatistics = memoize(async () => {
+            const result = await rpc("/awesome_dashboard/statistics", {});
+            if (result) {
+                Object.assign(stats, result);
+            }
+        });
+
+        loadStatistics();
+
+        setInterval(() => {
+            loadStatistics();
+        }, 1000);
+
+        return { data: stats };
+    },
+};
+
+registry.category("services").add("awesome_dashboard.statistics", statisticsService);