@esri/calcite-components 1.0.0-next.605 → 1.0.0-next.606

package/dist/collection/components/card/card.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.605
+ * v1.0.0-next.606
  */
 import { h } from "@stencil/core";
 import { getSlotted, toAriaBoolean } from "../../utils/dom";
@@ -13,9 +13,9 @@ import { connectConditionalSlotComponent, disconnectConditionalSlotComponent } f
  */
 /**
  * @slot - A slot for adding subheader/description content.
- * @slot thumbnail - A slot for adding a thumbnail to the card.
- * @slot title - A slot for adding a card title.
- * @slot subtitle - A slot for adding a card subtitle or short summary.
+ * @slot thumbnail - A slot for adding a thumbnail to the component.
+ * @slot title - A slot for adding a title.
+ * @slot subtitle - A slot for adding a subtitle or short summary.
  * @slot footer-leading - A slot for adding a leading footer.
  * @slot footer-trailing - A slot for adding a trailing footer.
  */
@@ -26,30 +26,31 @@ export class Card {
     //  Public Properties
     //
     //--------------------------------------------------------------------------
-    /**  When true, the cards content is waiting to be loaded. This state shows a busy indicator.*/
+    /**  When `true`, a busy indicator is displayed. */
     this.loading = false;
-    /** Indicates whether the card is selected. */
+    /** When `true`, the component is selected. */
     this.selected = false;
-    /** Indicates whether the card is selectable. */
+    /** When `true`, the component is selectable. */
     this.selectable = false;
     /**
-     * string to override English loading text
+     * Accessible name when the component is loading.
      *
      * @default "Loading"
      */
     this.intlLoading = TEXT.loading;
     /**
-     * string to override English select text for checkbox when selectable is true
+     * When `selectable` is `true`, the accessible name for the component's checkbox for selection.
      *
      * @default "Select"
      */
     this.intlSelect = TEXT.select;
     /**
-     * string to override English deselect text for checkbox when selectable is true
+     * When `selectable` is `true`, the accessible name for the component's checkbox for deselection.
      *
      * @default "Deselect"
      */
     this.intlDeselect = TEXT.deselect;
+    /** Sets the placement of the thumbnail defined in the `thumbnail` slot. */
     this.thumbnailPosition = "block-start";
     //--------------------------------------------------------------------------
     //
@@ -141,7 +142,7 @@ export class Card {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, the cards content is waiting to be loaded. This state shows a busy indicator."
+          "text": "When `true`, a busy indicator is displayed."
         },
         "attribute": "loading",
         "reflect": true,
@@ -159,7 +160,7 @@ export class Card {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Indicates whether the card is selected."
+          "text": "When `true`, the component is selected."
         },
         "attribute": "selected",
         "reflect": true,
@@ -177,7 +178,7 @@ export class Card {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Indicates whether the card is selectable."
+          "text": "When `true`, the component is selectable."
         },
         "attribute": "selectable",
         "reflect": true,
@@ -198,7 +199,7 @@ export class Card {
               "name": "default",
               "text": "\"Loading\""
             }],
-          "text": "string to override English loading text"
+          "text": "Accessible name when the component is loading."
         },
         "attribute": "intl-loading",
         "reflect": false,
@@ -219,7 +220,7 @@ export class Card {
               "name": "default",
               "text": "\"Select\""
             }],
-          "text": "string to override English select text for checkbox when selectable is true"
+          "text": "When `selectable` is `true`, the accessible name for the component's checkbox for selection."
         },
         "attribute": "intl-select",
         "reflect": false,
@@ -240,7 +241,7 @@ export class Card {
               "name": "default",
               "text": "\"Deselect\""
             }],
-          "text": "string to override English deselect text for checkbox when selectable is true"
+          "text": "When `selectable` is `true`, the accessible name for the component's checkbox for deselection."
         },
         "attribute": "intl-deselect",
         "reflect": false,
@@ -263,7 +264,7 @@ export class Card {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": ""
+          "text": "Sets the placement of the thumbnail defined in the `thumbnail` slot."
         },
         "attribute": "thumbnail-position",
         "reflect": true,
@@ -280,7 +281,7 @@ export class Card {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Fired when a selectable card is selected"
+          "text": "Fires when `selectable` is `true` and the component is selected."
         },
         "complexType": {
           "original": "void",

package/dist/collection/components/card/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.605
+ * v1.0.0-next.606
  */
 export const CSS = {
   container: "container",

package/dist/collection/components/checkbox/checkbox.css

@@ -96,7 +96,7 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
-* @prop --calcite-checkbox-size: the width and height of the checkbox
+* @prop --calcite-checkbox-size: Specifies the component's height and width.
 */
 :host([scale=s]) {
   --calcite-checkbox-size: 0.75rem;

package/dist/collection/components/checkbox/checkbox.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.605
+ * v1.0.0-next.606
  */
 import { h, Host } from "@stencil/core";
 import { guid } from "../../utils/guid";
@@ -18,9 +18,9 @@ export class Checkbox {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** The checked state of the checkbox. */
+    /** When `true`, the component is checked. */
     this.checked = false;
-    /** True if the checkbox is disabled */
+    /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
     /**
      * The hovered state of the checkbox.
@@ -29,18 +29,20 @@ export class Checkbox {
      */
     this.hovered = false;
     /**
-     * True if the checkbox is initially indeterminate,
-     * which is independent from its checked state
-     * https://css-tricks.com/indeterminate-checkboxes/
+     * When `true`, the component is initially indeterminate, which is independent from its `checked` value.
+     *
+     * The state is visual only, and can look different across browsers.
+     *
+     * @mdn [indeterminate](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes)
      */
     this.indeterminate = false;
     /**
-     * When true, the component must have a value in order for the form to submit.
+     * When `true`, the component must have a value in order for the form to submit.
      *
      * @internal
      */
     this.required = false;
-    /** specify the scale of the checkbox, defaults to m */
+    /** Specifies the size of the component. */
     this.scale = "m";
     //--------------------------------------------------------------------------
     //
@@ -148,7 +150,7 @@ export class Checkbox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The checked state of the checkbox."
+          "text": "When `true`, the component is checked."
         },
         "attribute": "checked",
         "reflect": true,
@@ -166,7 +168,7 @@ export class Checkbox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "True if the checkbox is disabled"
+          "text": "When `true`, interaction is prevented and the component is displayed with lower opacity."
         },
         "attribute": "disabled",
         "reflect": true,
@@ -184,7 +186,7 @@ export class Checkbox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The id attribute of the checkbox.  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
@@ -221,8 +223,11 @@ export class Checkbox {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "True if the checkbox is initially indeterminate,\nwhich is independent from its checked state\nhttps://css-tricks.com/indeterminate-checkboxes/"
+          "tags": [{
+              "name": "mdn",
+              "text": "[indeterminate](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/checkbox#indeterminate_state_checkboxes)"
+            }],
+          "text": "When `true`, the component is initially indeterminate, which is independent from its `checked` value.\n\nThe state is visual only, and can look different across browsers."
         },
         "attribute": "indeterminate",
         "reflect": true,
@@ -243,7 +248,7 @@ export class Checkbox {
               "name": "internal",
               "text": undefined
             }],
-          "text": "The label of the checkbox input"
+          "text": "Accessible name for the component."
         },
         "attribute": "label",
         "reflect": false
@@ -260,7 +265,7 @@ export class Checkbox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The name of the checkbox input"
+          "text": "Specifies the name of the component on form submission."
         },
         "attribute": "name",
         "reflect": true
@@ -280,7 +285,7 @@ export class Checkbox {
               "name": "internal",
               "text": undefined
             }],
-          "text": "When true, the component must have a value in order for the form to submit."
+          "text": "When `true`, the component must have a value in order for the form to submit."
         },
         "attribute": "required",
         "reflect": true,
@@ -303,7 +308,7 @@ export class Checkbox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "specify the scale of the checkbox, defaults to m"
+          "text": "Specifies the size of the component."
         },
         "attribute": "scale",
         "reflect": true,
@@ -321,7 +326,7 @@ export class Checkbox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The value of the checkbox input"
+          "text": "The component's value."
         },
         "attribute": "value",
         "reflect": false
@@ -340,7 +345,7 @@ export class Checkbox {
               "name": "internal",
               "text": undefined
             }],
-          "text": "Emitted when the checkbox is blurred"
+          "text": "Emits when the component is blurred."
         },
         "complexType": {
           "original": "boolean",
@@ -355,7 +360,7 @@ export class Checkbox {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Emitted when the checkbox checked status changes"
+          "text": "Emits when the component's `checked` status changes."
         },
         "complexType": {
           "original": "void",
@@ -373,7 +378,7 @@ export class Checkbox {
               "name": "internal",
               "text": undefined
             }],
-          "text": "Emitted when the checkbox is focused"
+          "text": "Emits when the component is focused."
         },
         "complexType": {
           "original": "boolean",

package/dist/collection/components/chip/chip.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.605
+ * v1.0.0-next.606
  */
 import { h } from "@stencil/core";
 import { getSlotted } from "../../utils/dom";
@@ -19,29 +19,29 @@ export class Chip {
     //  Public Properties
     //
     //--------------------------------------------------------------------------
-    /** specify the appearance style of the button, defaults to solid. */
+    /** Specifies the appearance style of the component. */
     this.appearance = "solid";
-    /** specify the color of the button, defaults to blue */
+    /** Specifies the color for the component. */
     this.color = "grey";
     /**
-     * Optionally show a button the user can click to dismiss the chip
+     * When `true`, a close button is added to the component.
      *
-     * @deprecated use closable instead
+     * @deprecated use `closable` instead.
      */
     this.dismissible = false;
-    /** When true, show abutton user can click to dismiss the chip. */
+    /** When `true`, a close button is added to the component. */
     this.closable = false;
     /**
-     * Aria label for the "x" button
+     * Accessible name for the component's close button.
      *
      * @default "Close"
      */
     this.dismissLabel = TEXT.close;
-    /** When true, the icon will be flipped when the element direction is right-to-left (`"rtl"`). */
+    /** When `true`, the icon will be flipped when the element direction is right-to-left (`"rtl"`). */
     this.iconFlipRtl = false;
-    /** specify the scale of the chip, defaults to m */
+    /** Specifies the size of the component. */
     this.scale = "m";
-    /** When true, hides the chip  */
+    /** When `true`, hides the component. */
     this.closed = false;
     // --------------------------------------------------------------------------
     //
@@ -137,7 +137,7 @@ export class Chip {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "specify the appearance style of the button, defaults to solid."
+          "text": "Specifies the appearance style of the component."
         },
         "attribute": "appearance",
         "reflect": true,
@@ -160,7 +160,7 @@ export class Chip {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "specify the color of the button, defaults to blue"
+          "text": "Specifies the color for the component."
         },
         "attribute": "color",
         "reflect": true,
@@ -179,9 +179,9 @@ export class Chip {
         "docs": {
           "tags": [{
               "name": "deprecated",
-              "text": "use closable instead"
+              "text": "use `closable` instead."
             }],
-          "text": "Optionally show a button the user can click to dismiss the chip"
+          "text": "When `true`, a close button is added to the component."
         },
         "attribute": "dismissible",
         "reflect": true,
@@ -199,7 +199,7 @@ export class Chip {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, show abutton user can click to dismiss the chip."
+          "text": "When `true`, a close button is added to the component."
         },
         "attribute": "closable",
         "reflect": true,
@@ -220,7 +220,7 @@ export class Chip {
               "name": "default",
               "text": "\"Close\""
             }],
-          "text": "Aria label for the \"x\" button"
+          "text": "Accessible name for the component's close button."
         },
         "attribute": "dismiss-label",
         "reflect": false,
@@ -255,7 +255,7 @@ export class Chip {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`)."
+          "text": "When `true`, the icon will be flipped when the element direction is right-to-left (`\"rtl\"`)."
         },
         "attribute": "icon-flip-rtl",
         "reflect": true,
@@ -278,7 +278,7 @@ export class Chip {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "specify the scale of the chip, defaults to m"
+          "text": "Specifies the size of the component."
         },
         "attribute": "scale",
         "reflect": true,
@@ -296,7 +296,7 @@ export class Chip {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The assigned value for the chip"
+          "text": "The component's value."
         },
         "attribute": "value",
         "reflect": false
@@ -313,7 +313,7 @@ export class Chip {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, hides the chip"
+          "text": "When `true`, hides the component."
         },
         "attribute": "closed",
         "reflect": true,
@@ -330,7 +330,7 @@ export class Chip {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Emitted when the dismiss button is clicked\n\n**Note:**: The `el` event payload props is deprecated, please use the event's `target`/`currentTarget` instead"
+          "text": "Fires when the dismiss button is clicked.\n\n**Note:**: The `el` event payload props is deprecated, please use the event's `target`/`currentTarget` instead."
         },
         "complexType": {
           "original": "DeprecatedEventPayload",

package/dist/collection/components/chip/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.605
+ * v1.0.0-next.606
  */
 export const CSS = {
   title: "title",