@esri/calcite-components 1.0.0-next.554 → 1.0.0-next.557

package/dist/collection/components/radio-button/radio-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.554
+ * v1.0.0-next.557
  */
 import { Component, Element, Event, h, Host, Listen, Method, Prop, Watch } from "@stencil/core";
 import { guid } from "../../utils/guid";
@@ -18,27 +18,27 @@ export class RadioButton {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** The checked state of the radio button. */
+    /** When true, the component is checked. */
     this.checked = false;
-    /** The disabled state of the radio button. */
+    /** When true, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
     /**
-     * The focused state of the radio button.
+     * The focused state of the component.
      *
      * @internal
      */
     this.focused = false;
-    /** The radio button's hidden status.  When a radio button is hidden it is not focusable or checkable. */
+    /** When true, the component is not displayed and is not focusable or checkable. */
     this.hidden = false;
     /**
-     * The hovered state of the radio button.
+     * The hovered state of the component.
      *
      * @internal
      */
     this.hovered = false;
-    /** Requires that a value is selected for the radio button group before the parent form will submit. */
+    /** When true, the component must have a value selected from the `calcite-radio-button-group` on form submission. */
     this.required = false;
-    /** The scale (size) of the radio button. `scale` is passed as a property automatically from `calcite-radio-button-group`. */
+    /** Specifies the size of the component inherited from the `calcite-radio-button-group`. */
     this.scale = "m";
     //--------------------------------------------------------------------------
     //
@@ -73,7 +73,7 @@ export class RadioButton {
     };
     this.handleKeyDown = (event) => {
       const keys = ["ArrowLeft", "ArrowUp", "ArrowRight", "ArrowDown", " "];
-      const key = event.key;
+      const { key } = event;
       const { el } = this;
       if (keys.indexOf(key) === -1) {
         return;
@@ -273,7 +273,7 @@ export class RadioButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The checked state of the radio button."
+        "text": "When true, the component is checked."
       },
       "attribute": "checked",
       "reflect": true,
@@ -291,7 +291,7 @@ export class RadioButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The disabled state of the radio button."
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -312,7 +312,7 @@ export class RadioButton {
             "name": "internal",
             "text": undefined
           }],
-        "text": "The focused state of the radio button."
+        "text": "The focused state of the component."
       },
       "attribute": "focused",
       "reflect": true,
@@ -330,7 +330,7 @@ export class RadioButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The id attribute of the radio button.  When omitted, a globally unique identifier is used."
+        "text": "The id attribute of the component. When omitted, a globally unique identifier is used."
       },
       "attribute": "guid",
       "reflect": true
@@ -347,7 +347,7 @@ export class RadioButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The radio button's hidden status.  When a radio button is hidden it is not focusable or checkable."
+        "text": "When true, the component is not displayed and is not focusable or checkable."
       },
       "attribute": "hidden",
       "reflect": true,
@@ -368,7 +368,7 @@ export class RadioButton {
             "name": "internal",
             "text": undefined
           }],
-        "text": "The hovered state of the radio button."
+        "text": "The hovered state of the component."
       },
       "attribute": "hovered",
       "reflect": true,
@@ -389,7 +389,7 @@ export class RadioButton {
             "name": "internal",
             "text": undefined
           }],
-        "text": "The label of the radio input"
+        "text": "Accessible name for the component."
       },
       "attribute": "label",
       "reflect": false
@@ -406,7 +406,7 @@ export class RadioButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The name of the radio button. `name` is passed as a property automatically from `calcite-radio-button-group`."
+        "text": "Specifies the name of the component, passed from the `calcite-radio-button-group` on form submission."
       },
       "attribute": "name",
       "reflect": true
@@ -423,7 +423,7 @@ export class RadioButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Requires that a value is selected for the radio button group before the parent form will submit."
+        "text": "When true, the component must have a value selected from the `calcite-radio-button-group` on form submission."
       },
       "attribute": "required",
       "reflect": true,
@@ -446,7 +446,7 @@ export class RadioButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The scale (size) of the radio button. `scale` is passed as a property automatically from `calcite-radio-button-group`."
+        "text": "Specifies the size of the component inherited from the `calcite-radio-button-group`."
       },
       "attribute": "scale",
       "reflect": true,
@@ -464,7 +464,7 @@ export class RadioButton {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The value of the radio button."
+        "text": "The component's value."
       },
       "attribute": "value",
       "reflect": false

package/dist/collection/components/radio-button/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.554
+ * v1.0.0-next.557
  */
 export const CSS = {
   container: "container"

package/dist/collection/components/radio-button-group/radio-button-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.554
+ * v1.0.0-next.557
  */
 import { Component, Host, h, Element, Prop, Watch, Event, Listen } from "@stencil/core";
 import { createObserver } from "../../utils/observers";
@@ -15,15 +15,15 @@ export class RadioButtonGroup {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** The disabled state of the radio button group. */
+    /** When true, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
-    /** The radio button group's hidden status.  When a radio button group is hidden none of its options are focusable or checkable. */
+    /** When true, the component is not displayed and its `calcite-radio-button`s are not focusable or checkable. */
     this.hidden = false;
-    /** The layout direction of the radio buttons in a group. */
+    /** Defines the layout of the component. */
     this.layout = "horizontal";
-    /** Requires that a value is selected for the radio button group before the parent form will submit. */
+    /** When true, the component must have a value on form submission. */
     this.required = false;
-    /** The scale (size) of the radio button group. */
+    /** Specifies the size of the component. */
     this.scale = "m";
     // --------------------------------------------------------------------------
     //
@@ -113,7 +113,7 @@ export class RadioButtonGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The disabled state of the radio button group."
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -131,7 +131,7 @@ export class RadioButtonGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The radio button group's hidden status.  When a radio button group is hidden none of its options are focusable or checkable."
+        "text": "When true, the component is not displayed and its `calcite-radio-button`s are not focusable or checkable."
       },
       "attribute": "hidden",
       "reflect": true,
@@ -154,7 +154,7 @@ export class RadioButtonGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The layout direction of the radio buttons in a group."
+        "text": "Defines the layout of the component."
       },
       "attribute": "layout",
       "reflect": true,
@@ -172,7 +172,7 @@ export class RadioButtonGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The name of the radio button group. `name` must be unique to other radio button group instances."
+        "text": "Specifies the name of the component on form submission. Must be unique to other component instances."
       },
       "attribute": "name",
       "reflect": true
@@ -189,7 +189,7 @@ export class RadioButtonGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Requires that a value is selected for the radio button group before the parent form will submit."
+        "text": "When true, the component must have a value on form submission."
       },
       "attribute": "required",
       "reflect": true,
@@ -212,7 +212,7 @@ export class RadioButtonGroup {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "The scale (size) of the radio button group."
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": true,
@@ -227,7 +227,7 @@ export class RadioButtonGroup {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Emitted when the radio button group has changed."
+        "text": "Fires when the component has changed."
       },
       "complexType": {
         "original": "void",

package/dist/collection/components/radio-group/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.554
+ * v1.0.0-next.557
  */
 export {};

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.554
+ * v1.0.0-next.557
  */
 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.554
+ * v1.0.0-next.557
  */
 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.554
+ * v1.0.0-next.557
  */
 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.554
+ * v1.0.0-next.557
  */
 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
      */
@@ -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.554
+ * v1.0.0-next.557
  */
 export const TEXT = {
   rating: "Rating",