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

package/dist/collection/components/block/block.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 { CSS, HEADING_LEVEL, ICONS, SLOTS, TEXT } from "./resources";
@@ -11,10 +11,10 @@ import { connectConditionalSlotComponent, disconnectConditionalSlotComponent } f
 import { updateHostInteraction } from "../../utils/interactive";
 import { guid } from "../../utils/guid";
 /**
- * @slot - A slot for adding content to the block.
- * @slot icon - A slot for adding a leading header icon.
+ * @slot - A slot for adding content to the component.
+ * @slot icon - A slot for adding a leading header icon with `calcite-icon`.
  * @slot control - A slot for adding a single HTML input element in a header.
- * @slot header-menu-actions - a slot for adding an overflow menu with actions inside a dropdown.
+ * @slot header-menu-actions - A slot for adding an overflow menu with `calcite-action`s inside a dropdown.
  */
 export class Block {
   constructor() {
@@ -24,51 +24,51 @@ export class Block {
     //
     // --------------------------------------------------------------------------
     /**
-     * When true, this block will be collapsible.
+     * When `true`, the component is collapsible.
      */
     this.collapsible = false;
     /**
-     * When true, disabled prevents interaction. This state shows items with lower opacity/grayed.
+     * When `true`, interaction is prevented and the component is displayed with lower opacity.
      */
     this.disabled = false;
     /**
-     * When true, displays a drag handle in the header.
+     * When `true`, displays a drag handle in the header.
      */
     this.dragHandle = false;
     /**
-     * Aria-label for collapsing the toggle and tooltip used for the toggle when expanded.
+     * Accessible name for the component's collapse button.
      *
      * @default "Collapse"
      */
     this.intlCollapse = TEXT.collapse;
     /**
-     * Aria-label for expanding the toggle and tooltip used for the toggle when collapsed.
+     * Accessible name for the component's expand button.
      *
      * @default "Expand"
      */
     this.intlExpand = TEXT.expand;
     /**
-     * string to override English loading text
+     * Accessible name when the component is loading.
      *
      * @default "Loading"
      */
     this.intlLoading = TEXT.loading;
     /**
-     * Text string used for the actions menu
+     * Accessible name for the component's options button.
      *
      * @default "Options"
      */
     this.intlOptions = TEXT.options;
     /**
-     * When true, content is waiting to be loaded. This state shows a busy indicator.
+     * When `true`, a busy indicator is displayed.
      */
     this.loading = false;
     /**
-     * When true, the block's content will be displayed.
+     * When `true`, expands the component and its contents.
      */
     this.open = false;
     /**
-     * When true, removes padding for the slotted content
+     * When `true`, removes padding for the slotted content.
      *
      * @deprecated Use `--calcite-block-padding` CSS variable instead.
      */
@@ -174,7 +174,7 @@ export class Block {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, this block will be collapsible."
+          "text": "When `true`, the component is collapsible."
         },
         "attribute": "collapsible",
         "reflect": true,
@@ -192,7 +192,7 @@ export class Block {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, disabled prevents interaction. This state shows items with lower opacity/grayed."
+          "text": "When `true`, interaction is prevented and the component is displayed with lower opacity."
         },
         "attribute": "disabled",
         "reflect": true,
@@ -210,7 +210,7 @@ export class Block {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, displays a drag handle in the header."
+          "text": "When `true`, displays a drag handle in the header."
         },
         "attribute": "drag-handle",
         "reflect": true,
@@ -228,7 +228,7 @@ export class Block {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Block heading."
+          "text": "The component header text."
         },
         "attribute": "heading",
         "reflect": false
@@ -250,7 +250,7 @@ export class Block {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Number at which section headings should start for this component."
+          "text": "Specifies the number at which section headings should start."
         },
         "attribute": "heading-level",
         "reflect": true
@@ -270,7 +270,7 @@ export class Block {
               "name": "default",
               "text": "\"Collapse\""
             }],
-          "text": "Aria-label for collapsing the toggle and tooltip used for the toggle when expanded."
+          "text": "Accessible name for the component's collapse button."
         },
         "attribute": "intl-collapse",
         "reflect": false,
@@ -291,7 +291,7 @@ export class Block {
               "name": "default",
               "text": "\"Expand\""
             }],
-          "text": "Aria-label for expanding the toggle and tooltip used for the toggle when collapsed."
+          "text": "Accessible name for the component's expand button."
         },
         "attribute": "intl-expand",
         "reflect": false,
@@ -312,7 +312,7 @@ export class Block {
               "name": "default",
               "text": "\"Loading\""
             }],
-          "text": "string to override English loading text"
+          "text": "Accessible name when the component is loading."
         },
         "attribute": "intl-loading",
         "reflect": false,
@@ -333,7 +333,7 @@ export class Block {
               "name": "default",
               "text": "\"Options\""
             }],
-          "text": "Text string used for the actions menu"
+          "text": "Accessible name for the component's options button."
         },
         "attribute": "intl-options",
         "reflect": false,
@@ -351,7 +351,7 @@ export class Block {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, content is waiting to be loaded. This state shows a busy indicator."
+          "text": "When `true`, a busy indicator is displayed."
         },
         "attribute": "loading",
         "reflect": true,
@@ -369,7 +369,7 @@ export class Block {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, the block's content will be displayed."
+          "text": "When `true`, expands the component and its contents."
         },
         "attribute": "open",
         "reflect": true,
@@ -392,7 +392,7 @@ export class Block {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "Block status. Updates or adds icon to show related icon and color."
+          "text": "Displays a status-related indicator icon."
         },
         "attribute": "status",
         "reflect": true
@@ -410,9 +410,9 @@ export class Block {
         "docs": {
           "tags": [{
               "name": "deprecated",
-              "text": "use description instead"
+              "text": "use `description` instead"
             }],
-          "text": "Block summary."
+          "text": "A description for the component, which displays below the heading."
         },
         "attribute": "summary",
         "reflect": false
@@ -429,7 +429,7 @@ export class Block {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Block description"
+          "text": "A description for the component, which displays below the heading."
         },
         "attribute": "description",
         "reflect": false
@@ -449,7 +449,7 @@ export class Block {
               "name": "deprecated",
               "text": "Use `--calcite-block-padding` CSS variable instead."
             }],
-          "text": "When true, removes padding for the slotted content"
+          "text": "When `true`, removes padding for the slotted content."
         },
         "attribute": "disable-padding",
         "reflect": true,
@@ -466,7 +466,7 @@ export class Block {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Emitted when the header has been clicked."
+          "text": "Emits when the component's header is clicked."
         },
         "complexType": {
           "original": "void",

package/dist/collection/components/block/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/block-section/block-section.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 { getElementDir, toAriaBoolean } from "../../utils/dom";
@@ -9,18 +9,20 @@ import { CSS, ICONS, TEXT } from "./resources";
 import { guid } from "../../utils/guid";
 import { isActivationKey } from "../../utils/key";
 /**
- * @slot - A slot for adding content to the block section.
+ * @slot - A slot for adding content to the component.
  */
 export class BlockSection {
   constructor() {
     /**
-     * When true, the block's section content will be displayed.
+     * When `true`, expands the component and its contents.
      */
     this.open = false;
     /**
-     * This property determines the look of the section toggle.
-     * If the value is "switch", a toggle-switch will be displayed.
-     * If the value is "button", a clickable header is displayed.
+     * Specifies the component's toggle display -
+     *
+     * `"button"` (selectable header), or
+     *
+     * `"switch"` (toggle switch).
      */
     this.toggleDisplay = "button";
     this.guid = guid();
@@ -104,7 +106,7 @@ export class BlockSection {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "Tooltip used for the toggle when expanded."
+          "text": "Accessible name for the component's collapse button."
         },
         "attribute": "intl-collapse",
         "reflect": false
@@ -121,7 +123,7 @@ export class BlockSection {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "Tooltip used for the toggle when collapsed."
+          "text": "Accessible name for the component's expand button."
         },
         "attribute": "intl-expand",
         "reflect": false
@@ -138,7 +140,7 @@ export class BlockSection {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, the block's section content will be displayed."
+          "text": "When `true`, expands the component and its contents."
         },
         "attribute": "open",
         "reflect": true,
@@ -161,7 +163,7 @@ export class BlockSection {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "BlockSection status. Adds indicator to show valid or invalid status."
+          "text": "Displays a status-related indicator icon."
         },
         "attribute": "status",
         "reflect": true
@@ -178,7 +180,7 @@ export class BlockSection {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Text displayed in the button."
+          "text": "The component header text."
         },
         "attribute": "text",
         "reflect": false
@@ -200,7 +202,7 @@ export class BlockSection {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "This property determines the look of the section toggle.\nIf the value is \"switch\", a toggle-switch will be displayed.\nIf the value is \"button\", a clickable header is displayed."
+          "text": "Specifies the component's toggle display -\n\n`\"button\"` (selectable header), or\n\n`\"switch\"` (toggle switch)."
         },
         "attribute": "toggle-display",
         "reflect": true,
@@ -217,7 +219,7 @@ export class BlockSection {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Emitted when the header has been clicked."
+          "text": "Emits when the header has been clicked."
         },
         "complexType": {
           "original": "void",

package/dist/collection/components/block-section/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 = {
   content: "content",

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.606
  */
 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.606
  */
 export const CSS = {
   buttonLoader: "calcite-button--loader",