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

package/dist/collection/components/button/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.605
+ * v1.0.0-next.607
  */
 import "form-request-submit-polyfill/form-request-submit-polyfill";
 import { h, Build } from "@stencil/core";
@@ -21,31 +21,37 @@ export class Button {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** optionally specify alignment of button elements. */
+    /** Specifies the alignment of the component's elements. */
     this.alignment = "center";
-    /** 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 of the component. */
     this.color = "blue";
-    /** is the button disabled  */
+    /**  When `true`, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
     /**
-     * string to override English loading text
+     * Accessible name when the component is loading.
      *
      * @default "Loading"
      */
     this.intlLoading = TEXT.loading;
-    /** optionally add a calcite-loader component to the button, disabling interaction.  */
+    /**
+     * When `true`, a busy indicator is displayed and interaction is disabled.
+     */
     this.loading = false;
-    /** optionally add a round style to the button  */
+    /** When `true`, adds a round style to the component. */
     this.round = false;
-    /** specify the scale of the button, defaults to m */
+    /** Specifies the size of the component. */
     this.scale = "m";
-    /** is the button a child of a calcite-split-button */
+    /** Specifies if the component is a child of a `calcite-split-button`. */
     this.splitChild = false;
-    /** The type attribute to apply to the button */
+    /**
+     * Specifies the default behavior of the button.
+     *
+     * @mdn [type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type)
+     */
     this.type = "button";
-    /** specify the width of the button, defaults to auto */
+    /** Specifies the width of the component. */
     this.width = "auto";
     /** watches for changing text content */
     this.mutationObserver = createObserver("mutation", () => this.updateHasContent());
@@ -178,7 +184,7 @@ export class Button {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "optionally specify alignment of button elements."
+          "text": "Specifies the alignment of the component's elements."
         },
         "attribute": "alignment",
         "reflect": true,
@@ -201,7 +207,7 @@ export class Button {
         "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,
@@ -219,7 +225,7 @@ export class Button {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "Applies to the aria-label attribute on the button or hyperlink"
+          "text": "Accessible name for the component."
         },
         "attribute": "label",
         "reflect": false
@@ -241,7 +247,7 @@ export class Button {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "specify the color of the button, defaults to blue"
+          "text": "Specifies the color of the component."
         },
         "attribute": "color",
         "reflect": true,
@@ -259,7 +265,7 @@ export class Button {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "is the button disabled"
+          "text": "When `true`, interaction is prevented and the component is displayed with lower opacity."
         },
         "attribute": "disabled",
         "reflect": true,
@@ -277,7 +283,7 @@ export class Button {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "optionally pass a href - used to determine if the component should render as a button or an anchor"
+          "text": "Specifies the URL of the linked resource, which can be set as an absolute or relative path."
         },
         "attribute": "href",
         "reflect": true
@@ -316,7 +322,7 @@ export class Button {
         "optional": true,
         "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
@@ -353,7 +359,7 @@ export class Button {
               "name": "default",
               "text": "\"Loading\""
             }],
-          "text": "string to override English loading text"
+          "text": "Accessible name when the component is loading."
         },
         "attribute": "intl-loading",
         "reflect": false,
@@ -371,7 +377,7 @@ export class Button {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "optionally add a calcite-loader component to the button, disabling interaction."
+          "text": "When `true`, a busy indicator is displayed and interaction is disabled."
         },
         "attribute": "loading",
         "reflect": true,
@@ -389,7 +395,7 @@ export class Button {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "The name attribute to apply to the button"
+          "text": "Specifies the name of the component on form submission."
         },
         "attribute": "name",
         "reflect": true
@@ -405,8 +411,11 @@ export class Button {
         "required": false,
         "optional": true,
         "docs": {
-          "tags": [],
-          "text": "The rel attribute to apply to the hyperlink"
+          "tags": [{
+              "name": "mdn",
+              "text": "[rel](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/rel)"
+            }],
+          "text": "Defines the relationship between the `href` value and the current document."
         },
         "attribute": "rel",
         "reflect": true
@@ -424,9 +433,9 @@ export class Button {
         "docs": {
           "tags": [{
               "name": "deprecated",
-              "text": "\u2013 this property is no longer needed if placed inside a form."
+              "text": "\u2013 The property is no longer needed if the component is placed inside a form."
             }],
-          "text": "The form ID to associate with the component"
+          "text": "The form ID to associate with the component."
         },
         "attribute": "form",
         "reflect": false
@@ -443,7 +452,7 @@ export class Button {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "optionally add a round style to the button"
+          "text": "When `true`, adds a round style to the component."
         },
         "attribute": "round",
         "reflect": true,
@@ -466,7 +475,7 @@ export class Button {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "specify the scale of the button, defaults to m"
+          "text": "Specifies the size of the component."
         },
         "attribute": "scale",
         "reflect": true,
@@ -484,7 +493,7 @@ export class Button {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "is the button a child of a calcite-split-button"
+          "text": "Specifies if the component is a child of a `calcite-split-button`."
         },
         "attribute": "split-child",
         "reflect": true,
@@ -501,8 +510,11 @@ export class Button {
         "required": false,
         "optional": true,
         "docs": {
-          "tags": [],
-          "text": "The target attribute to apply to the hyperlink"
+          "tags": [{
+              "name": "mdn",
+              "text": "[target](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#attr-target)"
+            }],
+          "text": "Specifies where to open the linked document defined in the `href` property."
         },
         "attribute": "target",
         "reflect": true
@@ -518,8 +530,11 @@ export class Button {
         "required": false,
         "optional": false,
         "docs": {
-          "tags": [],
-          "text": "The type attribute to apply to the button"
+          "tags": [{
+              "name": "mdn",
+              "text": "[type](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/button#attr-type)"
+            }],
+          "text": "Specifies the default behavior of the button."
         },
         "attribute": "type",
         "reflect": true,
@@ -542,7 +557,7 @@ export class Button {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "specify the width of the button, defaults to auto"
+          "text": "Specifies the width of the component."
         },
         "attribute": "width",
         "reflect": true,

package/dist/collection/components/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.605
+ * v1.0.0-next.607
  */
 export const CSS = {
   buttonLoader: "calcite-button--loader",

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.607
  */
 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.607
  */
 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.607
  */
 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",