summaryrefslogtreecommitdiff
path: root/addons/web/static/src/js/components/dropdown_menu_item.js
blob: bcc54ab4ffb40eac6f8baf77bc46a9d0fe894712 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
odoo.define('web.DropdownMenuItem', function (require) {
    "use strict";

    const { useListener } = require('web.custom_hooks');

    const { Component, hooks } = owl;
    const { useExternalListener, useRef, useState } = hooks;

    /**
     * Dropdown menu item
     *
     * Generic component instantiated by a dropdown menu (@see DropdownMenu) in
     * the absence of `Component` and `props` keys in a given item object.
     *
     * In its simplest form, a dropdown menu item will be given a description (optional,
     * but highly recommended) and will trigger a 'select-item' when clicked on.
     * Additionaly it can receive the following props:
     * - isActive: will add a `checked` symbol on the left side of the item
     * - removable: will add a `remove` trash icon on the right side of the item.
     *              when clicked, will trigger a 'remove-item' event.
     * - options: will change the behaviour of the item ; instead of triggering
     *            an event, the item will act as a nested dropdown menu and display
     *            its given options. These will have the same definition as another
     *            dropdown item but cannot have options of their own.
     *
     * It is recommended to extend this class when defining a Component which will
     * be put inside of a dropdown menu (@see CustomFilterItem as example).
     * @extends Component
     */
    class DropdownMenuItem extends Component {
        constructor() {
            super(...arguments);

            this.canBeOpened = Boolean(this.props.options && this.props.options.length);

            this.fallbackFocusRef = useRef('fallback-focus');
            this.state = useState({ open: false });

            useExternalListener(window, 'click', this._onWindowClick);
            useListener('keydown', this._onKeydown);
        }

        //---------------------------------------------------------------------
        // Handlers
        //---------------------------------------------------------------------

        /**
         * @private
         * @param {KeyboardEvent} ev
         */
        _onKeydown(ev) {
            if (['INPUT', 'TEXTAREA'].includes(document.activeElement.tagName)) {
                return;
            }
            switch (ev.key) {
                case 'ArrowLeft':
                    if (this.canBeOpened && this.state.open) {
                        ev.preventDefault();
                        if (this.fallbackFocusRef.el) {
                            this.fallbackFocusRef.el.focus();
                        }
                        this.state.open = false;
                    }
                    break;
                case 'ArrowRight':
                    if (this.canBeOpened && !this.state.open) {
                        ev.preventDefault();
                        this.state.open = true;
                    }
                    break;
                case 'Escape':
                    ev.target.blur();
                    if (this.canBeOpened && this.state.open) {
                        ev.preventDefault();
                        ev.stopPropagation();
                        if (this.fallbackFocusRef.el) {
                            this.fallbackFocusRef.el.focus();
                        }
                        this.state.open = false;
                    }
            }
        }

        /**
         * @private
         * @param {MouseEvent} ev
         */
        _onWindowClick(ev) {
            if (
                this.state.open &&
                !this.el.contains(ev.target) &&
                !this.el.contains(document.activeElement)
            ) {
                this.state.open = false;
            }
        }
    }

    DropdownMenuItem.template = 'web.DropdownMenuItem';

    return DropdownMenuItem;
});