@six-group/ui-library 4.3.3 → 5.0.0-rc.1

package/dist/collection/components/six-dropdown/six-dropdown.js

@@ -23,7 +23,62 @@ export class SixDropdown {
         this.componentId = `dropdown-${++id}`;
         this.isVisible = false;
         this.resizeObserver = new ResizeObserver(debounce(() => this.updatePanelPosition(), 100));
+        /** Indicates whether the dropdown is open. You can use this in lieu of the show/hide methods. */
+        this.open = false;
+        /**
+         * The preferred placement of the dropdown panel. Note that the actual placement may vary as needed to keep the panel
+         * inside the viewport.
+         */
+        this.placement = 'bottom-start';
+        /** Determines whether the dropdown should hide when a menu item is selected. */
+        // eslint-disable-next-line @stencil-community/ban-default-true
+        this.closeOnSelect = true;
+        /** The distance in pixels from which to offset the panel away from its trigger. */
+        this.distance = 4;
+        /** The distance in pixels from which to offset the panel along its trigger. */
+        this.skidding = 0;
+        /**
+         * Enable this option to prevent the panel from being clipped when the component is placed inside a container with
+         * `overflow: auto|scroll`.
+         */
+        this.hoist = false;
+        /**
+         * Set to true to allow auto filtering for entries in the dropdown.
+         * With this flag the dropdown will automatically filter itsel.
+         * If you need to coordinate the shown elements yourself,
+         * e.g. because you need to call an endpoint use asyncFilter instead
+         */
+        this.filter = false;
+        /**
+         * Set to true to allow async filtering.
+         * When you enter something in the search field the component will only emit an event but not filter any elements itself.
+         * You can then simply listen to the 'six-async-filter-fired' event to manage the shown menu-items yourself
+         */
+        this.asyncFilter = false;
+        /** The filter's placeholder text. */
+        this.filterPlaceholder = 'Filter...';
+        /** By default the search field will be focused when opening a dropdown with filtering enabled. */
+        // eslint-disable-next-line @stencil-community/ban-default-true
+        this.autofocusFilter = true;
+        /** The debounce for the filter callbacks. */
+        this.filterDebounce = 0;
+        /** The panel can be opend/closed by pressing the spacebar or the enter key. In some cases you might want to avoid this */
+        this.disableHideOnEnterAndSpace = false;
+        /** Set the options to be shown in the dropdown (alternative to setting the elements via html)*/
+        this.options = [];
+        /** Defines whether the menu list will be rendered virtually i.e. only the elements actually shown (and a couple around)
+         *  are actually rendered in the DOM. If you use virtual scrolling pass the elements via prop instead of via slot. */
+        this.virtualScroll = false;
+        /**
+         * Determines if the dropdown panel's width should match the width of the trigger element.
+         *
+         * If set to `true`, the panel will resize its width to align with the trigger's width.
+         * If `false` or omitted, the panel will maintain its default width.
+         */
+        this.matchTriggerWidth = false;
         this.eventListeners = new EventListeners();
+        // internal representation of options, so we don't have to make options mutable
+        this.renderedOptions = [];
         this.getMenuItems = () => {
             var _a, _b, _c, _d;
             if (this.options.length > 0) {
@@ -181,23 +236,6 @@ export class SixDropdown {
                 scrollRatio: this.scrollPanel.scrollTop / (this.scrollPanel.scrollHeight - this.scrollPanel.clientHeight),
             });
         };
-        this.open = false;
-        this.placement = 'bottom-start';
-        this.closeOnSelect = true;
-        this.distance = 4;
-        this.skidding = 0;
-        this.hoist = false;
-        this.containingElement = undefined;
-        this.filter = false;
-        this.asyncFilter = false;
-        this.filterPlaceholder = 'Filter...';
-        this.autofocusFilter = true;
-        this.filterDebounce = 0;
-        this.disableHideOnEnterAndSpace = false;
-        this.options = [];
-        this.virtualScroll = false;
-        this.matchTriggerWidth = false;
-        this.renderedOptions = [];
     }
     get filterEnabled() {
         return this.filter || this.asyncFilter;
@@ -210,9 +248,9 @@ export class SixDropdown {
         this.updateAccessibleTrigger();
     }
     handlePopoverOptionsChange() {
-        if (this.popover == null)
+        if (this.popoverHelper == null)
             return;
-        this.popover.setOptions({
+        this.popoverHelper.setOptions({
             strategy: this.hoist ? 'fixed' : 'absolute',
             placement: this.placement,
             distance: this.distance,
@@ -312,7 +350,7 @@ export class SixDropdown {
     initPopover() {
         if (this.trigger == null || this.positioner == null)
             return;
-        this.popover = new Popover(this.trigger, this.positioner, {
+        this.popoverHelper = new Popover(this.trigger, this.positioner, {
             strategy: this.hoist ? 'fixed' : 'absolute',
             placement: this.placement,
             distance: this.distance,
@@ -339,13 +377,13 @@ export class SixDropdown {
         this.resizeObserver.disconnect();
         this.eventListeners.removeAll();
         void this.hide();
-        (_a = this.popover) === null || _a === void 0 ? void 0 : _a.destroy();
-        this.popover = undefined;
+        (_a = this.popoverHelper) === null || _a === void 0 ? void 0 : _a.destroy();
+        this.popoverHelper = undefined;
     }
     /** Shows the dropdown panel */
     async show() {
         // Prevent subsequent calls to the method, whether manually or triggered by the `open` watcher
-        if (this.isVisible || this.popover == null || this.panel == null) {
+        if (this.isVisible || this.popoverHelper == null || this.panel == null) {
             return;
         }
         const sixShow = this.sixShow.emit();
@@ -362,7 +400,7 @@ export class SixDropdown {
             this.resizeObserver.observe(this.trigger);
         }
         this.updatePanelPosition();
-        this.popover.show();
+        this.popoverHelper.show();
         if (this.filterEnabled && this.autofocusFilter) {
             requestAnimationFrame(() => {
                 var _a;
@@ -381,15 +419,15 @@ export class SixDropdown {
             const width = this.trigger.getBoundingClientRect().width;
             this.panel.style.minWidth = `${width}px`;
         }
-        if (this.popover != null) {
-            this.popover.reposition();
+        if (this.popoverHelper != null) {
+            this.popoverHelper.reposition();
         }
     }
     /** Hides the dropdown panel */
     async hide() {
         this.resizeObserver.disconnect();
         // Prevent subsequent calls to the method, whether manually or triggered by the `open` watcher
-        if (!this.isVisible || this.panel == null || this.popover == null) {
+        if (!this.isVisible || this.panel == null || this.popoverHelper == null) {
             return;
         }
         const sixHide = this.sixHide.emit();
@@ -402,7 +440,7 @@ export class SixDropdown {
         this.eventListeners.remove(document, 'mousedown', this.handleDocumentMouseDown);
         this.isVisible = false;
         this.open = false;
-        this.popover.hide();
+        this.popoverHelper.hide();
     }
     focusOnTrigger() {
         var _a;
@@ -422,17 +460,6 @@ export class SixDropdown {
         var _a;
         return (_a = this.panelSlot) === null || _a === void 0 ? void 0 : _a.assignedElements({ flatten: true }).filter(isSixMenu).at(0);
     }
-    /**
-     * Instructs the dropdown menu to reposition. Useful when the position or size of the trigger changes when the menu
-     * is activated.
-     *
-     * @deprecated: use the property `matchTriggerWidth` instead.
-     */
-    async reposition() {
-        if (this.open && this.popover != null) {
-            this.popover.reposition();
-        }
-    }
     //
     // Slotted triggers can be arbitrary content, but we need to link them to the dropdown panel with `aria-haspopup` and
     // `aria-expanded`. These must be applied to the "accessible trigger" (the tabbable portion of the trigger element
@@ -455,19 +482,19 @@ export class SixDropdown {
         }
     }
     render() {
-        return (h("div", { key: '26cba1568dfda35efa2791df5c2228aa51201fb9', part: "base", id: this.componentId, class: {
+        return (h("div", { key: '46305375a199fb17ae66ca3b6678634844d0b8a2', part: "base", id: this.componentId, class: {
                 dropdown: true,
                 'dropdown--open': this.open,
-            } }, h("span", { key: '5bd9acd7e1470a88158b233df327090cccaf6707', part: "trigger", class: "dropdown__trigger", ref: (el) => (this.trigger = el), onClick: this.handleTriggerClick, onKeyDown: this.handleTriggerKeyDown, onKeyUp: this.handleTriggerKeyUp }, h("slot", { key: 'ab3915fb99a943f5e1ab8b9ad6c0339e6312614f', name: "trigger", ref: (el) => (this.triggerSlot = el), onSlotchange: this.handleTriggerSlotChange })), h("div", { key: 'f9615d2a48275ce167a683ffc5b6f1b4f3945732', ref: (el) => (this.positioner = el), class: {
+            } }, h("span", { key: '2a53d2cf2b75607614f39675cabfe1362b297e70', part: "trigger", class: "dropdown__trigger", ref: (el) => (this.trigger = el), onClick: this.handleTriggerClick, onKeyDown: this.handleTriggerKeyDown, onKeyUp: this.handleTriggerKeyUp }, h("slot", { key: 'd8abcd455c768fded48df4c18b8191e365db4ab1', name: "trigger", ref: (el) => (this.triggerSlot = el), onSlotchange: this.handleTriggerSlotChange })), h("div", { key: 'fd0e0352800daebdc9843442901cad9769d3199a', ref: (el) => (this.positioner = el), class: {
                 dropdown__positioner: true,
                 dropdown__positioner__filtered: (this.filter || this.asyncFilter) && !this.hoist,
-            } }, h("div", { key: '121185720985a0650aa7a03d697fa66bb9752c35', ref: (el) => (this.panel = el), part: "panel", class: "dropdown__panel", role: "menu", "aria-hidden": this.open ? 'false' : 'true', "aria-labelledby": this.componentId }, this.filterEnabled && (h("six-input", { key: '7422f2a0179806aa116c7ae42aa71bcb79167395', class: {
+            } }, h("div", { key: '2d72ca0ba1a5cbb480727e325048f7a171fb7af8', ref: (el) => (this.panel = el), part: "panel", class: "dropdown__panel", role: "menu", "aria-hidden": this.open ? 'false' : 'true', "aria-labelledby": this.componentId }, this.filterEnabled && (h("six-input", { key: 'a22263fb924be51081598579391774c82a09852f', class: {
                 filter: true,
                 'filter-hidden': !this.open,
-            }, "dropdown-search": true, "aria-hidden": this.open ? 'false' : 'true', ref: (el) => (this.filterInputElement = el), placeholder: this.filterPlaceholder }, h("six-icon", { key: '5e22ddbdb949c2ec389bb238202e02e0b5905c66', class: "filter__icon", slot: "suffix", size: "small" }, "search"))), h("div", { key: '3212216bf8a156711ff7ea68ce916626146c1828', class: {
+            }, "dropdown-search": true, "aria-hidden": this.open ? 'false' : 'true', ref: (el) => (this.filterInputElement = el), placeholder: this.filterPlaceholder }, h("six-icon", { key: '7a8fc9e25e7e209b5b0aa05af5dcefca87e3b9d5', class: "filter__icon", slot: "suffix", size: "small" }, "search"))), h("div", { key: 'bedcab39d656be8ce064852ef9344b4fbbf60b17', class: {
                 dropdown__panel__scroll: true,
                 'dropdown__panel__scroll--virtual': this.virtualScroll,
-            }, onScroll: this.handleDropdownScroll, ref: (el) => (this.scrollPanel = el) }, h("slot", { key: '37626706d68beb0e3894e5db14af370a7433e5e0', ref: (el) => (this.panelSlot = el) }), this.options.length > 0 && (h("six-menu", { key: '014217ffca577be6a6d46aa212df955eb93f3233', part: "menu", items: this.renderedOptions, virtualScroll: this.virtualScroll }))), h("slot", { key: 'a9fd4bc79298e9e720f9608717dec61c3bbc3100', name: "dropdown-footer" })))));
+            }, onScroll: this.handleDropdownScroll, ref: (el) => (this.scrollPanel = el) }, h("slot", { key: '21acba56de1fba98afdfda60e8b09816a70ac057', ref: (el) => (this.panelSlot = el) }), this.options.length > 0 && (h("six-menu", { key: 'd7d429d062bf111ffdaf667ada0efe640136871a', part: "menu", items: this.renderedOptions, virtualScroll: this.virtualScroll }))), h("slot", { key: 'e23be3aa659ed7fa4a513d82c982733b58a6e9db', name: "dropdown-footer" })))));
     }
     static get is() { return "six-dropdown"; }
     static get encapsulation() { return "shadow"; }
@@ -485,6 +512,7 @@ export class SixDropdown {
         return {
             "open": {
                 "type": "boolean",
+                "attribute": "open",
                 "mutable": true,
                 "complexType": {
                     "original": "boolean",
@@ -497,12 +525,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "Indicates whether the dropdown is open. You can use this in lieu of the show/hide methods."
                 },
-                "attribute": "open",
+                "getter": false,
+                "setter": false,
                 "reflect": true,
                 "defaultValue": "false"
             },
             "placement": {
                 "type": "string",
+                "attribute": "placement",
                 "mutable": false,
                 "complexType": {
                     "original": "| 'top'\n    | 'top-start'\n    | 'top-end'\n    | 'bottom'\n    | 'bottom-start'\n    | 'bottom-end'\n    | 'right'\n    | 'right-start'\n    | 'right-end'\n    | 'left'\n    | 'left-start'\n    | 'left-end'",
@@ -515,12 +545,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "The preferred placement of the dropdown panel. Note that the actual placement may vary as needed to keep the panel\ninside the viewport."
                 },
-                "attribute": "placement",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'bottom-start'"
             },
             "closeOnSelect": {
                 "type": "boolean",
+                "attribute": "close-on-select",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -533,12 +565,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "Determines whether the dropdown should hide when a menu item is selected."
                 },
-                "attribute": "close-on-select",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "distance": {
                 "type": "number",
+                "attribute": "distance",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -551,12 +585,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "The distance in pixels from which to offset the panel away from its trigger."
                 },
-                "attribute": "distance",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "4"
             },
             "skidding": {
                 "type": "number",
+                "attribute": "skidding",
                 "mutable": false,
                 "complexType": {
                     "original": "number",
@@ -569,12 +605,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "The distance in pixels from which to offset the panel along its trigger."
                 },
-                "attribute": "skidding",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "0"
             },
             "hoist": {
                 "type": "boolean",
+                "attribute": "hoist",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -587,12 +625,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "Enable this option to prevent the panel from being clipped when the component is placed inside a container with\n`overflow: auto|scroll`."
                 },
-                "attribute": "hoist",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "containingElement": {
                 "type": "unknown",
+                "attribute": "containing-element",
                 "mutable": false,
                 "complexType": {
                     "original": "HTMLElement",
@@ -609,10 +649,13 @@ export class SixDropdown {
                 "docs": {
                     "tags": [],
                     "text": "The dropdown will close when the user interacts outside of this element (e.g. clicking)."
-                }
+                },
+                "getter": false,
+                "setter": false
             },
             "filter": {
                 "type": "boolean",
+                "attribute": "filter",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -625,12 +668,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "Set to true to allow auto filtering for entries in the dropdown.\nWith this flag the dropdown will automatically filter itsel.\nIf you need to coordinate the shown elements yourself,\ne.g. because you need to call an endpoint use asyncFilter instead"
                 },
-                "attribute": "filter",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "asyncFilter": {
                 "type": "boolean",
+                "attribute": "async-filter",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -643,12 +688,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "Set to true to allow async filtering.\nWhen you enter something in the search field the component will only emit an event but not filter any elements itself.\nYou can then simply listen to the 'six-async-filter-fired' event to manage the shown menu-items yourself"
                 },
-                "attribute": "async-filter",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "filterPlaceholder": {
                 "type": "string",
+                "attribute": "filter-placeholder",
                 "mutable": false,
                 "complexType": {
                     "original": "string",
@@ -661,12 +708,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "The filter's placeholder text."
                 },
-                "attribute": "filter-placeholder",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "'Filter...'"
             },
             "autofocusFilter": {
                 "type": "boolean",
+                "attribute": "autofocus-filter",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -679,12 +728,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "By default the search field will be focused when opening a dropdown with filtering enabled."
                 },
-                "attribute": "autofocus-filter",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "true"
             },
             "filterDebounce": {
                 "type": "number",
+                "attribute": "filter-debounce",
                 "mutable": true,
                 "complexType": {
                     "original": "number",
@@ -697,12 +748,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "The debounce for the filter callbacks."
                 },
-                "attribute": "filter-debounce",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "0"
             },
             "disableHideOnEnterAndSpace": {
                 "type": "boolean",
+                "attribute": "disable-hide-on-enter-and-space",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -715,12 +768,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "The panel can be opend/closed by pressing the spacebar or the enter key. In some cases you might want to avoid this"
                 },
-                "attribute": "disable-hide-on-enter-and-space",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "options": {
                 "type": "unknown",
+                "attribute": "options",
                 "mutable": true,
                 "complexType": {
                     "original": "SixMenuItemData[]",
@@ -739,10 +794,13 @@ export class SixDropdown {
                     "tags": [],
                     "text": "Set the options to be shown in the dropdown (alternative to setting the elements via html)"
                 },
+                "getter": false,
+                "setter": false,
                 "defaultValue": "[]"
             },
             "virtualScroll": {
                 "type": "boolean",
+                "attribute": "virtual-scroll",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -755,12 +813,14 @@ export class SixDropdown {
                     "tags": [],
                     "text": "Defines whether the menu list will be rendered virtually i.e. only the elements actually shown (and a couple around)\nare actually rendered in the DOM. If you use virtual scrolling pass the elements via prop instead of via slot."
                 },
-                "attribute": "virtual-scroll",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             },
             "matchTriggerWidth": {
                 "type": "boolean",
+                "attribute": "match-trigger-width",
                 "mutable": false,
                 "complexType": {
                     "original": "boolean",
@@ -773,7 +833,8 @@ export class SixDropdown {
                     "tags": [],
                     "text": "Determines if the dropdown panel's width should match the width of the trigger element.\n\nIf set to `true`, the panel will resize its width to align with the trigger's width.\nIf `false` or omitted, the panel will maintain its default width."
                 },
-                "attribute": "match-trigger-width",
+                "getter": false,
+                "setter": false,
                 "reflect": false,
                 "defaultValue": "false"
             }
@@ -969,26 +1030,6 @@ export class SixDropdown {
                     "text": "Hides the dropdown panel",
                     "tags": []
                 }
-            },
-            "reposition": {
-                "complexType": {
-                    "signature": "() => Promise<void>",
-                    "parameters": [],
-                    "references": {
-                        "Promise": {
-                            "location": "global",
-                            "id": "global::Promise"
-                        }
-                    },
-                    "return": "Promise<void>"
-                },
-                "docs": {
-                    "text": "Instructs the dropdown menu to reposition. Useful when the position or size of the trigger changes when the menu\nis activated.",
-                    "tags": [{
-                            "name": "deprecated",
-                            "text": ": use the property `matchTriggerWidth` instead."
-                        }]
-                }
             }
         };
     }