@spectrum-web-components/picker 0.14.2-overlay.33 → 0.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spectrum-web-components/picker",
-    "version": "0.14.2-overlay.33+499d5fe96",
+    "version": "0.15.0",
     "publishConfig": {
         "access": "public"
     },
@@ -66,19 +66,19 @@
     ],
     "dependencies": {
         "@spectrum-web-components/base": "^0.7.4",
-        "@spectrum-web-components/button": "^0.20.2-overlay.33+499d5fe96",
-        "@spectrum-web-components/icon": "^0.12.8",
-        "@spectrum-web-components/icons-ui": "^0.9.8",
-        "@spectrum-web-components/icons-workflow": "^0.9.8",
-        "@spectrum-web-components/menu": "^0.16.14-overlay.33+499d5fe96",
-        "@spectrum-web-components/overlay": "^0.19.2-overlay.33+499d5fe96",
-        "@spectrum-web-components/popover": "^0.12.14-overlay.33+499d5fe96",
+        "@spectrum-web-components/button": "^0.20.3",
+        "@spectrum-web-components/icon": "^0.12.9",
+        "@spectrum-web-components/icons-ui": "^0.9.10",
+        "@spectrum-web-components/icons-workflow": "^0.9.10",
+        "@spectrum-web-components/menu": "^0.16.15",
+        "@spectrum-web-components/overlay": "^0.19.3",
+        "@spectrum-web-components/popover": "^0.12.15",
         "@spectrum-web-components/reactive-controllers": "^0.3.5",
-        "@spectrum-web-components/shared": "^0.15.6-overlay.99+499d5fe96",
-        "@spectrum-web-components/tray": "^0.5.1-overlay.37+499d5fe96"
+        "@spectrum-web-components/shared": "^0.15.5",
+        "@spectrum-web-components/tray": "^0.5.1"
     },
     "devDependencies": {
-        "@spectrum-css/picker": "^2.0.0"
+        "@spectrum-css/picker": "^2.0.5"
     },
     "types": "./src/index.d.ts",
     "customElements": "custom-elements.json",
@@ -88,5 +88,5 @@
         "./sync/index.js",
         "./sync/sp-*.js"
     ],
-    "gitHead": "499d5fe966f35eb862c1983eb3a42641f213ac6a"
+    "gitHead": "1e25ee121f3bc838dbb99bac62f3c95857570f7a"
 }

package/src/Picker.d.ts

@@ -1,14 +1,12 @@
 import { CSSResultArray, PropertyValues, TemplateResult } from '@spectrum-web-components/base';
-import { StyleInfo } from '@spectrum-web-components/base/src/directives.js';
 import { Focusable } from '@spectrum-web-components/shared/src/focusable.js';
 import '@spectrum-web-components/icons-ui/icons/sp-icon-chevron100.js';
 import '@spectrum-web-components/icons-workflow/icons/sp-icon-alert.js';
-import '@spectrum-web-components/overlay/sp-overlay.js';
 import '@spectrum-web-components/menu/sp-menu.js';
-import type { Menu, MenuItem, MenuItemChildren } from '@spectrum-web-components/menu';
+import type { Menu, MenuItem, MenuItemAddedOrUpdatedEvent, MenuItemChildren, MenuItemRemovedEvent } from '@spectrum-web-components/menu';
 import '@spectrum-web-components/tray/sp-tray.js';
 import '@spectrum-web-components/popover/sp-popover.js';
-import { Placement } from '@spectrum-web-components/overlay';
+import { OverlayOptions, Placement, TriggerInteractions } from '@spectrum-web-components/overlay';
 import { MatchMediaController } from '@spectrum-web-components/reactive-controllers/src/MatchMedia.js';
 declare const PickerBase_base: typeof Focusable & {
     new (...args: any[]): import("@spectrum-web-components/base").SizedElementInterface;
@@ -24,6 +22,10 @@ declare const PickerBase_base: typeof Focusable & {
  * @fires sp-closed - Announces that the overlay has been closed
  */
 export declare class PickerBase extends PickerBase_base {
+    /**
+     * @private
+     */
+    static openOverlay: (target: HTMLElement, interaction: TriggerInteractions, content: HTMLElement, options: OverlayOptions) => Promise<() => void>;
     protected isMobile: MatchMediaController;
     button: HTMLButtonElement;
     get target(): HTMLButtonElement | this;
@@ -35,7 +37,8 @@ export declare class PickerBase extends PickerBase_base {
     open: boolean;
     readonly: boolean;
     selects: undefined | 'single';
-    get menuItems(): MenuItem[];
+    menuItems: MenuItem[];
+    private restoreChildren?;
     optionsMenu: Menu;
     /**
      * @type {"auto" | "auto-start" | "auto-end" | "top" | "bottom" | "right" | "left" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end" | "none"}
@@ -44,9 +47,9 @@ export declare class PickerBase extends PickerBase_base {
     placement: Placement;
     quiet: boolean;
     value: string;
-    get selectedItem(): MenuItem | undefined;
-    set selectedItem(selectedItem: MenuItem | undefined);
-    _selectedItem?: MenuItem;
+    selectedItem?: MenuItem;
+    private closeOverlay?;
+    private popoverEl;
     protected listRole: 'listbox' | 'menu';
     protected itemRole: string;
     constructor();
@@ -61,21 +64,33 @@ export declare class PickerBase extends PickerBase_base {
     protected onKeydown: (event: KeyboardEvent) => void;
     setValueFromItem(item: MenuItem, menuChangeEvent?: Event): Promise<void>;
     protected setMenuItemSelected(item: MenuItem, value: boolean): void;
-    private preventToggle;
     toggle(target?: boolean): void;
     close(): void;
-    protected get containerStyles(): StyleInfo;
+    overlayOpenCallback: () => Promise<void>;
+    overlayCloseCallback: () => Promise<void>;
+    private popoverFragment;
+    private generatePopover;
+    private openMenu;
+    protected sizePopover(popover: HTMLElement): void;
+    private closeMenu;
     protected get selectedItemContent(): MenuItemChildren;
-    protected set selectedItemContent(selectedItemContent: MenuItemChildren | undefined);
-    _selectedItemContent?: MenuItemChildren;
     protected renderLabelContent(content: Node[]): TemplateResult | Node[];
     protected get buttonContent(): TemplateResult[];
-    protected get renderOverlay(): TemplateResult;
     protected render(): TemplateResult;
     protected update(changes: PropertyValues<this>): void;
     protected get dismissHelper(): TemplateResult;
-    protected get renderContainer(): TemplateResult;
+    protected get renderPopover(): TemplateResult;
+    private _willUpdateItems;
+    protected itemsUpdated: Promise<void>;
+    /**
+     * Acquire the available MenuItems in the Picker by
+     * direct element query or by assuming the list managed
+     * by the Menu within the open options overlay.
+     */
+    protected updateMenuItems(event?: MenuItemAddedOrUpdatedEvent | MenuItemRemovedEvent): void;
     protected manageSelection(): Promise<void>;
+    private menuStatePromise;
+    private menuStateResolver;
     private selectionPromise;
     private selectionResolver;
     protected getUpdateComplete(): Promise<boolean>;
@@ -84,6 +99,7 @@ export declare class PickerBase extends PickerBase_base {
 }
 export declare class Picker extends PickerBase {
     static get styles(): CSSResultArray;
+    protected sizePopover(popover: HTMLElement): void;
     protected onKeydown: (event: KeyboardEvent) => void;
 }
 export {};

package/src/Picker.dev.js

@@ -13,12 +13,10 @@ var __decorateClass = (decorators, target, key, kind) => {
 import {
   html,
   nothing,
+  render,
   SizedMixin
 } from "@spectrum-web-components/base";
-import {
-  classMap,
-  styleMap
-} from "@spectrum-web-components/base/src/directives.js";
+import { classMap } from "@spectrum-web-components/base/src/directives.js";
 import {
   property,
   query
@@ -26,12 +24,15 @@ import {
 import pickerStyles from "./picker.css.js";
 import chevronStyles from "@spectrum-web-components/icon/src/spectrum-icon-chevron.css.js";
 import { Focusable } from "@spectrum-web-components/shared/src/focusable.js";
+import { reparentChildren } from "@spectrum-web-components/shared/src/reparent-children.js";
 import "@spectrum-web-components/icons-ui/icons/sp-icon-chevron100.js";
 import "@spectrum-web-components/icons-workflow/icons/sp-icon-alert.js";
-import "@spectrum-web-components/overlay/sp-overlay.js";
 import "@spectrum-web-components/menu/sp-menu.js";
 import "@spectrum-web-components/tray/sp-tray.js";
 import "@spectrum-web-components/popover/sp-popover.js";
+import {
+  openOverlay
+} from "@spectrum-web-components/overlay";
 import {
   IS_MOBILE,
   MatchMediaController
@@ -52,6 +53,7 @@ export class PickerBase extends SizedMixin(Focusable) {
     this.open = false;
     this.readonly = false;
     this.selects = "single";
+    this.menuItems = [];
     this.placement = "bottom-start";
     this.quiet = false;
     this.value = "";
@@ -65,33 +67,29 @@ export class PickerBase extends SizedMixin(Focusable) {
       event.preventDefault();
       this.toggle(true);
     };
-    this.preventToggle = false;
+    this.overlayOpenCallback = async () => {
+      this.updateMenuItems();
+      await this.itemsUpdated;
+      await this.optionsMenu.updateComplete;
+      requestAnimationFrame(() => this.menuStateResolver());
+    };
+    this.overlayCloseCallback = async () => {
+      if (this.restoreChildren) {
+        this.restoreChildren();
+        this.restoreChildren = void 0;
+      }
+      this.close();
+      requestAnimationFrame(() => this.menuStateResolver());
+    };
+    this._willUpdateItems = false;
+    this.itemsUpdated = Promise.resolve();
+    this.menuStatePromise = Promise.resolve();
     this.selectionPromise = Promise.resolve();
     this.onKeydown = this.onKeydown.bind(this);
-    this.addEventListener("focusout", (event) => {
-      if (event.relatedTarget && this.contains(event.relatedTarget) || event.target !== this) {
-        return;
-      }
-      this.open = false;
-    });
   }
   get target() {
     return this.button;
   }
-  get menuItems() {
-    return this.optionsMenu.childItems;
-  }
-  get selectedItem() {
-    return this._selectedItem;
-  }
-  set selectedItem(selectedItem) {
-    this.selectedItemContent = selectedItem ? selectedItem.itemChildren : void 0;
-    if (selectedItem === this.selectedItem)
-      return;
-    const oldSelectedItem = this.selectedItem;
-    this._selectedItem = selectedItem;
-    this.requestUpdate("selectedItem", oldSelectedItem);
-  }
   get focusElement() {
     if (this.open) {
       return this.optionsMenu;
@@ -130,8 +128,8 @@ export class PickerBase extends SizedMixin(Focusable) {
   handleChange(event) {
     const target = event.target;
     const [selected] = target.selectedItems;
-    event.stopPropagation();
     if (event.cancelable) {
+      event.stopPropagation();
       this.setValueFromItem(selected, event);
     } else {
       this.open = false;
@@ -175,8 +173,6 @@ export class PickerBase extends SizedMixin(Focusable) {
     item.selected = value;
   }
   toggle(target) {
-    if (this.preventToggle)
-      return;
     if (this.readonly) {
       return;
     }
@@ -188,27 +184,74 @@ export class PickerBase extends SizedMixin(Focusable) {
     }
     this.open = false;
   }
-  get containerStyles() {
+  async generatePopover() {
+    if (!this.popoverFragment) {
+      this.popoverFragment = document.createDocumentFragment();
+    }
+    render(this.renderPopover, this.popoverFragment, { host: this });
+    this.popoverEl = this.popoverFragment.children[0];
+    this.optionsMenu = this.popoverEl.children[1];
+  }
+  async openMenu() {
+    let reparentableChildren = [];
+    const deprecatedMenu = this.querySelector(":scope > sp-menu");
+    await this.generatePopover();
+    if (deprecatedMenu) {
+      reparentableChildren = Array.from(deprecatedMenu.children);
+    } else {
+      reparentableChildren = Array.from(this.children).filter(
+        (element) => {
+          return !element.hasAttribute("slot");
+        }
+      );
+    }
+    if (reparentableChildren.length === 0) {
+      this.menuStateResolver();
+      return;
+    }
+    this.restoreChildren = reparentChildren(reparentableChildren, this.optionsMenu, {
+      position: "beforeend",
+      prepareCallback: (el) => {
+        if (this.value === el.value) {
+          this.setMenuItemSelected(el, true);
+        }
+        return (el2) => {
+          if (typeof el2.focused !== "undefined") {
+            el2.focused = false;
+          }
+        };
+      }
+    });
+    this.sizePopover(this.popoverEl);
+    if (true) {
+      window.__swc.ignoreWarningLevels.deprecation = true;
+    }
+    this.closeOverlay = Picker.openOverlay(this, "modal", this.popoverEl, {
+      placement: this.isMobile.matches ? "none" : this.placement,
+      receivesFocus: "auto"
+    });
+    if (true) {
+      window.__swc.ignoreWarningLevels.deprecation = false;
+    }
+  }
+  sizePopover(popover) {
     if (this.isMobile.matches) {
-      return {
-        "--swc-menu-width": "100%"
-      };
+      popover.style.setProperty("--swc-menu-width", `100%`);
+      return;
     }
-    if (this.quiet)
-      return {};
-    return {
-      "min-width": `${this.offsetWidth}px`
-    };
   }
-  get selectedItemContent() {
-    return this._selectedItemContent || { icon: [], content: [] };
+  async closeMenu() {
+    if (this.closeOverlay) {
+      const closeOverlay = this.closeOverlay;
+      delete this.closeOverlay;
+      (await closeOverlay)();
+    }
   }
-  set selectedItemContent(selectedItemContent) {
-    if (selectedItemContent === this.selectedItemContent)
-      return;
-    const oldContent = this.selectedItemContent;
-    this._selectedItemContent = selectedItemContent;
-    this.requestUpdate("selectedItemContent", oldContent);
+  get selectedItemContent() {
+    if (this.selectedItem) {
+      return this.selectedItem.itemChildren;
+    }
+    return { icon: [], content: [] };
   }
   renderLabelContent(content) {
     if (this.value && this.selectedItem) {
@@ -242,40 +285,13 @@ export class PickerBase extends SizedMixin(Focusable) {
             `
     ];
   }
-  get renderOverlay() {
-    return html`
-            <sp-overlay
-                .triggerElement=${this}
-                .offset=${0}
-                ?open=${this.open}
-                .placement=${this.placement}
-                type="auto"
-                @sp-menu-item-added-or-updated=${this.manageSelection}
-                @beforetoggle=${(event) => {
-      this.open = event.target.open;
-      if (!this.open) {
-        this.preventToggle = true;
-        requestAnimationFrame(
-          () => this.preventToggle = false
-        );
-        this.optionsMenu.updateSelectedItemIndex();
-        this.optionsMenu.closeDescendentOverlays();
-      } else {
-        this.optionsMenu.focus();
-      }
-    }}
-            >
-                ${this.renderContainer}
-            </sp-overlay>
-        `;
-  }
   // a helper to throw focus to the button is needed because Safari
   // won't include buttons in the tab order even with tabindex="0"
   render() {
     return html`
             <span
                 id="focus-helper"
-                tabindex="${this.focused || this.open ? "-1" : "0"}"
+                tabindex="${this.focused ? "-1" : "0"}"
                 @focus=${this.onHelperFocus}
             ></span>
             <button
@@ -292,7 +308,6 @@ export class PickerBase extends SizedMixin(Focusable) {
             >
                 ${this.buttonContent}
             </button>
-            ${this.renderOverlay}
         `;
   }
   update(changes) {
@@ -302,10 +317,18 @@ export class PickerBase extends SizedMixin(Focusable) {
     if (changes.has("disabled") && this.disabled) {
       this.open = false;
     }
-    if (changes.has("value")) {
-      requestAnimationFrame(() => {
-        this.manageSelection();
-      });
+    if (changes.has("open") && (this.open || typeof changes.get("open") !== "undefined")) {
+      this.menuStatePromise = new Promise(
+        (res) => this.menuStateResolver = res
+      );
+      if (this.open) {
+        this.openMenu();
+      } else {
+        this.closeMenu();
+      }
+    }
+    if (changes.has("value") && !changes.has("selectedItem")) {
+      this.updateMenuItems();
     }
     if (true) {
       if (!this.hasUpdated && this.querySelector("sp-menu")) {
@@ -331,7 +354,7 @@ export class PickerBase extends SizedMixin(Focusable) {
             </div>
         `;
   }
-  get renderContainer() {
+  get renderPopover() {
     const content = html`
             ${this.dismissHelper}
             <sp-menu
@@ -339,10 +362,7 @@ export class PickerBase extends SizedMixin(Focusable) {
                 role="${this.listRole}"
                 @change=${this.handleChange}
                 .selects=${this.selects}
-                .selected=${this.value ? [this.value] : []}
-            >
-                <slot></slot>
-            </sp-menu>
+            ></sp-menu>
             ${this.dismissHelper}
         `;
     if (this.isMobile.matches) {
@@ -350,7 +370,9 @@ export class PickerBase extends SizedMixin(Focusable) {
                 <sp-tray
                     id="popover"
                     role="dialog"
-                    style=${styleMap(this.containerStyles)}
+                    @sp-menu-item-added-or-updated=${this.updateMenuItems}
+                    .overlayOpenCallback=${this.overlayOpenCallback}
+                    .overlayCloseCallback=${this.overlayCloseCallback}
                 >
                     ${content}
                 </sp-tray>
@@ -360,21 +382,56 @@ export class PickerBase extends SizedMixin(Focusable) {
             <sp-popover
                 id="popover"
                 role="dialog"
-                style=${styleMap(this.containerStyles)}
-                placement=${this.placement}
+                @sp-menu-item-added-or-updated=${this.updateMenuItems}
+                .overlayOpenCallback=${this.overlayOpenCallback}
+                .overlayCloseCallback=${this.overlayCloseCallback}
             >
                 ${content}
             </sp-popover>
         `;
   }
+  /**
+   * Acquire the available MenuItems in the Picker by
+   * direct element query or by assuming the list managed
+   * by the Menu within the open options overlay.
+   */
+  updateMenuItems(event) {
+    if (this.open && (event == null ? void 0 : event.type) === "sp-menu-item-removed")
+      return;
+    if (this._willUpdateItems)
+      return;
+    this._willUpdateItems = true;
+    if ((event == null ? void 0 : event.item) === this.selectedItem) {
+      this.requestUpdate();
+    }
+    let resolve = () => {
+      return;
+    };
+    this.itemsUpdated = new Promise((res) => resolve = res);
+    window.requestAnimationFrame(async () => {
+      if (this.open) {
+        await this.optionsMenu.updateComplete;
+        this.menuItems = this.optionsMenu.childItems;
+      } else {
+        this.menuItems = [
+          ...this.querySelectorAll(
+            'sp-menu-item:not([slot="submenu"] *)'
+          )
+        ];
+      }
+      this.manageSelection();
+      resolve();
+      this._willUpdateItems = false;
+    });
+  }
   async manageSelection() {
     if (this.selects == null)
       return;
+    await this.menuStatePromise;
     this.selectionPromise = new Promise(
       (res) => this.selectionResolver = res
     );
     let selectedItem;
-    await this.optionsMenu.updateComplete;
     this.menuItems.forEach((item) => {
       if (this.value === item.value && !item.disabled) {
         selectedItem = item;
@@ -397,10 +454,18 @@ export class PickerBase extends SizedMixin(Focusable) {
   }
   async getUpdateComplete() {
     const complete = await super.getUpdateComplete();
+    await this.menuStatePromise;
+    await this.itemsUpdated;
     await this.selectionPromise;
     return complete;
   }
   connectedCallback() {
+    this.updateMenuItems();
+    this.addEventListener(
+      "sp-menu-item-added-or-updated",
+      this.updateMenuItems
+    );
+    this.addEventListener("sp-menu-item-removed", this.updateMenuItems);
     super.connectedCallback();
   }
   disconnectedCallback() {
@@ -408,6 +473,12 @@ export class PickerBase extends SizedMixin(Focusable) {
     super.disconnectedCallback();
   }
 }
+/**
+ * @private
+ */
+PickerBase.openOverlay = async (target, interaction, content, options) => {
+  return await openOverlay(target, interaction, content, options);
+};
 __decorateClass([
   query("#button")
 ], PickerBase.prototype, "button", 2);
@@ -432,9 +503,6 @@ __decorateClass([
 __decorateClass([
   property({ type: Boolean, reflect: true })
 ], PickerBase.prototype, "readonly", 2);
-__decorateClass([
-  query("sp-menu")
-], PickerBase.prototype, "optionsMenu", 2);
 __decorateClass([
   property()
 ], PickerBase.prototype, "placement", 2);
@@ -446,10 +514,7 @@ __decorateClass([
 ], PickerBase.prototype, "value", 2);
 __decorateClass([
   property({ attribute: false })
-], PickerBase.prototype, "selectedItem", 1);
-__decorateClass([
-  property({ attribute: false })
-], PickerBase.prototype, "selectedItemContent", 1);
+], PickerBase.prototype, "selectedItem", 2);
 export class Picker extends PickerBase {
   constructor() {
     super(...arguments);
@@ -481,5 +546,11 @@ export class Picker extends PickerBase {
   static get styles() {
     return [pickerStyles, chevronStyles];
   }
+  sizePopover(popover) {
+    super.sizePopover(popover);
+    if (this.quiet)
+      return;
+    popover.style.setProperty("min-width", `${this.offsetWidth}px`);
+  }
 }
 //# sourceMappingURL=Picker.dev.js.map