@six-group/ui-library 0.0.0-insider.9277796 → 0.0.0-insider.d16ec8e

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

@@ -1,5 +1,4 @@
 import { h } from '@stencil/core';
-import { scrollIntoView } from '../../utils/scroll';
 import { getNearestTabbableElement } from '../../utils/tabbable';
 import Popover from '../../utils/popover';
 import { EventListeners } from '../../utils/event-listeners';
@@ -29,23 +28,154 @@ export class SixDropdown {
     this.hasBeenInitialized = false;
     this.eventListeners = new EventListeners();
     this.getMenuItems = () => {
-      if (this._options !== null) {
-        return this._options.map((option) => h("six-menu-item", { value: option.value }, option.label));
+      if (this.filteredOptions.length > 0) {
+        return this.filteredOptions.map((option) => h("six-menu-item", { value: option.value }, option.label));
       }
+      if (this.panel == null)
+        return [];
       const [panel] = getSlotChildren(this.panel);
       // the menu-items can be in a slot e.g. in six-select or direct children of the panel
       return getSlotChildren(panel) || Array.from(panel.querySelectorAll('six-menu-item'));
     };
     this.handleFilterInputChange = () => {
       var _a, _b;
+      if (this.filterInputElement == null)
+        return;
       const lowerCaseFilterTerm = ((_b = (_a = this.filterInputElement.value) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === null || _b === void 0 ? void 0 : _b.trim()) || '';
-      if (this._options) {
+      if (this.filteredOptions.length > 0) {
         this.handleFilteringForAttributeItems(lowerCaseFilterTerm);
       }
       else {
         this.handleFilteringForSlotItems(lowerCaseFilterTerm);
       }
-      this.sixAutoFilterFired.emit({ filterValue: lowerCaseFilterTerm });
+      this.sixAutoFilter.emit({ filterValue: lowerCaseFilterTerm });
+    };
+    this.handleDocumentKeyDown = (event) => {
+      var _a;
+      const keyboardEvent = event;
+      // Close when escape is pressed
+      if (keyboardEvent.key === 'Escape') {
+        void this.hide();
+        this.focusOnTrigger();
+        return;
+      }
+      if (this.filterInputElement === ((_a = this.host.shadowRoot) === null || _a === void 0 ? void 0 : _a.activeElement)) {
+        if (keyboardEvent.key === 'ArrowDown') {
+          const item = this.getMenuItems().find((item) => item.style.display !== 'none');
+          if (item != null) {
+            item.setFocus();
+          }
+        }
+      }
+      // Handle tabbing
+      if (keyboardEvent.key === 'Tab') {
+        // Tabbing within an open menu should close the dropdown and refocus the trigger
+        if (this.open && document.activeElement != null && isSixMenuItem(document.activeElement)) {
+          keyboardEvent.preventDefault();
+          void this.hide();
+          this.focusOnTrigger();
+          return;
+        }
+        // Tabbing outside the containing element closes the panel
+        //
+        // If the dropdown is used within a shadow DOM, we need to obtain the activeElement within that shadowRoot,
+        // otherwise `document.activeElement` will only return the name of the parent shadow DOM element.
+        setTimeout(() => {
+          var _a, _b;
+          const activeElement = this.container.getRootNode() instanceof ShadowRoot
+            ? (_b = (_a = document.activeElement) === null || _a === void 0 ? void 0 : _a.shadowRoot) === null || _b === void 0 ? void 0 : _b.activeElement
+            : document.activeElement;
+          if ((activeElement === null || activeElement === void 0 ? void 0 : activeElement.closest(this.container.tagName.toLowerCase())) !== this.container) {
+            void this.hide();
+            return;
+          }
+        });
+      }
+    };
+    this.handleDocumentMouseDown = (event) => {
+      // Close when clicking outside the containing element
+      const path = event.composedPath();
+      if (!path.includes(this.container)) {
+        void this.hide();
+        return;
+      }
+    };
+    this.handlePanelSelect = (event) => {
+      const target = event.target;
+      // Hide the dropdown when a menu item is selected
+      if (this.closeOnSelect && isSixMenu(target)) {
+        void this.hide();
+        this.focusOnTrigger();
+      }
+    };
+    this.handleTriggerClick = () => {
+      this.open ? this.hide() : this.show();
+    };
+    this.handleTriggerKeyDown = (event) => {
+      // Close when escape or tab is pressed
+      if (event.key === 'Escape') {
+        this.focusOnTrigger();
+        void this.hide();
+        return;
+      }
+      // When spacebar/enter is pressed, show the panel but don't focus on the menu. This let's the user press the same
+      // key again to hide the menu in case they don't want to make a selection.
+      if (!this.disableHideOnEnterAndSpace && [' ', 'Enter'].includes(event.key)) {
+        event.preventDefault();
+        this.open ? void this.hide() : void this.show();
+        return;
+      }
+      const menu = this.getMenu();
+      // When up/down is pressed, we make the assumption that the user is familiar with the menu and plans to make a
+      // selection. Rather than toggle the panel, we focus on the menu (if one exists) and activate the first item for
+      // faster navigation.
+      if (['ArrowDown', 'ArrowUp'].includes(event.key)) {
+        event.preventDefault();
+        // Show the menu if it's not already open
+        if (!this.open) {
+          void this.show();
+        }
+        if (menu == null) {
+          return;
+        }
+        const menuItems = [...menu.querySelectorAll('six-menu-item')];
+        const firstMenuItem = menuItems.at(0);
+        const lastMenuItem = menuItems.at(menuItems.length - 1);
+        // Focus on a menu item
+        if (event.key === 'ArrowDown' && firstMenuItem != null) {
+          firstMenuItem.setFocus();
+          return;
+        }
+        if (event.key === 'ArrowUp' && lastMenuItem != null) {
+          lastMenuItem.setFocus();
+          return;
+        }
+      }
+      // Other keys bring focus to the menu and initiate type-to-select behavior
+      const ignoredKeys = ['Tab', 'Shift', 'Meta', 'Ctrl', 'Alt'];
+      if (this.open && menu != null && !ignoredKeys.includes(event.key)) {
+        void menu.typeToSelect(event.key);
+        return;
+      }
+    };
+    this.handleTriggerKeyUp = (event) => {
+      // Prevent space from triggering a click event in Firefox
+      if (event.key === ' ') {
+        event.preventDefault();
+      }
+    };
+    this.handleTriggerSlotChange = () => {
+      this.updateAccessibleTrigger();
+    };
+    this.handleDropdownScroll = () => {
+      if (this.panel == null)
+        return;
+      this.sixScroll.emit({
+        scrollHeight: this.panel.scrollHeight,
+        scrollTop: this.panel.scrollTop,
+        scrollbarHeight: this.panel.offsetHeight * (this.panel.offsetHeight / this.panel.scrollHeight),
+        scrollRatio: this.panel.scrollTop / (this.panel.scrollHeight - this.panel.clientHeight),
+      });
     };
     this.open = false;
     this.placement = 'bottom-start';
@@ -60,9 +190,9 @@ export class SixDropdown {
     this.autofocusFilter = true;
     this.filterDebounce = DEFAULT_DEBOUNCE_FAST;
     this.disableHideOnEnterAndSpace = false;
-    this.options = null;
+    this.options = [];
     this.virtualScroll = false;
-    this._options = null;
+    this.filteredOptions = [];
   }
   get hasFilterEnabled() {
     return this.filter || this.asyncFilter;
@@ -75,6 +205,8 @@ export class SixDropdown {
     this.updateAccessibleTrigger();
   }
   handlePopoverOptionsChange() {
+    if (this.popover == null)
+      return;
     this.popover.setOptions({
       strategy: this.hoist ? 'fixed' : 'absolute',
       placement: this.placement,
@@ -83,25 +215,18 @@ export class SixDropdown {
     });
   }
   handleOptionsChange() {
-    this._options = [...this.options];
+    if (Array.isArray(this.options)) {
+      this.filteredOptions = [...this.options];
+    }
   }
   connectedCallback() {
     if (this.virtualScroll && this.options === null) {
       console.error('Options must be defined when using virtual scrolling');
     }
-    if (this.options !== null) {
-      this._options = [...this.options];
+    if (Array.isArray(this.options)) {
+      this.filteredOptions = [...this.options];
     }
-    this.handleDocumentKeyDown = this.handleDocumentKeyDown.bind(this);
-    this.handleDocumentMouseDown = this.handleDocumentMouseDown.bind(this);
-    this.handleMenuItemActivate = this.handleMenuItemActivate.bind(this);
-    this.handlePanelSelect = this.handlePanelSelect.bind(this);
-    this.handleTriggerClick = this.handleTriggerClick.bind(this);
-    this.handleTriggerKeyDown = this.handleTriggerKeyDown.bind(this);
-    this.handleTriggerKeyUp = this.handleTriggerKeyUp.bind(this);
-    this.handleTriggerSlotChange = this.handleTriggerSlotChange.bind(this);
-    this.handleDropdownScroll = this.handleDropdownScroll.bind(this);
-    if (this.hasBeenInitialized && !this.popover) {
+    if (this.hasBeenInitialized && this.popover == null) {
       // there was a weird bug when using six-dropdown inside an ag-grid filter. When closing the ag-grid filter
       // disconnectedCallback() is executed. However, since componentDidLoad() will not be rerendered the popover had
       // no longer a connected transitionEnd callback to the dropdown. To fix this, we have this sanity check here,
@@ -120,15 +245,17 @@ export class SixDropdown {
       this.setupFiltering(this.handleFilterInputChange);
     }
     else if (this.asyncFilter) {
-      this.setupFiltering(() => this.sixAsyncFilterFired.emit({ filterValue: this.filterInputElement.value }));
+      this.setupFiltering(() => { var _a, _b; return this.sixAsyncFilterFired.emit({ filterValue: (_b = (_a = this.filterInputElement) === null || _a === void 0 ? void 0 : _a.value) !== null && _b !== void 0 ? _b : '' }); });
     }
   }
   initializePopover() {
+    if (this.trigger == null || this.positioner == null)
+      return;
     const onAfterHide = () => {
-      if (this.filter) {
+      if (this.filter && this.filterInputElement != null) {
         this.filterInputElement.value = '';
-        if (this._options !== null) {
-          this._options = [...this.options];
+        if (this.filteredOptions.length > 0) {
+          this.filteredOptions = [...this.options];
         }
         else {
           const menuItems = this.getMenuItems();
@@ -138,14 +265,15 @@ export class SixDropdown {
       this.sixAfterHide.emit();
     };
     const onAfterShow = async () => {
+      var _a;
       if (this.hasFilterEnabled && this.autofocusFilter) {
         // if dropdown filter is enabled we should autofocus the search field
-        await this.filterInputElement.setFocus();
+        await ((_a = this.filterInputElement) === null || _a === void 0 ? void 0 : _a.setFocus());
       }
       this.sixAfterShow.emit();
     };
     const onTransitionEnd = () => {
-      if (!this.open) {
+      if (!this.open && this.panel != null) {
         this.panel.scrollTop = 0;
       }
     };
@@ -161,14 +289,16 @@ export class SixDropdown {
     });
   }
   setupFiltering(callback) {
-    this.eventListeners.add(this.filterInputElement, 'six-input-input', debounce(callback, this.filterDebounce));
+    if (this.filterInputElement != null) {
+      this.eventListeners.add(this.filterInputElement, 'six-input-input', debounce(callback, this.filterDebounce));
+    }
   }
   handleFilteringForAttributeItems(lowerCaseFilterTerm) {
-    if (lowerCaseFilterTerm === '') {
-      this._options = [...this.options];
+    if (lowerCaseFilterTerm === '' && Array.isArray(this.options)) {
+      this.filteredOptions = [...this.options];
       return;
     }
-    this._options = this.options.filter((option) => {
+    this.filteredOptions = this.options.filter((option) => {
       var _a, _b, _c, _d;
       return (option.label && ((_b = (_a = String(option.label)) === null || _a === void 0 ? void 0 : _a.toLowerCase()) === null || _b === void 0 ? void 0 : _b.includes(lowerCaseFilterTerm))) ||
         (option.value && ((_d = (_c = String(option.value)) === null || _c === void 0 ? void 0 : _c.toLowerCase()) === null || _d === void 0 ? void 0 : _d.includes(lowerCaseFilterTerm)));
@@ -185,15 +315,16 @@ export class SixDropdown {
     });
   }
   disconnectedCallback() {
+    var _a;
     this.eventListeners.removeAll();
     void this.hide();
-    this.popover.destroy();
-    this.popover = null;
+    (_a = this.popover) === null || _a === void 0 ? void 0 : _a.destroy();
+    this.popover = undefined;
   }
   /** Shows the dropdown panel */
   async show() {
     // Prevent subsequent calls to the method, whether manually or triggered by the `open` watcher
-    if (this.isVisible) {
+    if (this.isVisible || this.popover == null || this.panel == null) {
       return;
     }
     const sixShow = this.sixShow.emit();
@@ -211,7 +342,7 @@ export class SixDropdown {
   /** Hides the dropdown panel */
   async hide() {
     // Prevent subsequent calls to the method, whether manually or triggered by the `open` watcher
-    if (!this.isVisible) {
+    if (!this.isVisible || this.panel == null || this.popover == null) {
       return;
     }
     const sixHide = this.sixHide.emit();
@@ -227,8 +358,10 @@ export class SixDropdown {
     this.popover.hide();
   }
   focusOnTrigger() {
+    if (this.trigger == null)
+      return;
     const [trigger] = getSlotChildren(this.trigger);
-    if (trigger) {
+    if (trigger != null) {
       if (typeof trigger.setFocus === 'function') {
         trigger.setFocus();
       }
@@ -238,143 +371,20 @@ export class SixDropdown {
     }
   }
   getMenu() {
-    const [menu] = getSlotChildren(this.panel).filter(isSixMenu);
-    return menu;
+    if (this.panel == null)
+      return;
+    return getSlotChildren(this.panel).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.
    */
   async reposition() {
-    if (!this.open) {
+    if (!this.open || this.popover == null) {
       return;
     }
     this.popover.reposition();
   }
-  handleDocumentKeyDown(event) {
-    // Close when escape is pressed
-    if (event.key === 'Escape') {
-      void this.hide();
-      this.focusOnTrigger();
-      return;
-    }
-    if (this.filterInputElement === this.host.shadowRoot.activeElement) {
-      if (event.key === 'ArrowDown') {
-        const item = this.getMenuItems().find((item) => item.style.display !== 'none');
-        if (item) {
-          item.setFocus();
-        }
-      }
-    }
-    // Handle tabbing
-    if (event.key === 'Tab') {
-      // Tabbing within an open menu should close the dropdown and refocus the trigger
-      if (this.open && isSixMenuItem(document.activeElement)) {
-        event.preventDefault();
-        void this.hide();
-        this.focusOnTrigger();
-        return;
-      }
-      // Tabbing outside of the containing element closes the panel
-      //
-      // If the dropdown is used within a shadow DOM, we need to obtain the activeElement within that shadowRoot,
-      // otherwise `document.activeElement` will only return the name of the parent shadow DOM element.
-      setTimeout(() => {
-        var _a;
-        const activeElement = this.container.getRootNode() instanceof ShadowRoot
-          ? (_a = document.activeElement.shadowRoot) === null || _a === void 0 ? void 0 : _a.activeElement
-          : document.activeElement;
-        if ((activeElement === null || activeElement === void 0 ? void 0 : activeElement.closest(this.container.tagName.toLowerCase())) !== this.container) {
-          void this.hide();
-          return;
-        }
-      });
-    }
-  }
-  handleDocumentMouseDown(event) {
-    // Close when clicking outside of the containing element
-    const path = event.composedPath();
-    if (!path.includes(this.container)) {
-      void this.hide();
-      return;
-    }
-  }
-  handleMenuItemActivate(event) {
-    const item = event.target;
-    scrollIntoView(item, this.panel);
-  }
-  handlePanelSelect(event) {
-    const target = event.target;
-    // Hide the dropdown when a menu item is selected
-    if (this.closeOnSelect && isSixMenu(target)) {
-      void this.hide();
-      this.focusOnTrigger();
-    }
-  }
-  handleTriggerClick() {
-    this.open ? this.hide() : this.show();
-  }
-  handleTriggerKeyDown(event) {
-    const menu = this.getMenu();
-    const menuItems = menu ? [...menu.querySelectorAll('six-menu-item')] : null;
-    const firstMenuItem = menuItems[0];
-    const lastMenuItem = menuItems[menuItems.length - 1];
-    // Close when escape or tab is pressed
-    if (event.key === 'Escape') {
-      this.focusOnTrigger();
-      void this.hide();
-      return;
-    }
-    // When spacebar/enter is pressed, show the panel but don't focus on the menu. This let's the user press the same
-    // key again to hide the menu in case they don't want to make a selection.
-    if (!this.disableHideOnEnterAndSpace && [' ', 'Enter'].includes(event.key)) {
-      event.preventDefault();
-      this.open ? void this.hide() : void this.show();
-      return;
-    }
-    // When up/down is pressed, we make the assumption that the user is familiar with the menu and plans to make a
-    // selection. Rather than toggle the panel, we focus on the menu (if one exists) and activate the first item for
-    // faster navigation.
-    if (['ArrowDown', 'ArrowUp'].includes(event.key)) {
-      event.preventDefault();
-      // Show the menu if it's not already open
-      if (!this.open) {
-        void this.show();
-      }
-      // Focus on a menu item
-      if (event.key === 'ArrowDown' && firstMenuItem) {
-        firstMenuItem.setFocus();
-        return;
-      }
-      if (event.key === 'ArrowUp' && lastMenuItem) {
-        lastMenuItem.setFocus();
-        return;
-      }
-    }
-    // Other keys bring focus to the menu and initiate type-to-select behavior
-    const ignoredKeys = ['Tab', 'Shift', 'Meta', 'Ctrl', 'Alt'];
-    if (this.open && menu && !ignoredKeys.includes(event.key)) {
-      void menu.typeToSelect(event.key);
-      return;
-    }
-  }
-  handleTriggerKeyUp(event) {
-    // Prevent space from triggering a click event in Firefox
-    if (event.key === ' ') {
-      event.preventDefault();
-    }
-  }
-  handleTriggerSlotChange() {
-    this.updateAccessibleTrigger();
-  }
-  handleDropdownScroll() {
-    this.sixScroll.emit({
-      scrollHeight: this.panel.scrollHeight,
-      scrollTop: this.panel.scrollTop,
-      scrollbarHeight: this.panel.offsetHeight * (this.panel.offsetHeight / this.panel.scrollHeight),
-      scrollRatio: this.panel.scrollTop / (this.panel.scrollHeight - this.panel.clientHeight),
-    });
-  }
   //
   // 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
@@ -386,8 +396,10 @@ export class SixDropdown {
   // To determine this, we assume the first tabbable element in the trigger slot is the "accessible trigger."
   //
   updateAccessibleTrigger() {
-    const [accessibleTrigger] = getSlotChildren(this.trigger).map(getNearestTabbableElement);
-    if (accessibleTrigger) {
+    if (this.trigger == null)
+      return;
+    const accessibleTrigger = getSlotChildren(this.trigger).map(getNearestTabbableElement).at(0);
+    if (accessibleTrigger != null) {
       accessibleTrigger.setAttribute('aria-haspopup', 'true');
       accessibleTrigger.setAttribute('aria-expanded', this.open ? 'true' : 'false');
     }
@@ -401,7 +413,7 @@ export class SixDropdown {
         dropdown__positioner__filtered: (this.filter || this.asyncFilter) && !this.hoist,
       } }, this.hasFilterEnabled && (h("six-input", { class: {
         'filter-hidden': !this.open,
-      }, "aria-hidden": this.open ? 'false' : 'true', ref: (el) => (this.filterInputElement = el), placeholder: this.filterPlaceholder })), h("div", { ref: (el) => (this.panel = el), part: "panel", class: "dropdown__panel", role: "menu", "aria-hidden": this.open ? 'false' : 'true', "aria-labelledby": this.componentId, onScroll: this.handleDropdownScroll }, h("slot", null), this._options && (h("six-menu", { part: "menu", items: this._options, virtualScroll: this.virtualScroll }))))));
+      }, "aria-hidden": this.open ? 'false' : 'true', ref: (el) => (this.filterInputElement = el), placeholder: this.filterPlaceholder })), h("div", { ref: (el) => (this.panel = el), part: "panel", class: "dropdown__panel", role: "menu", "aria-hidden": this.open ? 'false' : 'true', "aria-labelledby": this.componentId, onScroll: this.handleDropdownScroll }, h("slot", null), this.filteredOptions.length > 0 && (h("six-menu", { part: "menu", items: this.filteredOptions, virtualScroll: this.virtualScroll }))))));
   }
   static get is() { return "six-dropdown"; }
   static get encapsulation() { return "shadow"; }
@@ -429,7 +441,7 @@ export class SixDropdown {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Indicates whether or not the dropdown is open. You can use this in lieu of the show/hide methods."
+          "text": "Indicates whether the dropdown is open. You can use this in lieu of the show/hide methods."
         },
         "attribute": "open",
         "reflect": true,
@@ -447,7 +459,7 @@ export class SixDropdown {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The preferred placement of the dropdown panel. Note that the actual placement may vary as needed to keep the panel\ninside of the viewport."
+          "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",
         "reflect": false,
@@ -530,7 +542,7 @@ export class SixDropdown {
         "mutable": false,
         "complexType": {
           "original": "HTMLElement",
-          "resolved": "HTMLElement",
+          "resolved": "HTMLElement | undefined",
           "references": {
             "HTMLElement": {
               "location": "global"
@@ -538,7 +550,7 @@ export class SixDropdown {
           }
         },
         "required": false,
-        "optional": false,
+        "optional": true,
         "docs": {
           "tags": [],
           "text": "The dropdown will close when the user interacts outside of this element (e.g. clicking)."
@@ -656,7 +668,7 @@ export class SixDropdown {
         "type": "unknown",
         "mutable": false,
         "complexType": {
-          "original": "SixMenuItemData[] | null",
+          "original": "SixMenuItemData[]",
           "resolved": "SixMenuItemData[]",
           "references": {
             "SixMenuItemData": {
@@ -671,7 +683,7 @@ export class SixDropdown {
           "tags": [],
           "text": "Set the options to be shown in the dropdown (alternative to setting the elements via html)"
         },
-        "defaultValue": "null"
+        "defaultValue": "[]"
       },
       "virtualScroll": {
         "type": "boolean",
@@ -695,7 +707,7 @@ export class SixDropdown {
   }
   static get states() {
     return {
-      "_options": {}
+      "filteredOptions": {}
     };
   }
   static get events() {
@@ -780,7 +792,7 @@ export class SixDropdown {
           }
         }
       }, {
-        "method": "sixAutoFilterFired",
+        "method": "sixAutoFilter",
         "name": "six-dropdown-auto-filter-fired",
         "bubbles": true,
         "cancelable": true,