@esri/calcite-components 1.0.0-beta.80 → 1.0.0-beta.83

package/dist/collection/components/pick-list-item/pick-list-item.js

@@ -1,11 +1,12 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
+ * v1.0.0-beta.83
  */
 import { Component, Element, Event, Fragment, h, Method, Prop, Watch } from "@stencil/core";
 import { CSS, ICONS, SLOTS, TEXT } from "./resources";
 import { ICON_TYPES } from "../pick-list/resources";
-import { getSlotted } from "../../utils/dom";
+import { getSlotted, toAriaBoolean } from "../../utils/dom";
 import { connectConditionalSlotComponent, disconnectConditionalSlotComponent } from "../../utils/conditionalSlot";
 import { updateHostInteraction } from "../../utils/interactive";
 /**
@@ -23,11 +24,12 @@ export class PickListItem {
      */
     this.disableDeselect = false;
     /**
-     * @internal When true, the item cannot be selected by user interaction.
+     * @internal
      */
     this.nonInteractive = false;
     /**
      * Determines the icon SVG symbol that will be shown. Options are circle, square, grip or null.
+     *
      * @see [ICON_TYPES](https://github.com/Esri/calcite-components/blob/master/src/components/pick-list/resources.ts#L5)
      */
     this.icon = null;
@@ -41,6 +43,7 @@ export class PickListItem {
     this.selected = false;
     /**
      * Used as an accessible label (aria-label) for the "remove item" action. Only applicable if removable is true.
+     *
      * @default "Remove"
      */
     this.intlRemove = TEXT.remove;
@@ -70,13 +73,13 @@ export class PickListItem {
     };
   }
   descriptionWatchHandler() {
-    this.calciteListItemPropsChange.emit();
+    this.calciteInternalListItemPropsChange.emit();
   }
   labelWatchHandler() {
-    this.calciteListItemPropsChange.emit();
+    this.calciteInternalListItemPropsChange.emit();
   }
   metadataWatchHandler() {
-    this.calciteListItemPropsChange.emit();
+    this.calciteInternalListItemPropsChange.emit();
   }
   selectedWatchHandler() {
     this.calciteListItemChange.emit({
@@ -88,7 +91,7 @@ export class PickListItem {
     this.shiftPressed = false;
   }
   valueWatchHandler(newValue, oldValue) {
-    this.calciteListItemValueChange.emit({ oldValue, newValue });
+    this.calciteInternalListItemValueChange.emit({ oldValue, newValue });
   }
   // --------------------------------------------------------------------------
   //
@@ -112,6 +115,8 @@ export class PickListItem {
   /**
    * Used to toggle the selection state. By default this won't trigger an event.
    * The first argument allows the value to be coerced, rather than swapping values.
+   *
+   * @param coerce
    */
   async toggleSelected(coerce) {
     this.selected = typeof coerce === "boolean" ? coerce : !this.selected;
@@ -158,7 +163,7 @@ export class PickListItem {
       this.renderIcon(),
       this.renderActionsStart(),
       h("label", { "aria-label": label, class: CSS.label, onClick: this.pickListClickHandler, onKeyDown: this.pickListKeyDownHandler, ref: (focusEl) => (this.focusEl = focusEl), tabIndex: 0 },
-        h("div", { "aria-checked": this.selected.toString(), class: CSS.textContainer, role: "menuitemcheckbox" },
+        h("div", { "aria-checked": toAriaBoolean(this.selected), class: CSS.textContainer, role: "menuitemcheckbox" },
           h("span", { class: CSS.title }, label),
           description ? h("span", { class: CSS.description }, description) : null)),
       this.renderActionsEnd()));
@@ -238,7 +243,7 @@ export class PickListItem {
       "docs": {
         "tags": [{
             "name": "internal",
-            "text": "When true, the item cannot be selected by user interaction."
+            "text": undefined
           }],
         "text": ""
       },
@@ -418,8 +423,8 @@ export class PickListItem {
         "references": {}
       }
     }, {
-      "method": "calciteListItemPropsChange",
-      "name": "calciteListItemPropsChange",
+      "method": "calciteInternalListItemPropsChange",
+      "name": "calciteInternalListItemPropsChange",
       "bubbles": true,
       "cancelable": true,
       "composed": true,
@@ -436,8 +441,8 @@ export class PickListItem {
         "references": {}
       }
     }, {
-      "method": "calciteListItemValueChange",
-      "name": "calciteListItemValueChange",
+      "method": "calciteInternalListItemValueChange",
+      "name": "calciteInternalListItemValueChange",
       "bubbles": true,
       "cancelable": true,
       "composed": true,
@@ -459,7 +464,10 @@ export class PickListItem {
       "complexType": {
         "signature": "(coerce?: boolean) => Promise<void>",
         "parameters": [{
-            "tags": [],
+            "tags": [{
+                "name": "param",
+                "text": "coerce"
+              }],
             "text": ""
           }],
         "references": {
@@ -471,7 +479,10 @@ export class PickListItem {
       },
       "docs": {
         "text": "Used to toggle the selection state. By default this won't trigger an event.\nThe first argument allows the value to be coerced, rather than swapping values.",
-        "tags": []
+        "tags": [{
+            "name": "param",
+            "text": "coerce"
+          }]
       }
     },
     "setFocus": {

package/dist/collection/components/pick-list-item/resources.js

@@ -1,6 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
+ * v1.0.0-beta.83
  */
 export const CSS = {
   actions: "actions",

package/dist/collection/components/popover/PopoverManager.js

@@ -0,0 +1,75 @@
+/*!
+ * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
+ * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
+ * v1.0.0-beta.83
+ */
+import { queryElementsRoots } from "../../utils/dom";
+export default class PopoverManager {
+  constructor() {
+    // --------------------------------------------------------------------------
+    //
+    //  Private Properties
+    //
+    // --------------------------------------------------------------------------
+    this.registeredElements = new WeakMap();
+    this.registeredElementCount = 0;
+    // --------------------------------------------------------------------------
+    //
+    //  Private Methods
+    //
+    // --------------------------------------------------------------------------
+    this.queryPopover = (composedPath) => {
+      const { registeredElements } = this;
+      const registeredElement = composedPath.find((pathEl) => registeredElements.has(pathEl));
+      return registeredElements.get(registeredElement);
+    };
+    this.togglePopovers = (event) => {
+      const composedPath = event.composedPath();
+      const popover = this.queryPopover(composedPath);
+      if (popover && !popover.triggerDisabled) {
+        popover.toggle();
+        return;
+      }
+      queryElementsRoots(event.target, "calcite-popover")
+        .filter((popover) => popover.autoClose && popover.open && !composedPath.includes(popover))
+        .forEach((popover) => popover.toggle(false));
+    };
+    this.keyHandler = (event) => {
+      if (event.key !== "Enter" && event.key !== " ") {
+        return;
+      }
+      this.togglePopovers(event);
+    };
+    this.clickHandler = (event) => {
+      this.togglePopovers(event);
+    };
+  }
+  // --------------------------------------------------------------------------
+  //
+  //  Public Methods
+  //
+  // --------------------------------------------------------------------------
+  registerElement(referenceEl, popover) {
+    this.registeredElementCount++;
+    this.registeredElements.set(referenceEl, popover);
+    if (this.registeredElementCount === 1) {
+      this.addListeners();
+    }
+  }
+  unregisterElement(referenceEl) {
+    if (this.registeredElements.delete(referenceEl)) {
+      this.registeredElementCount--;
+    }
+    if (this.registeredElementCount === 0) {
+      this.removeListeners();
+    }
+  }
+  addListeners() {
+    document.addEventListener("pointerdown", this.clickHandler, { capture: true });
+    document.addEventListener("keydown", this.keyHandler, { capture: true });
+  }
+  removeListeners() {
+    document.removeEventListener("pointerdown", this.clickHandler, { capture: true });
+    document.removeEventListener("keydown", this.keyHandler, { capture: true });
+  }
+}

package/dist/collection/components/popover/popover.css

@@ -123,6 +123,11 @@
   opacity: 0;
 }
 
+:host([calcite-hydrated-hidden]) {
+  visibility: hidden !important;
+  pointer-events: none;
+}
+
 .arrow,
 .arrow::before {
   position: absolute;

package/dist/collection/components/popover/popover.js

@@ -1,13 +1,16 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
+ * v1.0.0-beta.83
  */
 import { Component, Element, Event, forceUpdate, Host, Method, Prop, State, Watch, h } from "@stencil/core";
-import { CSS, ARIA_CONTROLS, ARIA_EXPANDED, HEADING_LEVEL, POPOVER_REFERENCE, TEXT, defaultPopoverPlacement } from "./resources";
-import { defaultOffsetDistance, createPopper, updatePopper, CSS as PopperCSS } from "../../utils/popper";
+import { CSS, ARIA_CONTROLS, ARIA_EXPANDED, HEADING_LEVEL, TEXT, defaultPopoverPlacement } from "./resources";
+import { defaultOffsetDistance, createPopper, updatePopper, CSS as PopperCSS, filterComputedPlacements } from "../../utils/popper";
 import { guid } from "../../utils/guid";
-import { queryElementRoots } from "../../utils/dom";
+import { queryElementRoots, toAriaBoolean } from "../../utils/dom";
 import { Heading } from "../functional/Heading";
+import PopoverManager from "./PopoverManager";
+const manager = new PopoverManager();
 /**
  * @slot - A slot for adding custom content.
  */
@@ -18,8 +21,13 @@ export class Popover {
     //  Properties
     //
     // --------------------------------------------------------------------------
+    /**
+     * Automatically closes any currently open popovers when clicking outside of a popover.
+     */
+    this.autoClose = false;
     /**
      * Display a close button within the Popover.
+     *
      * @deprecated use dismissible instead.
      */
     this.closeButton = false;
@@ -37,6 +45,7 @@ export class Popover {
     this.disablePointer = false;
     /**
      * Offset the position of the popover away from the reference element.
+     *
      * @default 6
      */
     this.offsetDistance = defaultOffsetDistance;
@@ -52,10 +61,17 @@ export class Popover {
     this.overlayPositioning = "absolute";
     /**
      * Determines where the component will be positioned relative to the referenceElement.
+     *
      * @see [PopperPlacement](https://github.com/Esri/calcite-components/blob/master/src/utils/popper.ts#L25)
      */
     this.placement = defaultPopoverPlacement;
-    /** Text for close button.
+    /**
+     * Disables automatically toggling a popover when its referenceElement has been triggered. This property can be set to true to manage when a popover is open.
+     */
+    this.triggerDisabled = false;
+    /**
+     * Text for close button.
+     *
      * @default "Close"
      */
     this.intlClose = TEXT.close;
@@ -66,6 +82,12 @@ export class Popover {
     //  Private Methods
     //
     // --------------------------------------------------------------------------
+    this.setFilteredPlacements = () => {
+      const { el, flipPlacements } = this;
+      this.filteredFlipPlacements = flipPlacements
+        ? filterComputedPlacements(flipPlacements, el)
+        : null;
+    };
     this.setUpReferenceElement = () => {
       this.removeReferences();
       this.effectiveReferenceElement = this.getReferenceElement();
@@ -86,7 +108,9 @@ export class Popover {
       if (!effectiveReferenceElement) {
         return;
       }
-      effectiveReferenceElement.setAttribute(ARIA_EXPANDED, open.toString());
+      if ("setAttribute" in effectiveReferenceElement) {
+        effectiveReferenceElement.setAttribute(ARIA_EXPANDED, toAriaBoolean(open));
+      }
     };
     this.addReferences = () => {
       const { effectiveReferenceElement } = this;
@@ -94,8 +118,10 @@ export class Popover {
         return;
       }
       const id = this.getId();
-      effectiveReferenceElement.setAttribute(POPOVER_REFERENCE, id);
-      effectiveReferenceElement.setAttribute(ARIA_CONTROLS, id);
+      if ("setAttribute" in effectiveReferenceElement) {
+        effectiveReferenceElement.setAttribute(ARIA_CONTROLS, id);
+      }
+      manager.registerElement(effectiveReferenceElement, this.el);
       this.setExpandedAttr();
     };
     this.removeReferences = () => {
@@ -103,9 +129,11 @@ export class Popover {
       if (!effectiveReferenceElement) {
         return;
       }
-      effectiveReferenceElement.removeAttribute(POPOVER_REFERENCE);
-      effectiveReferenceElement.removeAttribute(ARIA_CONTROLS);
-      effectiveReferenceElement.removeAttribute(ARIA_EXPANDED);
+      if ("removeAttribute" in effectiveReferenceElement) {
+        effectiveReferenceElement.removeAttribute(ARIA_CONTROLS);
+        effectiveReferenceElement.removeAttribute(ARIA_EXPANDED);
+      }
+      manager.unregisterElement(effectiveReferenceElement);
     };
     this.hide = () => {
       this.open = false;
@@ -116,6 +144,9 @@ export class Popover {
       }
     };
   }
+  flipPlacementsHandler() {
+    this.setFilteredPlacements();
+  }
   offsetDistanceOffsetHandler() {
     this.reposition();
   }
@@ -137,6 +168,9 @@ export class Popover {
   //  Lifecycle
   //
   // --------------------------------------------------------------------------
+  connectedCallback() {
+    this.setFilteredPlacements();
+  }
   componentWillLoad() {
     this.setUpReferenceElement();
   }
@@ -165,7 +199,11 @@ export class Popover {
       })
       : this.createPopper();
   }
-  /** Sets focus on the component. */
+  /**
+   * Sets focus on the component.
+   *
+   * @param focusId
+   */
   async setFocus(focusId) {
     var _a;
     const { closeButtonEl } = this;
@@ -176,7 +214,11 @@ export class Popover {
     }
     (_a = this.el) === null || _a === void 0 ? void 0 : _a.focus();
   }
-  /** Toggles the popover's open property. */
+  /**
+   * Toggles the popover's open property.
+   *
+   * @param value
+   */
   async toggle(value = !this.open) {
     this.open = value;
   }
@@ -187,14 +229,14 @@ export class Popover {
       : referenceElement) || null);
   }
   getModifiers() {
-    const { arrowEl, flipPlacements, disableFlip, disablePointer, offsetDistance, offsetSkidding } = this;
+    const { arrowEl, disableFlip, disablePointer, offsetDistance, offsetSkidding, filteredFlipPlacements } = this;
     const flipModifier = {
       name: "flip",
       enabled: !disableFlip
     };
-    if (flipPlacements) {
+    if (filteredFlipPlacements) {
       flipModifier.options = {
-        fallbackPlacements: flipPlacements
+        fallbackPlacements: filteredFlipPlacements
       };
     }
     const arrowModifier = {
@@ -244,10 +286,10 @@ export class Popover {
   //
   // --------------------------------------------------------------------------
   renderCloseButton() {
-    const { dismissible, closeButton, intlClose } = this;
+    const { dismissible, closeButton, intlClose, heading } = this;
     return dismissible || closeButton ? (h("div", { class: CSS.closeButtonContainer },
-      h("calcite-action", { class: CSS.closeButton, onClick: this.hide, ref: (closeButtonEl) => (this.closeButtonEl = closeButtonEl), text: intlClose },
-        h("calcite-icon", { icon: "x", scale: "m" })))) : null;
+      h("calcite-action", { class: CSS.closeButton, onClick: this.hide, ref: (closeButtonEl) => (this.closeButtonEl = closeButtonEl), scale: heading ? "s" : "m", text: intlClose },
+        h("calcite-icon", { icon: "x", scale: heading ? "s" : "m" })))) : null;
   }
   renderHeader() {
     const { heading, headingLevel } = this;
@@ -261,7 +303,7 @@ export class Popover {
     const displayed = effectiveReferenceElement && open;
     const hidden = !displayed;
     const arrowNode = !disablePointer ? (h("div", { class: CSS.arrow, ref: (arrowEl) => (this.arrowEl = arrowEl) })) : null;
-    return (h(Host, { "aria-hidden": hidden.toString(), "aria-label": label, "calcite-hydrated-hidden": hidden, id: this.getId(), role: "dialog" },
+    return (h(Host, { "aria-hidden": toAriaBoolean(hidden), "aria-label": label, "calcite-hydrated-hidden": hidden, id: this.getId(), role: "dialog" },
       h("div", { class: {
           [PopperCSS.animation]: true,
           [PopperCSS.animationActive]: displayed
@@ -285,6 +327,24 @@ export class Popover {
     "$": ["popover.css"]
   }; }
   static get properties() { return {
+    "autoClose": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Automatically closes any currently open popovers when clicking outside of a popover."
+      },
+      "attribute": "auto-close",
+      "reflect": true,
+      "defaultValue": "false"
+    },
     "closeButton": {
       "type": "boolean",
       "mutable": false,
@@ -546,11 +606,12 @@ export class Popover {
       "type": "string",
       "mutable": false,
       "complexType": {
-        "original": "HTMLElement | string",
-        "resolved": "HTMLElement | string",
+        "original": "ReferenceElement | string",
+        "resolved": "Element | string | ({ getBoundingClientRect: () => ClientRect | DOMRect; contextElement?: Element; })",
         "references": {
-          "HTMLElement": {
-            "location": "global"
+          "ReferenceElement": {
+            "location": "import",
+            "path": "../../utils/popper"
           }
         }
       },
@@ -563,6 +624,24 @@ export class Popover {
       "attribute": "reference-element",
       "reflect": false
     },
+    "triggerDisabled": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Disables automatically toggling a popover when its referenceElement has been triggered. This property can be set to true to manage when a popover is open."
+      },
+      "attribute": "trigger-disabled",
+      "reflect": true,
+      "defaultValue": "false"
+    },
     "intlClose": {
       "type": "string",
       "mutable": false,
@@ -640,7 +719,10 @@ export class Popover {
       "complexType": {
         "signature": "(focusId?: \"close-button\") => Promise<void>",
         "parameters": [{
-            "tags": [],
+            "tags": [{
+                "name": "param",
+                "text": "focusId"
+              }],
             "text": ""
           }],
         "references": {
@@ -652,14 +734,20 @@ export class Popover {
       },
       "docs": {
         "text": "Sets focus on the component.",
-        "tags": []
+        "tags": [{
+            "name": "param",
+            "text": "focusId"
+          }]
       }
     },
     "toggle": {
       "complexType": {
         "signature": "(value?: boolean) => Promise<void>",
         "parameters": [{
-            "tags": [],
+            "tags": [{
+                "name": "param",
+                "text": "value"
+              }],
             "text": ""
           }],
         "references": {
@@ -671,12 +759,18 @@ export class Popover {
       },
       "docs": {
         "text": "Toggles the popover's open property.",
-        "tags": []
+        "tags": [{
+            "name": "param",
+            "text": "value"
+          }]
       }
     }
   }; }
   static get elementRef() { return "el"; }
   static get watchers() { return [{
+      "propName": "flipPlacements",
+      "methodName": "flipPlacementsHandler"
+    }, {
       "propName": "offsetDistance",
       "methodName": "offsetDistanceOffsetHandler"
     }, {

package/dist/collection/components/popover/resources.js

@@ -1,6 +1,7 @@
 /*!
  * All material copyright ESRI, All Rights Reserved, unless otherwise specified.
  * See https://github.com/Esri/calcite-components/blob/master/LICENSE.md for details.
+ * v1.0.0-beta.83
  */
 export const CSS = {
   container: "container",
@@ -18,7 +19,6 @@ export const TEXT = {
   close: "Close"
 };
 export const defaultPopoverPlacement = "auto";
-export const POPOVER_REFERENCE = "data-calcite-popover-reference";
 export const ARIA_CONTROLS = "aria-controls";
 export const ARIA_EXPANDED = "aria-expanded";
 export const HEADING_LEVEL = 2;