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

package/dist/collection/components/list/list.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, h, Host, Prop, Method } from "@stencil/core";
 import { CSS } from "./resources";
@@ -18,7 +18,7 @@ export class List {
     //
     // --------------------------------------------------------------------------
     /**
-     * When true, disabled prevents user interaction.
+     * When true, prevents user interaction.
      */
     this.disabled = false;
   }
@@ -71,7 +71,7 @@ export class List {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, disabled prevents user interaction."
+        "text": "When true, prevents user interaction."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -94,7 +94,7 @@ export class List {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Number at which section headings should start for this component."
+        "text": "Number at which section headings should start for the list."
       },
       "attribute": "heading-level",
       "reflect": false

package/dist/collection/components/list/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
  */
 export const CSS = {
   container: "container"

package/dist/collection/components/list-item/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, Prop, h, Host, Method } from "@stencil/core";
 import { SLOTS, CSS } from "./resources";
@@ -27,7 +27,7 @@ export class ListItem {
      */
     this.nonInteractive = false;
     /**
-     * When true, disabled prevents interaction.
+     * When true, prevents user interaction.
      */
     this.disabled = false;
   }
@@ -149,7 +149,7 @@ export class ListItem {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "An optional description for this item.  This will appear below the label text."
+        "text": "An optional description for the list item. Displays below the label text."
       },
       "attribute": "description",
       "reflect": false
@@ -166,7 +166,7 @@ export class ListItem {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, disabled prevents interaction."
+        "text": "When true, prevents user interaction."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -184,7 +184,7 @@ export class ListItem {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The label text of the list item. This will appear above the description text."
+        "text": "The label text of the list item. Displays above the description text."
       },
       "attribute": "label",
       "reflect": false

package/dist/collection/components/list-item/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
  */
 export const CSS = {
   container: "container",

package/dist/collection/components/list-item-group/list-item-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 { Component, Element, Prop, h, Host } from "@stencil/core";
 import { CSS } from "./resources";
@@ -48,7 +48,7 @@ export class ListItemGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The title used for all nested `calcite-list-item` rows."
+        "text": "The title for all nested `calcite-list-item` rows."
       },
       "attribute": "heading",
       "reflect": true
@@ -70,7 +70,7 @@ export class ListItemGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Number at which section headings should start for this component."
+        "text": "Number at which section headings should start for the group."
       },
       "attribute": "heading-level",
       "reflect": false

package/dist/collection/components/list-item-group/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
  */
 export const CSS = {
   heading: "heading",

package/dist/collection/components/loader/loader.css

@@ -84,9 +84,9 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
-* @prop --calcite-loader-font-size: when type is determinate, the font-size of the loader percentage
-* @prop --calcite-loader-size: the width and height of a non-inline loader
-* @prop --calcite-loader-size-inline: the width and height of an inline loader
+* @prop --calcite-loader-font-size: When type is determinate, the font-size of the loader percentage.
+* @prop --calcite-loader-size: The width and height of a non-inline loader.
+* @prop --calcite-loader-size-inline: The width and height of an inline loader.
 */
 :host{
   position: relative;

package/dist/collection/components/loader/loader.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, h, Host, Prop } from "@stencil/core";
 import { guid } from "../../utils/guid";
@@ -12,17 +12,17 @@ export class Loader {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** Show the loader */
+    /** When true, the loader is active. */
     this.active = false;
-    /** Inline loaders are smaller and will appear to the left of the text */
+    /** When true, displays smaller and appears to the left of the text. */
     this.inline = false;
-    /** Speficy the scale of the loader. Defaults to "m" */
+    /** Specify the scale of the loader. */
     this.scale = "m";
-    /** Percent complete of 100, only valid for determinate indicators */
+    /** Valid only for determinate indicators. Percent complete of 100. */
     this.value = 0;
-    /** Text which should appear under the loading indicator (optional) */
+    /** Text that displays under the loading indicator. */
     this.text = "";
-    /** Turn off spacing around the loader */
+    /** Disables spacing around the loader. */
     this.noPadding = false;
   }
   //--------------------------------------------------------------------------
@@ -68,6 +68,8 @@ export class Loader {
   //--------------------------------------------------------------------------
   /**
    * Return the proper sizes based on the scale property
+   *
+   * @param scale
    */
   getSize(scale) {
     return {
@@ -104,7 +106,7 @@ export class Loader {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Show the loader"
+        "text": "When true, the loader is active."
       },
       "attribute": "active",
       "reflect": true,
@@ -122,7 +124,7 @@ export class Loader {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Inline loaders are smaller and will appear to the left of the text"
+        "text": "When true, displays smaller and appears to the left of the text."
       },
       "attribute": "inline",
       "reflect": true,
@@ -140,7 +142,7 @@ export class Loader {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Accessible name for the component"
+        "text": "Accessible name for the loader."
       },
       "attribute": "label",
       "reflect": false
@@ -162,7 +164,7 @@ export class Loader {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Speficy the scale of the loader. Defaults to \"m\""
+        "text": "Specify the scale of the loader."
       },
       "attribute": "scale",
       "reflect": true,
@@ -180,7 +182,7 @@ export class Loader {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Use indeterminate if finding actual progress value is impossible"
+        "text": "Use indeterminate if finding actual progress value is impossible."
       },
       "attribute": "type",
       "reflect": true
@@ -197,7 +199,7 @@ export class Loader {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Percent complete of 100, only valid for determinate indicators"
+        "text": "Valid only for determinate indicators. Percent complete of 100."
       },
       "attribute": "value",
       "reflect": false,
@@ -212,10 +214,10 @@ export class Loader {
         "references": {}
       },
       "required": false,
-      "optional": false,
+      "optional": true,
       "docs": {
         "tags": [],
-        "text": "Text which should appear under the loading indicator (optional)"
+        "text": "Text that displays under the loading indicator."
       },
       "attribute": "text",
       "reflect": false,
@@ -233,7 +235,7 @@ export class Loader {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Turn off spacing around the loader"
+        "text": "Disables spacing around the loader."
       },
       "attribute": "no-padding",
       "reflect": false,

package/dist/collection/components/modal/interfaces.js

@@ -1,6 +1,6 @@
 /*!
  * 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 {};

package/dist/collection/components/modal/modal.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, State, Watch } from "@stencil/core";
 import { ensureId, focusElement, getSlotted, isCalciteFocusable } from "../../utils/dom";
@@ -196,6 +196,8 @@ export class Modal {
   //--------------------------------------------------------------------------
   /**
    * Focus first interactive element
+   *
+   * @param el
    * @deprecated use `setFocus` instead.
    */
   async focusElement(el) {
@@ -209,12 +211,19 @@ export class Modal {
    *
    * By default, will try to focus on any focusable content. If there is none, it will focus on the close button.
    * If you want to focus on the close button, you can use the `close-button` focus ID.
+   *
+   * @param focusId
    */
   async setFocus(focusId) {
     const closeButton = this.closeButtonEl;
     return focusElement(focusId === "close-button" ? closeButton : getFocusableElements(this.el)[0] || closeButton);
   }
-  /** Set the scroll top of the modal content */
+  /**
+   * Set the scroll top of the modal content
+   *
+   * @param top
+   * @param left
+   */
   async scrollContent(top = 0, left = 0) {
     if (this.modalContent) {
       if (this.modalContent.scrollTo) {
@@ -569,7 +578,10 @@ export class Modal {
       "complexType": {
         "signature": "(el?: HTMLElement) => Promise<void>",
         "parameters": [{
-            "tags": [],
+            "tags": [{
+                "name": "param",
+                "text": "el"
+              }],
             "text": ""
           }],
         "references": {
@@ -585,6 +597,9 @@ export class Modal {
       "docs": {
         "text": "Focus first interactive element",
         "tags": [{
+            "name": "param",
+            "text": "el"
+          }, {
             "name": "deprecated",
             "text": "use `setFocus` instead."
           }]
@@ -594,7 +609,10 @@ export class Modal {
       "complexType": {
         "signature": "(focusId?: \"close-button\") => Promise<void>",
         "parameters": [{
-            "tags": [],
+            "tags": [{
+                "name": "param",
+                "text": "focusId"
+              }],
             "text": ""
           }],
         "references": {
@@ -606,17 +624,26 @@ export class Modal {
       },
       "docs": {
         "text": "Sets focus on the component.\n\nBy default, will try to focus on any focusable content. If there is none, it will focus on the close button.\nIf you want to focus on the close button, you can use the `close-button` focus ID.",
-        "tags": []
+        "tags": [{
+            "name": "param",
+            "text": "focusId"
+          }]
       }
     },
     "scrollContent": {
       "complexType": {
         "signature": "(top?: number, left?: number) => Promise<void>",
         "parameters": [{
-            "tags": [],
+            "tags": [{
+                "name": "param",
+                "text": "top"
+              }],
             "text": ""
           }, {
-            "tags": [],
+            "tags": [{
+                "name": "param",
+                "text": "left"
+              }],
             "text": ""
           }],
         "references": {
@@ -628,7 +655,13 @@ export class Modal {
       },
       "docs": {
         "text": "Set the scroll top of the modal content",
-        "tags": []
+        "tags": [{
+            "name": "param",
+            "text": "top"
+          }, {
+            "name": "param",
+            "text": "left"
+          }]
       }
     }
   }; }

package/dist/collection/components/modal/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
  */
 export const CSS = {
   title: "title",

package/dist/collection/components/notice/notice.js

@@ -1,14 +1,15 @@
 /*!
  * 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, Method, Prop, Watch } from "@stencil/core";
 import { CSS, SLOTS, TEXT } from "./resources";
 import { StatusIcons } from "../alert/interfaces";
 import { getSlotted, setRequestedIcon } from "../../utils/dom";
 import { connectConditionalSlotComponent, disconnectConditionalSlotComponent } from "../../utils/conditionalSlot";
-/** Notices are intended to be used to present users with important-but-not-crucial contextual tips or copy. Because
+/**
+ * Notices are intended to be used to present users with important-but-not-crucial contextual tips or copy. Because
  * notices are displayed inline, a common use case is displaying them on page-load to present users with short hints or contextual copy.
  * They are optionally dismissible - useful for keeping track of whether or not a user has dismissed the notice. You can also choose not
  * to display a notice on page load and set the "active" attribute as needed to contextually provide inline messaging to users.
@@ -32,7 +33,9 @@ export class Notice {
     this.color = "blue";
     /** Optionally show a button the user can click to dismiss the notice */
     this.dismissible = false;
-    /** String for the close button.
+    /**
+     * String for the close button.
+     *
      * @default "Close"
      */
     this.intlClose = TEXT.close;

package/dist/collection/components/notice/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
  */
 export const TEXT = {
   close: "Close"

package/dist/collection/components/option/option.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, h, Prop, Element, Event, Watch } from "@stencil/core";
 import { createObserver } from "../../utils/observers";
@@ -18,14 +18,14 @@ export class Option {
     this.disabled = false;
     this.mutationObserver = createObserver("mutation", () => {
       this.ensureTextContentDependentProps();
-      this.calciteOptionChange.emit();
+      this.calciteInternalOptionChange.emit();
     });
   }
   handlePropChange(_newValue, _oldValue, propName) {
     if (propName === "label" || propName === "value") {
       this.ensureTextContentDependentProps();
     }
-    this.calciteOptionChange.emit();
+    this.calciteInternalOptionChange.emit();
   }
   //--------------------------------------------------------------------------
   //
@@ -150,8 +150,8 @@ export class Option {
     }
   }; }
   static get events() { return [{
-      "method": "calciteOptionChange",
-      "name": "calciteOptionChange",
+      "method": "calciteInternalOptionChange",
+      "name": "calciteInternalOptionChange",
       "bubbles": true,
       "cancelable": true,
       "composed": true,

package/dist/collection/components/option-group/option-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 { Component, h, Prop, Watch, Event, Fragment } from "@stencil/core";
 /**
@@ -20,7 +20,7 @@ export class OptionGroup {
     this.disabled = false;
   }
   handlePropChange() {
-    this.calciteOptionGroupChange.emit();
+    this.calciteInternalOptionGroupChange.emit();
   }
   //--------------------------------------------------------------------------
   //
@@ -78,8 +78,8 @@ export class OptionGroup {
     }
   }; }
   static get events() { return [{
-      "method": "calciteOptionGroupChange",
-      "name": "calciteOptionGroupChange",
+      "method": "calciteInternalOptionGroupChange",
+      "name": "calciteInternalOptionGroupChange",
       "bubbles": true,
       "cancelable": true,
       "composed": true,

package/dist/collection/components/pagination/pagination.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, Prop, Method, Fragment } from "@stencil/core";
 import { CSS, TEXT } from "./resources";
@@ -19,11 +19,15 @@ export class Pagination {
     this.start = 1;
     /** total number of items */
     this.total = 0;
-    /** Used as an accessible label (aria-label) for the next button
+    /**
+     * Used as an accessible label (aria-label) for the next button
+     *
      * @default "Next"
      */
     this.textLabelNext = TEXT.nextLabel;
-    /** Used as an accessible label (aria-label) of the previous button
+    /**
+     * Used as an accessible label (aria-label) of the previous button
+     *
      * @default "Previous"
      */
     this.textLabelPrevious = TEXT.previousLabel;

package/dist/collection/components/pagination/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
  */
 export const CSS = {
   page: "page",

package/dist/collection/components/panel/panel.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, Method, Prop, Watch, h, Fragment } from "@stencil/core";
 import { CSS, HEADING_LEVEL, ICONS, SLOTS, TEXT } from "./resources";
@@ -130,7 +130,11 @@ export class Panel {
   //  Methods
   //
   // --------------------------------------------------------------------------
-  /** Sets focus on the component. */
+  /**
+   * Sets focus on the component.
+   *
+   * @param focusId
+   */
   async setFocus(focusId) {
     var _a, _b, _c;
     if (focusId === "dismiss-button") {
@@ -143,7 +147,8 @@ export class Panel {
     }
     (_c = this.containerEl) === null || _c === void 0 ? void 0 : _c.focus();
   }
-  /** Scrolls panel content to a particular set of coordinates.
+  /**
+   * Scrolls panel content to a particular set of coordinates.
    *
    * ```
    *   myCalcitePanel.scrollContentTo({
@@ -152,6 +157,8 @@ export class Panel {
    *     behavior: "auto" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).
    *   });
    * ```
+   *
+   * @param options
    */
   async scrollContentTo(options) {
     var _a;
@@ -617,7 +624,10 @@ export class Panel {
       "complexType": {
         "signature": "(focusId?: \"dismiss-button\" | \"back-button\") => Promise<void>",
         "parameters": [{
-            "tags": [],
+            "tags": [{
+                "name": "param",
+                "text": "focusId"
+              }],
             "text": ""
           }],
         "references": {
@@ -629,14 +639,20 @@ export class Panel {
       },
       "docs": {
         "text": "Sets focus on the component.",
-        "tags": []
+        "tags": [{
+            "name": "param",
+            "text": "focusId"
+          }]
       }
     },
     "scrollContentTo": {
       "complexType": {
         "signature": "(options?: ScrollToOptions) => Promise<void>",
         "parameters": [{
-            "tags": [],
+            "tags": [{
+                "name": "param",
+                "text": "options"
+              }],
             "text": ""
           }],
         "references": {
@@ -650,8 +666,11 @@ export class Panel {
         "return": "Promise<void>"
       },
       "docs": {
-        "text": "Scrolls panel content to a particular set of coordinates.\n\n```\n myCalcitePanel.scrollContentTo({\n   left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.\n   top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element\n   behavior: \"auto\" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).\n });\n```",
-        "tags": []
+        "text": "Scrolls panel content to a particular set of coordinates.\n\n```\n  myCalcitePanel.scrollContentTo({\n    left: 0, // Specifies the number of pixels along the X axis to scroll the window or element.\n    top: 0, // Specifies the number of pixels along the Y axis to scroll the window or element\n    behavior: \"auto\" // Specifies whether the scrolling should animate smoothly (smooth), or happen instantly in a single jump (auto, the default value).\n  });\n```",
+        "tags": [{
+            "name": "param",
+            "text": "options"
+          }]
       }
     }
   }; }

package/dist/collection/components/panel/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
  */
 export const CSS = {
   backButton: "back-button",