web tutorials (avpin)

.gitignore

@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# vscode
+.vscode/

awesome_dashboard/__manifest__.py

@@ -12,7 +12,7 @@
 
     'author': "Odoo",
     'website': "https://www.odoo.com/",
-    'category': 'Tutorials/AwesomeDashboard',
+    'category': 'Tutorials',
     'version': '0.1',
     'application': True,
     'installable': True,
@@ -22,8 +22,13 @@
         'views/views.xml',
     ],
     'assets': {
+        'awesome_dashboard.dashboard': [
+            'awesome_dashboard/static/src/dashboard/*',
+            'awesome_dashboard/static/src/dashboard/**/*',
+        ],
         'web.assets_backend': [
-            'awesome_dashboard/static/src/**/*',
+            'awesome_dashboard/static/src/dashboard_action.js',
+            'awesome_dashboard/static/src/statistics_service.js',
         ],
     },
     'license': 'AGPL-3'

awesome_dashboard/static/src/dashboard/dashboard.js

@@ -0,0 +1,65 @@
+import { Component, reactive, useState } from "@odoo/owl";
+import { registry } from "@web/core/registry";
+import { useBus, useService } from "@web/core/utils/hooks";
+import { Layout } from "@web/search/layout";
+import { DashboardItem } from "./dashboard_item/dashboard_item";
+import { NumberCard } from "./number_card/number_card";
+import { PieChartCard } from "./pie_chart_card/pie_chart_card";
+import { DashboardItemsDialog } from "./dashboard_items_dialog/dashboard_items_dialog";
+
+const EXCLUDED_DASHBOARD_ITEMS_LS_KEY = 'excluded_dashboard_items';
+
+class AwesomeDashboard extends Component {
+    static template = "awesome_dashboard.AwesomeDashboard";
+    static components = { Layout, DashboardItem, DashboardItemsDialog, NumberCard, PieChartCard };
+
+    setup() {
+        this.action = useService("action");
+        this.dialog = useService("dialog");
+
+        this.statisticsService = useService("statistics");
+        this.state = useState(this.statisticsService);
+
+        this.items = registry.category('dashboard_items').getAll();
+        useBus(registry.category('dashboard_items'), 'UPDATE', this.handleDashboardItemsUpdate.bind(this));
+
+        const initExcludedItems = JSON.parse(localStorage.getItem(EXCLUDED_DASHBOARD_ITEMS_LS_KEY)) ?? [];
+        const storedStateObj = { excludedItems: initExcludedItems };
+        const store = obj => localStorage.setItem(EXCLUDED_DASHBOARD_ITEMS_LS_KEY, JSON.stringify(obj.excludedItems));
+        const reactiveStoredState = reactive(storedStateObj, () => store(reactiveStoredState));
+        store(reactiveStoredState);
+        this.storedState = useState(storedStateObj);
+    }
+
+    handleDashboardItemsUpdate(event) {
+        this.items = registry.category('dashboard_item').getAll();
+    }
+
+    openCustomers() {
+        this.action.doAction("base.action_partner_form");
+    }
+
+    openLeads() {
+        this.action.doAction({
+            type: 'ir.actions.act_window',
+            name: "Leads",
+            target: 'current',
+            res_model: 'crm.lead',
+            views: [[false, 'form'], [false, 'list']],
+        });
+    }
+
+    handleDashboardItemsConfigChange(excludedItems) {
+        this.storedState.excludedItems = excludedItems;
+    }
+
+    openSettings() {
+        this.removeSettingsDialog = this.dialog.add(DashboardItemsDialog, {
+            items: this.items,
+            excludedItems: this.storedState.excludedItems,
+            onApply: this.handleDashboardItemsConfigChange.bind(this),
+        });
+    }
+}
+
+registry.category("lazy_components").add("AwesomeDashboard", AwesomeDashboard);

awesome_dashboard/static/src/dashboard/dashboard.scss

@@ -0,0 +1,14 @@
+.o_dashboard {
+    background-color: gray;
+}
+
+.stats-name {
+    font-size: medium;
+    color: black;
+}
+
+.stats-number {
+    font-size: larger;
+    font-weight: bold;
+    color: green;
+}

awesome_dashboard/static/src/dashboard/dashboard.xml

@@ -0,0 +1,21 @@
+<?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="control-panel-create-button">
+                <button t-on-click="openCustomers" type="button" class="btn btn-primary">Customers</button>
+                <button t-on-click="openLeads" type="button" class="btn btn-primary">Leads</button>
+                <button t-on-click="openSettings" type="button" class="fa fa-gear"></button>
+            </t>
+
+            <t t-foreach="items" t-as="item" t-key="item.id">
+                <DashboardItem t-if="!storedState.excludedItems.includes(item.id)" size="item.size || 1">
+                    <t t-set="itemProp" t-value="item.props ? item.props(state.statistics) : {'data': state.statistics}"/>
+                    <t t-component="item.Component" t-props="itemProp"/>
+                </DashboardItem>
+            </t>
+        </Layout>
+    </t>
+
+</templates>

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

@@ -0,0 +1,15 @@
+import { Component } from "@odoo/owl";
+
+export class DashboardItem extends Component {
+    static template = 'awesome_dashboard.DashboardItem';
+    static props = {
+        size: {
+            type: Number,
+            optional: true,
+        },
+        slots: Object,
+    };
+    static defaultProps = {
+        size: 1,
+    };
+}

awesome_dashboard/static/src/dashboard/dashboard_item/dashboard_item.scss

@@ -0,0 +1,7 @@
+.dashboard-item {
+    background-color: white;
+    display: inline-block;
+    margin: 1rem;
+    padding: 1rem;
+    text-align: center;
+}

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

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+
+    <t t-name="awesome_dashboard.DashboardItem">
+        <div class="dashboard-item" t-att-style="'width: ' + 18*props.size + 'rem;'">
+            <t t-slot="default"/>
+        </div>
+    </t>
+</templates>

awesome_dashboard/static/src/dashboard/dashboard_items.js

@@ -0,0 +1,68 @@
+import { _t } from "@web/core/l10n/translation";
+import { registry } from "@web/core/registry";
+import { NumberCard } from "./number_card/number_card";
+import { PieChartCard } from "./pie_chart_card/pie_chart_card";
+
+export const dashboardItemRegistry = registry.category("dashboard_items");
+
+export const items = [
+    {
+        id: 'average_quantity',
+        description: _t("Average amount of t-shirt"),
+        Component: NumberCard,
+        size: 3,
+        props: data => ({
+            title: _t("Average amount of t-shirt by order this month"),
+            value: data.average_quantity,
+        }),
+    },
+    {
+        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,
+        }),
+    },
+    {
+        id: 'nb_new_orders',
+        description: _t("Number of new orders"),
+        Component: NumberCard,
+        props: data => ({
+            title: _t("Number of new orders this month"),
+            value: data.nb_new_orders,
+        }),
+    },
+    {
+        id: 'nb_cancelled_orders',
+        description: _t("Number of cancelled orders"),
+        Component: NumberCard,
+        props: data => ({
+            title: _t("Number of cancelled orders this month"),
+            value: data.nb_cancelled_orders,
+        }),
+    },
+    {
+        id: 'total_amount',
+        description: _t("Total amount of new orders"),
+        Component: NumberCard,
+        props: data => ({
+            title: _t("Total amount of new orders this month"),
+            value: data.total_amount,
+        }),
+    },
+    {
+        id: 'orders_by_size',
+        description: _t("Orders by size"),
+        Component: PieChartCard,
+        props: data => ({
+            title: _t("Shirt orders by size"),
+            value: data.orders_by_size,
+        }),
+    },
+];
+
+for (const item of items) {
+    dashboardItemRegistry.add(item.id, item);
+}

awesome_dashboard/static/src/dashboard/dashboard_items_dialog/dashboard_items_dialog.js

@@ -0,0 +1,50 @@
+import { Component, useState } from "@odoo/owl";
+import { Dialog } from "@web/core/dialog/dialog";
+
+export class DashboardItemsDialog extends Component {
+    static template = 'awesome_dashboard.DashboardItemsDialog';
+    static components = { Dialog };
+    static props = {
+        items: {
+            type: Array,
+            element: {
+                type: Object,
+                shape: {
+                    id: String,
+                    description: String,
+                    "*": true,
+                },
+            },
+        },
+        excludedItems: {
+            type: Array,
+            element: String,
+        },
+        close: Function,
+        onApply: Function,
+    };
+
+    setup() {
+        this.state = useState({
+            items: this.props.items.map(
+                item => ({
+                    ...item,
+                    checked: !this.props.excludedItems.includes(item.id),
+                }),
+            ),
+        });
+    }
+
+    toggle(event) {
+        const index = this.state.items.findIndex(item => item.id === event.target.name);
+        if (index !== -1) {
+            this.state.items[index].checked = !this.state.items[index].checked;
+        }
+    }
+
+    apply() {
+        const newExcludedItems = this.state.items.filter(item => !item.checked).map(item => item.id);
+        this.props.onApply(newExcludedItems);
+        this.props.close();
+    }
+}

awesome_dashboard/static/src/dashboard/dashboard_items_dialog/dashboard_items_dialog.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+
+    <t t-name="awesome_dashboard.DashboardItemsDialog">
+        <Dialog>
+            <t t-set-slot="header">
+                <h1 class="modal-title fs-5" id="dashboardItemsDialogTitle">Dashboard items configuration</h1>
+                <button type="button" class="btn-close" aria-label="Close" t-on-click="props.close"/>
+            </t>
+            <p>Which cards do you wish to see?</p>
+            <p t-foreach="state.items" t-as="item" t-key="item.id">
+                <input t-att-name="item.id" type="checkbox" t-on-change="toggle" t-att-checked="item.checked"/>
+                <label><t t-esc="item.description"/></label>
+            </p>
+            <t t-set-slot="footer">
+                <button type="button" class="btn btn-primary" t-on-click="apply">Apply</button>
+            </t>
+        </Dialog>
+    </t>
+</templates>

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,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+
+    <t t-name="awesome_dashboard.NumberCard">
+        <p class="stats-name"><t t-esc="props.title"/></p>
+        <p class="stats-number"><t t-esc="props.value"/></p>
+    </t>
+</templates>

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

@@ -0,0 +1,50 @@
+import { Component, onWillStart, onMounted, onWillUnmount, useEffect, useRef } from "@odoo/owl";
+import { loadJS } from "@web/core/assets";
+
+export class PieChart extends Component {
+    static template = 'awesome_dashboard.PieChart';
+    static props = {
+        data: Object,
+    };
+
+    setup() {
+        const canvasRef = useRef('canvas');
+
+        onWillStart(async () => {
+            await loadJS('/web/static/lib/Chart/Chart.js');
+        });
+
+        onMounted(() => {
+            const canvas = canvasRef.el;
+            const ctx = canvas.getContext('2d');
+            this.chart = new Chart(ctx, {
+                type: 'pie',
+                data: {
+                    labels: Object.keys(this.props.data),
+                    datasets: [
+                        {
+                            data: Object.values(this.props.data),
+                        },
+                    ],
+                },
+                options: {},
+            });
+            this.chart.update();
+        });
+
+        useEffect(
+            data => {
+                this.chart.data.labels = Object.keys(data);
+                this.chart.data.datasets[0].data = Object.values(data);
+                this.chart.update();
+            },
+            () => [this.props.data],
+        );
+
+        onWillUnmount(() => {
+            if (this.chart) {
+                this.chart.destroy();
+            }
+        });
+    }
+}