@esri/calcite-components 1.0.0-next.555 → 1.0.0-next.558

package/dist/collection/components/radio-group/radio-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.555
+ * v1.0.0-next.558
  */
 import { Build, Component, Element, Event, h, Host, Listen, Method, Prop, Watch } from "@stencil/core";
 import { getElementDir } from "../../utils/dom";
@@ -18,23 +18,23 @@ export class RadioGroup {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** specify the appearance style of the radio group, defaults to solid. */
+    /** Specifies the appearance style of the component. */
     this.appearance = "solid";
-    /** is the radio group disabled  */
+    /** When true, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
     /**
-     * When true, makes the component required for form-submission.
+     * When true, the component must have a value on form submission.
      *
      * @internal
      */
     this.required = false;
-    /** specify the layout of the radio group, defaults to horizontal */
+    /** Defines the layout of the component. */
     this.layout = "horizontal";
-    /** The scale of the radio group */
+    /** Specifies the size of the component. */
     this.scale = "m";
-    /** The value of the selectedItem */
+    /** The component's "selectedItem" value. */
     this.value = null;
-    /** specify the width of the group, defaults to auto */
+    /** Specifies the width of the component. */
     this.width = "auto";
     //--------------------------------------------------------------------------
     //
@@ -110,7 +110,7 @@ export class RadioGroup {
   }
   handleKeyDown(event) {
     const keys = ["ArrowLeft", "ArrowUp", "ArrowRight", "ArrowDown", " "];
-    const key = event.key;
+    const { key } = event;
     const { el, selectedItem } = this;
     if (keys.indexOf(key) === -1) {
       return;
@@ -223,7 +223,7 @@ export class RadioGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the appearance style of the radio group, defaults to solid."
+        "text": "Specifies the appearance style of the component."
       },
       "attribute": "appearance",
       "reflect": true,
@@ -241,7 +241,7 @@ export class RadioGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "is the radio group disabled"
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -262,7 +262,7 @@ export class RadioGroup {
             "name": "internal",
             "text": undefined
           }],
-        "text": "When true, makes the component required for form-submission."
+        "text": "When true, the component must have a value on form submission."
       },
       "attribute": "required",
       "reflect": true,
@@ -285,7 +285,7 @@ export class RadioGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the layout of the radio group, defaults to horizontal"
+        "text": "Defines the layout of the component."
       },
       "attribute": "layout",
       "reflect": true,
@@ -303,7 +303,7 @@ export class RadioGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The group's name. Gets submitted with the form."
+        "text": "Specifies the name of the component on form submission."
       },
       "attribute": "name",
       "reflect": false
@@ -325,7 +325,7 @@ export class RadioGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The scale of the radio group"
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": true,
@@ -343,7 +343,7 @@ export class RadioGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The value of the selectedItem"
+        "text": "The component's \"selectedItem\" value."
       },
       "attribute": "value",
       "reflect": false,
@@ -368,7 +368,7 @@ export class RadioGroup {
             "name": "readonly",
             "text": undefined
           }],
-        "text": "The group's selected item."
+        "text": "The component's selected item `HTMLElement`."
       }
     },
     "width": {
@@ -391,7 +391,7 @@ export class RadioGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the width of the group, defaults to auto"
+        "text": "Specifies the width of the component."
       },
       "attribute": "width",
       "reflect": true,
@@ -406,7 +406,7 @@ export class RadioGroup {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Fired when the selected option changes, event detail is the new value"
+        "text": "Fires when the selected option changes, where the event detail is the new value."
       },
       "complexType": {
         "original": "string",

package/dist/collection/components/radio-group-item/radio-group-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.555
+ * v1.0.0-next.558
  */
 import { Component, h, Prop, Element, Event, Host, Watch } from "@stencil/core";
 import { getElementProp, toAriaBoolean } from "../../utils/dom";
@@ -13,11 +13,11 @@ export class RadioGroupItem {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** Indicates whether the control is checked. */
+    /** When true, the component is checked. */
     this.checked = false;
-    /** flip the icon in rtl */
+    /** When true, the icon will be flipped when the element direction is right-to-left ("rtl"). */
     this.iconFlipRtl = false;
-    /** optionally used with icon, select where to position the icon */
+    /** When used with "icon", specifies its position. */
     this.iconPosition = "start";
   }
   handleCheckedChange() {
@@ -63,7 +63,7 @@ export class RadioGroupItem {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Indicates whether the control is checked."
+        "text": "When true, the component is checked."
       },
       "attribute": "checked",
       "reflect": true,
@@ -81,7 +81,7 @@ export class RadioGroupItem {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "optionally pass an icon to display - accepts Calcite UI icon names"
+        "text": "Specifies an icon to display - accepts Calcite UI icon names."
       },
       "attribute": "icon",
       "reflect": true
@@ -98,7 +98,7 @@ export class RadioGroupItem {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "flip the icon in rtl"
+        "text": "When true, the icon will be flipped when the element direction is right-to-left (\"rtl\")."
       },
       "attribute": "icon-flip-rtl",
       "reflect": true,
@@ -121,7 +121,7 @@ export class RadioGroupItem {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "optionally used with icon, select where to position the icon"
+        "text": "When used with \"icon\", specifies its position."
       },
       "attribute": "icon-position",
       "reflect": true,
@@ -139,7 +139,7 @@ export class RadioGroupItem {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The control's value."
+        "text": "The component's value."
       },
       "attribute": "value",
       "reflect": false

package/dist/collection/components/radio-group-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.555
+ * v1.0.0-next.558
  */
 export const SLOTS = {
   input: "input"

package/dist/collection/components/rating/rating.css

@@ -91,7 +91,7 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
-* @prop --calcite-rating-spacing-unit: the amount of left/right margin between each rating star
+* @prop --calcite-rating-spacing-unit: The amount of left and right margin spacing between each rating star.
 */
 :host {
   position: relative;

package/dist/collection/components/rating/rating.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.555
+ * v1.0.0-next.558
  */
 import { Component, Element, Event, Fragment, h, Listen, Method, Prop, State } from "@stencil/core";
 import { guid } from "../../utils/guid";
@@ -17,30 +17,30 @@ export class Rating {
     //  Properties
     //
     // --------------------------------------------------------------------------
-    /** specify the scale of the component, defaults to m */
+    /** Specifies the size of the component. */
     this.scale = "m";
-    /** the value of the rating component */
+    /** The component's value. */
     this.value = 0;
-    /** is the rating component in a selectable mode */
+    /** When true, the component's value can be read, but cannot be modified. */
     this.readOnly = false;
-    /** is the rating component in a selectable mode */
+    /** When true, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
-    /** Show average and count data summary chip (if available) */
+    /** When true, and if available, displays the "average" and/or "count" data summary in a `calcite-chip`. */
     this.showChip = false;
     /**
-     * Localized string for "Rating" (used for aria label)
+     * Accessible name for the component.
      *
      * @default "Rating"
      */
     this.intlRating = TEXT.rating;
     /**
-     * Localized string for labelling each star, `${num}` in the string will be replaced by the number
+     * Accessible name for each star. The `${num}` in the string will be replaced by the number.
      *
      * @default "Stars: ${num}"
      */
     this.intlStars = TEXT.stars;
     /**
-     * When true, makes the component required for form-submission.
+     * When true, the component must have a value on form submission.
      *
      * @internal
      */
@@ -108,7 +108,7 @@ export class Rating {
             h("calcite-icon", { icon: "star-f", scale: this.scale }))),
           h("span", { class: "visually-hidden" }, this.intlStars.replace("${num}", `${i}`))),
         h("input", { checked: i === this.value, class: "visually-hidden", disabled: this.disabled || this.readOnly, id: `${this.guid}-${i}`, name: this.guid, onChange: () => this.updateValue(i), onClick: (event) => 
-          // click is fired from the the component's label, so we treat this as an internal event
+          // click is fired from the component's label, so we treat this as an internal event
           event.stopPropagation(), onFocus: () => this.onFocusChange(i), onKeyDown: this.onKeyboardPressed, ref: (el) => (i === 1 || i === this.value) && (this.inputFocusRef = el), type: "radio", value: i })));
     });
   }
@@ -174,7 +174,7 @@ export class Rating {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the scale of the component, defaults to m"
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": true,
@@ -192,7 +192,7 @@ export class Rating {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "the value of the rating component"
+        "text": "The component's value."
       },
       "attribute": "value",
       "reflect": true,
@@ -210,7 +210,7 @@ export class Rating {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "is the rating component in a selectable mode"
+        "text": "When true, the component's value can be read, but cannot be modified."
       },
       "attribute": "read-only",
       "reflect": true,
@@ -228,7 +228,7 @@ export class Rating {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "is the rating component in a selectable mode"
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -246,7 +246,7 @@ export class Rating {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Show average and count data summary chip (if available)"
+        "text": "When true, and if available, displays the \"average\" and/or \"count\" data summary in a `calcite-chip`."
       },
       "attribute": "show-chip",
       "reflect": true,
@@ -264,7 +264,7 @@ export class Rating {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "optionally pass a number of previous ratings to display"
+        "text": "Specifies the number of previous ratings to display."
       },
       "attribute": "count",
       "reflect": true
@@ -281,7 +281,7 @@ export class Rating {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "optionally pass a cumulative average rating to display"
+        "text": "Specifies a cumulative average from previous ratings to display."
       },
       "attribute": "average",
       "reflect": true
@@ -298,7 +298,7 @@ export class Rating {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The name of the rating"
+        "text": "Specifies the name of the component on form submission."
       },
       "attribute": "name",
       "reflect": true
@@ -318,7 +318,7 @@ export class Rating {
             "name": "default",
             "text": "\"Rating\""
           }],
-        "text": "Localized string for \"Rating\" (used for aria label)"
+        "text": "Accessible name for the component."
       },
       "attribute": "intl-rating",
       "reflect": false,
@@ -339,7 +339,7 @@ export class Rating {
             "name": "default",
             "text": "\"Stars: ${num}\""
           }],
-        "text": "Localized string for labelling each star, `${num}` in the string will be replaced by the number"
+        "text": "Accessible name for each star. The `${num}` in the string will be replaced by the number."
       },
       "attribute": "intl-stars",
       "reflect": false,
@@ -360,7 +360,7 @@ export class Rating {
             "name": "internal",
             "text": undefined
           }],
-        "text": "When true, makes the component required for form-submission."
+        "text": "When true, the component must have a value on form submission."
       },
       "attribute": "required",
       "reflect": true,
@@ -380,7 +380,7 @@ export class Rating {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Fires when the rating value has changed."
+        "text": "Fires when the component's value changes."
       },
       "complexType": {
         "original": "{ value: number }",

package/dist/collection/components/rating/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.555
+ * v1.0.0-next.558
  */
 export const TEXT = {
   rating: "Rating",

package/dist/collection/components/scrim/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.555
+ * v1.0.0-next.558
  */
 export const CSS = {
   scrim: "scrim",

package/dist/collection/components/scrim/scrim.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.555
+ * v1.0.0-next.558
  */
 import { Component, Element, Prop, h } from "@stencil/core";
 import { CSS, TEXT } from "./resources";
@@ -16,14 +16,13 @@ export class Scrim {
     //
     // --------------------------------------------------------------------------
     /**
-     * string to override English loading text
+     * Accessible name when the component is loading.
      *
      * @default "Loading"
      */
     this.intlLoading = TEXT.loading;
     /**
-     * Determines if the component will have the loader overlay.
-     * Otherwise, will render opaque disabled state.
+     * When true, a busy indicator is displayed.
      */
     this.loading = false;
   }
@@ -66,7 +65,7 @@ export class Scrim {
             "name": "default",
             "text": "\"Loading\""
           }],
-        "text": "string to override English loading text"
+        "text": "Accessible name when the component is loading."
       },
       "attribute": "intl-loading",
       "reflect": false,
@@ -84,7 +83,7 @@ export class Scrim {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Determines if the component will have the loader overlay.\nOtherwise, will render opaque disabled state."
+        "text": "When true, a busy indicator is displayed."
       },
       "attribute": "loading",
       "reflect": true,

package/dist/collection/components/select/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.555
+ * v1.0.0-next.558
  */
 export const CSS = {
   icon: "icon",

package/dist/collection/components/select/select.css

@@ -107,8 +107,8 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
-* @prop --calcite-select-font-size: the font-size of items in the select
-* @prop --calcite-select-spacing: the padding around the selected option text
+* @prop --calcite-select-font-size: The font size of items in the component.
+* @prop --calcite-select-spacing: The padding around the selected option text.
 */
 :host {
   position: relative;

package/dist/collection/components/select/select.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.555
+ * v1.0.0-next.558
  */
 import { Component, Element, Event, Fragment, h, Listen, Method, Prop, Watch } from "@stencil/core";
 import { focusElement } from "../../utils/dom";
@@ -27,23 +27,23 @@ export class Select {
     //
     //--------------------------------------------------------------------------
     /**
-     * When true, it prevents the option from being selected.
+     * When true, interaction is prevented and the component is displayed with lower opacity.
      */
     this.disabled = false;
     /**
-     * When true, makes the component required for form-submission.
+     * When true, the component must have a value on form submission.
      *
      * @internal
      */
     this.required = false;
     /**
-     * The component scale.
+     * Specifies the size of the component.
      */
     this.scale = "m";
-    /** The value of the selectedOption */
+    /** The component's "selectedOption" value. */
     this.value = null;
     /**
-     * The component width.
+     * Specifies the width of the component.
      */
     this.width = "auto";
     this.componentToNativeEl = new Map();
@@ -230,7 +230,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "When true, it prevents the option from being selected."
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -248,7 +248,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The component's label. This is required for accessibility purposes."
+        "text": "Accessible name for the component."
       },
       "attribute": "label",
       "reflect": false
@@ -265,7 +265,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The select's name. Gets submitted with the form."
+        "text": "Specifies the name of the component on form submission."
       },
       "attribute": "name",
       "reflect": false
@@ -285,7 +285,7 @@ export class Select {
             "name": "internal",
             "text": undefined
           }],
-        "text": "When true, makes the component required for form-submission."
+        "text": "When true, the component must have a value on form submission."
       },
       "attribute": "required",
       "reflect": true,
@@ -308,7 +308,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The component scale."
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": true,
@@ -326,7 +326,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The value of the selectedOption"
+        "text": "The component's \"selectedOption\" value."
       },
       "attribute": "value",
       "reflect": false,
@@ -351,7 +351,7 @@ export class Select {
             "name": "readonly",
             "text": undefined
           }],
-        "text": "The currently selected option."
+        "text": "The component's selected option `HTMLElement`."
       }
     },
     "width": {
@@ -371,7 +371,7 @@ export class Select {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The component width."
+        "text": "Specifies the width of the component."
       },
       "attribute": "width",
       "reflect": true,
@@ -386,7 +386,7 @@ export class Select {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "This event will fire whenever the selected option changes."
+        "text": "Fires when the selected option changes."
       },
       "complexType": {
         "original": "void",

package/dist/collection/components/shell/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.555
+ * v1.0.0-next.558
  */
 export const CSS = {
   main: "main",

package/dist/collection/components/shell/shell.css

@@ -94,7 +94,7 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
-* @prop --calcite-shell-tip-spacing: the left/right positioning of the tip-manager when slotted within a shell
+* @prop --calcite-shell-tip-spacing: The left and right spacing of the `calcite-tip-manager` when slotted in the component.
 */
 :host {
   position: absolute;

package/dist/collection/components/shell/shell.js

@@ -1,21 +1,21 @@
 /*!
  * 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.555
+ * v1.0.0-next.558
  */
 import { Component, Element, Prop, h, Fragment } from "@stencil/core";
 import { CSS, SLOTS } from "./resources";
 import { getSlotted } from "../../utils/dom";
 import { connectConditionalSlotComponent, disconnectConditionalSlotComponent } from "../../utils/conditionalSlot";
 /**
- * @slot - A slot for adding content to the shell. This content will appear between any leading and trailing panels added to the shell. (eg. a map)
- * @slot header - A slot for adding header content. This content will be positioned at the top of the shell.
- * @slot footer - A slot for adding footer content. This content will be positioned at the bottom of the shell.
+ * @slot - A slot for adding content to the component. This content will appear between any leading and trailing panels added to the component, such as a map.
+ * @slot header - A slot for adding header content. This content will be positioned at the top of the component.
+ * @slot footer - A slot for adding footer content. This content will be positioned at the bottom of the component.
  * @slot panel-start - A slot for adding the starting `calcite-shell-panel`.
  * @slot panel-end - A slot for adding the ending `calcite-shell-panel`.
  * @slot primary-panel - [DEPRECATED] A slot for adding the leading `calcite-shell-panel`.
  * @slot contextual-panel - [DEPRECATED] A slot for adding the trailing `calcite-shell-panel`.
- * @slot center-row - A slot for adding custom content in the center row.
+ * @slot center-row - A slot for adding content to the center row.
  */
 export class Shell {
   constructor() {
@@ -25,7 +25,7 @@ export class Shell {
     //
     // --------------------------------------------------------------------------
     /**
-     * Positions the center content behind any calcite-shell-panels.
+     * Positions the center content behind any `calcite-shell-panel`s.
      */
     this.contentBehind = false;
   }
@@ -113,7 +113,7 @@ export class Shell {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Positions the center content behind any calcite-shell-panels."
+        "text": "Positions the center content behind any `calcite-shell-panel`s."
       },
       "attribute": "content-behind",
       "reflect": true,