@esri/calcite-components 1.0.0-next.466 → 1.0.0-next.469

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

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { Component, Element, Event, h, Host, Listen, Method, Prop } from "@stencil/core";
 import { ICON_TYPES } from "../pick-list/resources";
@@ -23,7 +23,7 @@ export class ValueListItem {
      */
     this.disabled = false;
     /**
-     * @internal When false, the list item cannot be deselected by user interaction.
+     * @internal
      */
     this.disableDeselect = false;
     /**
@@ -31,11 +31,12 @@ export class ValueListItem {
      */
     this.nonInteractive = false;
     /**
-     * @internal - Stores the activated state of the drag handle.
+     * @internal
      */
     this.handleActivated = 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;
@@ -89,6 +90,8 @@ export class ValueListItem {
   /**
    * 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.pickListItem.toggleSelected(coerce);
@@ -191,7 +194,7 @@ export class ValueListItem {
       "docs": {
         "tags": [{
             "name": "internal",
-            "text": "When false, the list item cannot be deselected by user interaction."
+            "text": undefined
           }],
         "text": ""
       },
@@ -230,7 +233,7 @@ export class ValueListItem {
       "docs": {
         "tags": [{
             "name": "internal",
-            "text": "- Stores the activated state of the drag handle."
+            "text": undefined
           }],
         "text": ""
       },
@@ -375,7 +378,10 @@ export class ValueListItem {
       "complexType": {
         "signature": "(coerce?: boolean) => Promise<void>",
         "parameters": [{
-            "tags": [],
+            "tags": [{
+                "name": "param",
+                "text": "coerce"
+              }],
             "text": ""
           }],
         "references": {
@@ -387,7 +393,10 @@ export class ValueListItem {
       },
       "docs": {
         "text": "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/utils/array.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 export function getRoundRobinIndex(index, total) {
   return (index + total) % total;

package/dist/collection/utils/conditionalSlot.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { forceUpdate } from "@stencil/core";
 import { createObserver } from "./observers";
@@ -10,6 +10,8 @@ let mutationObserver;
 const observerOptions = { childList: true };
 /**
  * Helper to set up a conditional slot component on connectedCallback.
+ *
+ * @param component
  */
 export function connectConditionalSlotComponent(component) {
   if (!mutationObserver) {
@@ -19,6 +21,8 @@ export function connectConditionalSlotComponent(component) {
 }
 /**
  * Helper to tear down a conditional slot component on disconnectedCallback.
+ *
+ * @param component
  */
 export function disconnectConditionalSlotComponent(component) {
   observed.delete(component.el);

package/dist/collection/utils/date.js

@@ -1,10 +1,14 @@
 /*!
  * 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-next.466
+ * v1.0.0-next.469
  */
 /**
  * Check if date is within a min and max
+ *
+ * @param date
+ * @param min
+ * @param max
  */
 export function inRange(date, min, max) {
   const time = date.getTime();
@@ -15,6 +19,10 @@ export function inRange(date, min, max) {
 /**
  * Ensures date is within range,
  * returns min or max if out of bounds
+ *
+ * @param date
+ * @param min
+ * @param max
  */
 export function dateFromRange(date, min, max) {
   if (!(date instanceof Date)) {
@@ -34,6 +42,8 @@ export function dateFromRange(date, min, max) {
 /**
  * Parse an iso8601 string (YYYY-mm-dd) into a valid date.
  * TODO: handle time when time of day UI is added
+ *
+ * @param iso8601
  */
 export function dateFromISO(iso8601) {
   if (iso8601 instanceof Date) {
@@ -52,6 +62,8 @@ export function dateFromISO(iso8601) {
 }
 /**
  * Return first portion of ISO string (YYYY-mm-dd)
+ *
+ * @param date
  */
 export function dateToISO(date) {
   if (typeof date === "string") {
@@ -64,6 +76,9 @@ export function dateToISO(date) {
 }
 /**
  * Check if two dates are the same day, month, year
+ *
+ * @param d1
+ * @param d2
  */
 export function sameDate(d1, d2) {
   return (d1 instanceof Date &&
@@ -74,6 +89,8 @@ export function sameDate(d1, d2) {
 }
 /**
  * Get a date one month in the past
+ *
+ * @param date
  */
 export function prevMonth(date) {
   const month = date.getMonth();
@@ -87,6 +104,8 @@ export function prevMonth(date) {
 }
 /**
  * Get a date one month in the future
+ *
+ * @param date
  */
 export function nextMonth(date) {
   const month = date.getMonth();
@@ -100,6 +119,9 @@ export function nextMonth(date) {
 }
 /**
  * Translate a number into a given locals numeral system
+ *
+ * @param num
+ * @param localeData
  */
 export function localizeNumber(num, localeData) {
   return String(num)
@@ -109,6 +131,9 @@ export function localizeNumber(num, localeData) {
 }
 /**
  * Calculate actual number from localized string
+ *
+ * @param str
+ * @param localeData
  */
 export function parseNumber(str, localeData) {
   const numerals = "0123456789";
@@ -121,6 +146,9 @@ export function parseNumber(str, localeData) {
 /**
  * Parse numeric units for day, month, and year from a localized string
  * month starts at 0 (can pass to date constructor)
+ *
+ * @param str
+ * @param localeData
  */
 export function parseDateString(str, localeData) {
   const { separator, unitOrder } = localeData;
@@ -134,6 +162,8 @@ export function parseDateString(str, localeData) {
 }
 /**
  * Convert eastern arbic numerals
+ *
+ * @param str
  */
 export function replaceArabicNumerals(str = "") {
   return str
@@ -142,6 +172,8 @@ export function replaceArabicNumerals(str = "") {
 }
 /**
  * Based on the unitOrder string, find order of month, day, and year for locale
+ *
+ * @param unitOrder
  */
 export function getOrder(unitOrder) {
   const signifiers = ["d", "m", "y"];
@@ -150,6 +182,9 @@ export function getOrder(unitOrder) {
 }
 /**
  * Get number of days between two dates
+ *
+ * @param date1
+ * @param date2
  */
 export function getDaysDiff(date1, date2) {
   const ts1 = date1.getTime();

package/dist/collection/utils/dom.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { CSS_UTILITY } from "./resources";
 import { guid } from "./guid";
@@ -10,6 +10,7 @@ import { guid } from "./guid";
  *
  * If it already has an ID, it will be preserved, otherwise a unique one will be generated and assigned.
  *
+ * @param el
  * @returns {string} The element's ID.
  */
 export function ensureId(el) {
@@ -45,6 +46,8 @@ export function getHost(root) {
 /**
  * This helper queries an element's rootNodes and any ancestor rootNodes.
  *
+ * @param element
+ * @param selector
  * @returns {Element[]} The elements.
  */
 export function queryElementsRoots(element, selector) {
@@ -71,6 +74,10 @@ export function queryElementsRoots(element, selector) {
  *
  * If both an 'id' and 'selector' are supplied, 'id' will take precedence over 'selector'.
  *
+ * @param element
+ * @param root0
+ * @param root0.selector
+ * @param root0.id
  * @returns {Element} The element.
  */
 export function queryElementRoots(element, { selector, id }) {
@@ -181,6 +188,7 @@ export function intersects(rect1, rect2) {
  *
  * It should only be used for aria attributes that require a string value of "true" or "false".
  *
+ * @param value
  * @returns {string} The string conversion of a boolean value ("true" | "false").
  */
 export function toAriaBoolean(value) {

package/dist/collection/utils/filter.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { escapeRegExp, forIn } from "lodash-es";
 export const filter = (data, value) => {

package/dist/collection/utils/form.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { closestElementCrossShadowBoundary } from "./dom";
 import { h } from "@stencil/core";
@@ -32,6 +32,8 @@ function hasRegisteredFormComponentParent(form, formComponentEl) {
 }
 /**
  * Helper to submit a form.
+ *
+ * @param component
  */
 export function submitForm(component) {
   var _a;
@@ -39,6 +41,8 @@ export function submitForm(component) {
 }
 /**
  * Helper to reset a form.
+ *
+ * @param component
  */
 export function resetForm(component) {
   var _a;
@@ -46,6 +50,8 @@ export function resetForm(component) {
 }
 /**
  * Helper to set up form interactions on connectedCallback.
+ *
+ * @param component
  */
 export function connectForm(component) {
   const { el, value } = component;
@@ -72,6 +78,8 @@ function onFormReset() {
 }
 /**
  * Helper to tear down form interactions on disconnectedCallback.
+ *
+ * @param component
  */
 export function disconnectForm(component) {
   const { el, formEl } = component;
@@ -88,6 +96,9 @@ export function disconnectForm(component) {
  * Helper for setting the default value on initialization after connectedCallback.
  *
  * Note that this is only needed if the default value cannot be determined on connectedCallback.
+ *
+ * @param component
+ * @param value
  */
 export function afterConnectDefaultValueSet(component, value) {
   component.defaultValue = value;
@@ -96,6 +107,8 @@ export function afterConnectDefaultValueSet(component, value) {
  * Helper for maintaining a form-associated's hidden input in sync with the component.
  *
  * Based on Ionic's approach: https://github.com/ionic-team/ionic-framework/blob/e4bf052794af9aac07f887013b9250d2a045eba3/core/src/utils/helpers.ts#L198
+ *
+ * @param component
  */
 function syncHiddenFormInput(component) {
   const { el, formEl, name, value } = component;
@@ -180,6 +193,9 @@ function defaultSyncHiddenFormInput(component, input, value) {
  * }
  *
  * Note that the hidden-form-input Sass mixin must be added to the component's style to apply specific styles.
+ *
+ * @param root0
+ * @param root0.component
  */
 export const HiddenFormInputSlot = ({ component }) => {
   syncHiddenFormInput(component);

package/dist/collection/utils/globalAttributes.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { createObserver } from "./observers";
 const allowedGlobalAttributes = ["lang"];
@@ -33,6 +33,9 @@ function processMutations(mutations) {
  *   const lang = this.inheritedAttributes['lang'] ?? 'en';
  *   return <div>My lang is {lang}</div>;
  * }
+ *
+ * @param component
+ * @param attributeFilter
  */
 export function watchGlobalAttributes(component, attributeFilter) {
   const { el } = component;
@@ -46,6 +49,8 @@ export function watchGlobalAttributes(component, attributeFilter) {
 }
 /**
  * Helper remove listening for changes to inherited attributes.
+ *
+ * @param component
  */
 export function unwatchGlobalAttributes(component) {
   elementToComponentAndObserverOptionsMap.delete(component.el);

package/dist/collection/utils/guid.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 function gen(counts) {
   return counts

package/dist/collection/utils/interactive.js

@@ -1,10 +1,10 @@
 /*!
  * 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-next.466
+ * v1.0.0-next.469
  */
 function noopClick() {
-  /** noop **/
+  /** noop */
 }
 /**
  * This helper updates the host element to prevent keyboard interaction on its subtree and sets the appropriate aria attribute for accessibility.
@@ -13,8 +13,11 @@ function noopClick() {
  *
  * **Notes**
  *
- * * this util is not needed for simple components whose root element or elements are an interactive component (custom element or native control). For those cases, set the `disabled` props on the root components instead.
- * * technically, users can override `tabindex` and restore keyboard navigation, but this will be considered user error
+ * this util is not needed for simple components whose root element or elements are an interactive component (custom element or native control). For those cases, set the `disabled` props on the root components instead.
+ * technically, users can override `tabindex` and restore keyboard navigation, but this will be considered user error
+ *
+ * @param component
+ * @param hostIsTabbable
  */
 export function updateHostInteraction(component, hostIsTabbable = false) {
   if (component.disabled) {

package/dist/collection/utils/key.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 export function isActivationKey(key) {
   return key === "Enter" || key === " ";

package/dist/collection/utils/label.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-next.466
+ * v1.0.0-next.469
  */
 import { closestElementCrossShadowBoundary, queryElementRoots } from "./dom";
 /**
  * Exported for testing purposes only
+ *
  * @internal
  */
 export const labelClickEvent = "calciteInternalLabelClick";
@@ -48,6 +49,8 @@ function hasAncestorCustomElements(label, componentEl) {
 }
 /**
  * Helper to set up label interactions on connectedCallback.
+ *
+ * @param component
  */
 export function connectLabel(component) {
   const labelEl = findLabelForComponent(component.el);
@@ -72,6 +75,8 @@ export function connectLabel(component) {
 }
 /**
  * Helper to tear down label interactions on disconnectedCallback on labelable components.
+ *
+ * @param component
  */
 export function disconnectLabel(component) {
   unlabeledComponents.delete(component);
@@ -88,6 +93,8 @@ export function disconnectLabel(component) {
 }
 /**
  * Helper to get the label text from a component.
+ *
+ * @param component
  */
 export function getLabelText(component) {
   var _a, _b;

package/dist/collection/utils/locale.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { sanitizeDecimalString, sanitizeExponentialNumberString } from "./number";
 import { isValidNumber } from "./number";

package/dist/collection/utils/math.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 export const clamp = (value, min, max) => Math.max(min, Math.min(value, max));
 export const decimalPlaces = (value) => {

package/dist/collection/utils/number.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { numberKeys } from "./key";
 export function isValidNumber(numberString) {

package/dist/collection/utils/observers.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { Build } from "@stencil/core";
 /**

package/dist/collection/utils/popper.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { createPopper as setupPopper } from "@popperjs/core";
 import { getElementDir } from "./dom";

package/dist/collection/utils/resources.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 const autoTheme = "calcite-theme-auto";
 const darkTheme = "calcite-theme-dark";

package/dist/collection/utils/time.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { isValidNumber } from "./number";
 export const maxTenthForMinuteAndSecond = 5;

package/dist/components/ExpandToggle.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { forceUpdate, h } from '@stencil/core/internal/client';
 import { a as getElementDir } from './dom.js';

package/dist/components/Heading.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { h } from '@stencil/core/internal/client';
 

package/dist/components/action-group.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { proxyCustomElement, HTMLElement, h, Fragment } from '@stencil/core/internal/client';
 import { b as getSlotted } from './dom.js';

package/dist/components/action-menu.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { proxyCustomElement, HTMLElement, createEvent, h, Fragment } from '@stencil/core/internal/client';
 import { b as getSlotted, t as toAriaBoolean, f as focusElement } from './dom.js';
@@ -53,6 +53,7 @@ const ActionMenu = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
     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 = "auto";

package/dist/components/action.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { proxyCustomElement, HTMLElement, createEvent, forceUpdate, h, Host } from '@stencil/core/internal/client';
 import { c as createObserver } from './observers.js';
@@ -55,7 +55,9 @@ const Action = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement {
      * Indicates unread changes.
      */
     this.indicator = false;
-    /** string to override English loading text
+    /**
+     * string to override English loading text
+     *
      * @default "Loading"
      */
     this.intlLoading = TEXT.loading;

package/dist/components/array.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 function getRoundRobinIndex(index, total) {
   return (index + total) % total;

package/dist/components/button.js

@@ -1,7 +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-next.466
+ * v1.0.0-next.469
  */
 import { proxyCustomElement, HTMLElement as HTMLElement$1, Build, h } from '@stencil/core/internal/client';
 import { e as closestElementCrossShadowBoundary } from './dom.js';
@@ -76,7 +76,9 @@ const Button = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement$1 {
     this.color = "blue";
     /** is the button disabled  */
     this.disabled = false;
-    /** string to override English loading text
+    /**
+     * string to override English loading text
+     *
      * @default "Loading"
      */
     this.intlLoading = TEXT.loading;
@@ -92,7 +94,7 @@ const Button = /*@__PURE__*/ proxyCustomElement(class extends HTMLElement$1 {
     this.type = "button";
     /** specify the width of the button, defaults to auto */
     this.width = "auto";
-    /** watches for changing text content **/
+    /** watches for changing text content */
     this.mutationObserver = createObserver("mutation", () => this.updateHasContent());
     /** determine if there is slotted content for styling purposes */
     this.hasContent = false;