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

package/dist/collection/components/color-picker-hex-input/color-picker-hex-input.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.604
+ * v1.0.0-next.606
  */
 import { h } from "@stencil/core";
 import { hexChar, isLonghandHex, isValidHex, normalizeHex, rgbToHex } from "../color-picker/utils";
@@ -18,29 +18,27 @@ export class ColorPickerHexInput {
     //
     //--------------------------------------------------------------------------
     /**
-     * When false, empty color (null) will be allowed as a value. Otherwise, a color value is always enforced by the component.
+     * When `false`, an empty color (`null`) will be allowed as a `value`. Otherwise, a color value is enforced on the component.
      *
-     * When true, clearing the input and blurring will restore the last valid color set. When false, it will set it to empty.
+     * When `true`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`. When `false`, an empty color (`null`) will be allowed as a `value`.
      */
     this.allowEmpty = false;
     /**
-     * Label used for the hex input.
+     * Accessible name for the Hex input.
      *
      * @default "Hex"
      */
     this.intlHex = TEXT.hex;
     /**
-     * Label used for the hex input when there is no color selected.
+     * Accessible name for the Hex input when there is no color selected.
      *
      * @default "No color"
      */
     this.intlNoColor = TEXT.noColor;
-    /**
-     * The component's scale.
-     */
+    /** Specifies the size of the component. */
     this.scale = "m";
     /**
-     * The hex value.
+     * The Hex value.
      */
     this.value = normalizeHex(DEFAULT_COLOR.hex());
     this.onCalciteInternalInputBlur = () => {
@@ -213,7 +211,7 @@ export class ColorPickerHexInput {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When false, empty color (null) will be allowed as a value. Otherwise, a color value is always enforced by the component.\n\nWhen true, clearing the input and blurring will restore the last valid color set. When false, it will set it to empty."
+          "text": "When `false`, an empty color (`null`) will be allowed as a `value`. Otherwise, a color value is enforced on the component.\n\nWhen `true`, a color value is enforced, and clearing the input or blurring will restore the last valid `value`. When `false`, an empty color (`null`) will be allowed as a `value`."
         },
         "attribute": "allow-empty",
         "reflect": false,
@@ -234,7 +232,7 @@ export class ColorPickerHexInput {
               "name": "default",
               "text": "\"Hex\""
             }],
-          "text": "Label used for the hex input."
+          "text": "Accessible name for the Hex input."
         },
         "attribute": "intl-hex",
         "reflect": false,
@@ -255,7 +253,7 @@ export class ColorPickerHexInput {
               "name": "default",
               "text": "\"No color\""
             }],
-          "text": "Label used for the hex input when there is no color selected."
+          "text": "Accessible name for the Hex input when there is no color selected."
         },
         "attribute": "intl-no-color",
         "reflect": false,
@@ -278,7 +276,7 @@ export class ColorPickerHexInput {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The component's scale."
+          "text": "Specifies the size of the component."
         },
         "attribute": "scale",
         "reflect": true,
@@ -296,7 +294,7 @@ export class ColorPickerHexInput {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The hex value."
+          "text": "The Hex value."
         },
         "attribute": "value",
         "reflect": true,

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

package/dist/collection/components/color-picker-swatch/color-picker-swatch.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.604
+ * v1.0.0-next.606
  */
 import { h } from "@stencil/core";
 import Color from "color";
@@ -15,11 +15,11 @@ export class ColorPickerSwatch {
     //
     //--------------------------------------------------------------------------
     /**
-     * Used to display whether the swatch is active or not.
+     * When `true`, the component is active.
      */
     this.active = false;
     /**
-     * The component scale.
+     * Specifies the size of the component.
      */
     this.scale = "m";
   }
@@ -68,7 +68,7 @@ export class ColorPickerSwatch {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Used to display whether the swatch is active or not."
+          "text": "When `true`, the component is active."
         },
         "attribute": "active",
         "reflect": true,
@@ -111,7 +111,7 @@ export class ColorPickerSwatch {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The component scale."
+          "text": "Specifies the size of the component."
         },
         "attribute": "scale",
         "reflect": true,

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

package/dist/collection/components/combobox/combobox.css

@@ -96,7 +96,7 @@
 *
 * These properties can be overridden using the component's tag as selector.
 *
-* @prop --calcite-combobox-input-height: the height of the combobox input
+* @prop --calcite-combobox-input-height: Specifies the height of the component's input.
 */
 :host {
   position: relative;

package/dist/collection/components/combobox/combobox.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.604
+ * v1.0.0-next.606
  */
 import { h, Host } from "@stencil/core";
 import { filter } from "../../utils/filter";
@@ -33,16 +33,16 @@ export class Combobox {
     //
     //--------------------------------------------------------------------------
     /**
-     * When true, opens the combobox
+     * When `true`, displays and positions the component.
      *
-     * @deprecated use open instead
+     * @deprecated use `open` instead.
      */
     this.active = false;
-    /**When true, opens the combobox */
+    /**When `true`, displays and positions the component. */
     this.open = false;
-    /** Disable combobox input */
+    /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
-    /** Specify the maximum number of combobox items (including nested children) to display before showing the scroller */
+    /** Specifies the maximum number of `calcite-combobox-item`s (including nested children) to display before displaying a scrollbar. */
     this.maxItems = 0;
     /**
      * Determines the type of positioning to use for the overlaid content.
@@ -54,24 +54,24 @@ export class Combobox {
      */
     this.overlayPositioning = "absolute";
     /**
-     * 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 selection mode
-     * - multi: allow any number of selected items (default)
-     * - single: only one selection)
-     * - ancestors: like multi, but show ancestors of selected items as selected, only deepest children shown in chips
+     * Specifies the selection mode -
+     * `"multi"` (allow any number of selected items),
+     * `"single"` (allow only one selection), or
+     * `"ancestors"` (like `"multi"`, but show ancestors of selected items as selected. Only the deepest children are shown in `calcite-chip`s).
      */
     this.selectionMode = "multi";
-    /** Specify the scale of the combobox, defaults to m */
+    /** Specifies the size of the component. */
     this.scale = "m";
-    /** The value(s) of the selectedItem(s) */
+    /** The component's value(s) from the selected `calcite-combobox-item`(s). */
     this.value = null;
     /**
-     * string to override the English "Remove tag" text for when an item is selected.
+     * Accessible name for the component's remove tag when a `calcite-combobox-item` is selected.
      *
      * @default "Remove tag"
      */
@@ -851,9 +851,9 @@ export class Combobox {
         "docs": {
           "tags": [{
               "name": "deprecated",
-              "text": "use open instead"
+              "text": "use `open` instead."
             }],
-          "text": "When true, opens the combobox"
+          "text": "When `true`, displays and positions the component."
         },
         "attribute": "active",
         "reflect": true,
@@ -871,7 +871,7 @@ export class Combobox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, opens the combobox"
+          "text": "When `true`, displays and positions the component."
         },
         "attribute": "open",
         "reflect": true,
@@ -889,7 +889,7 @@ export class Combobox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Disable combobox input"
+          "text": "When `true`, interaction is prevented and the component is displayed with lower opacity."
         },
         "attribute": "disabled",
         "reflect": true,
@@ -907,7 +907,7 @@ export class Combobox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Aria label for combobox (required)"
+          "text": "Accessible name for the component."
         },
         "attribute": "label",
         "reflect": false
@@ -924,7 +924,7 @@ export class Combobox {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "Placeholder text for input"
+          "text": "Specifies the placeholder text for the input."
         },
         "attribute": "placeholder",
         "reflect": false
@@ -941,7 +941,7 @@ export class Combobox {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "Placeholder icon for input"
+          "text": "Specifies the placeholder icon for the input."
         },
         "attribute": "placeholder-icon",
         "reflect": true
@@ -958,7 +958,7 @@ export class Combobox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Specify the maximum number of combobox items (including nested children) to display before showing the scroller"
+          "text": "Specifies the maximum number of `calcite-combobox-item`s (including nested children) to display before displaying a scrollbar."
         },
         "attribute": "max-items",
         "reflect": true,
@@ -976,7 +976,7 @@ export class Combobox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The name of the switch input"
+          "text": "Specifies the name of the component on form submission."
         },
         "attribute": "name",
         "reflect": true
@@ -993,7 +993,7 @@ export class Combobox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Allow entry of custom values which are not in the original set of items"
+          "text": "When `true`, allows entry of custom values, which are not in the original set of items."
         },
         "attribute": "allow-custom-values",
         "reflect": true
@@ -1036,7 +1036,7 @@ export class Combobox {
               "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,
@@ -1059,7 +1059,7 @@ export class Combobox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "specify the selection mode\n- multi: allow any number of selected items (default)\n- single: only one selection)\n- ancestors: like multi, but show ancestors of selected items as selected, only deepest children shown in chips"
+          "text": "Specifies the selection mode -\n`\"multi\"` (allow any number of selected items),\n`\"single\"` (allow only one selection), or\n`\"ancestors\"` (like `\"multi\"`, but show ancestors of selected items as selected. Only the deepest children are shown in `calcite-chip`s)."
         },
         "attribute": "selection-mode",
         "reflect": true,
@@ -1082,7 +1082,7 @@ export class Combobox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Specify the scale of the combobox, defaults to m"
+          "text": "Specifies the size of the component."
         },
         "attribute": "scale",
         "reflect": true,
@@ -1100,7 +1100,7 @@ export class Combobox {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The value(s) of the selectedItem(s)"
+          "text": "The component's value(s) from the selected `calcite-combobox-item`(s)."
         },
         "attribute": "value",
         "reflect": false,
@@ -1121,7 +1121,7 @@ export class Combobox {
               "name": "default",
               "text": "\"Remove tag\""
             }],
-          "text": "string to override the English \"Remove tag\" text for when an item is selected."
+          "text": "Accessible name for the component's remove tag when a `calcite-combobox-item` is selected."
         },
         "attribute": "intl-remove-tag",
         "reflect": false,
@@ -1172,9 +1172,9 @@ export class Combobox {
         "docs": {
           "tags": [{
               "name": "deprecated",
-              "text": "use calciteComboboxChange instead"
+              "text": "use `calciteComboboxChange` instead."
             }],
-          "text": "Called when the selected items set changes"
+          "text": "Fires when the selected items set changes."
         },
         "complexType": {
           "original": "HTMLCalciteComboboxItemElement[]",
@@ -1193,7 +1193,7 @@ export class Combobox {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Called when the selected item(s) changes."
+          "text": "Fires when the selected item(s) changes."
         },
         "complexType": {
           "original": "{\n    selectedItems: HTMLCalciteComboboxItemElement[];\n  }",
@@ -1212,7 +1212,7 @@ export class Combobox {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Called when the user has entered text to filter the options list"
+          "text": "Fires when text is added to filter the options list."
         },
         "complexType": {
           "original": "{\n    visibleItems: HTMLCalciteComboboxItemElement[];\n    text: string;\n  }",
@@ -1231,7 +1231,7 @@ export class Combobox {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Called when a selected item in the combobox is dismissed via its chip\n\n**Note:**: The event payload is deprecated, please use the `value` property on the component to determine removed value instead"
+          "text": "Fires when a selected item in the component is dismissed via its `calcite-chip`.\n\n**Note:**: The event payload is deprecated, please use the `value` property on the component to determine the removed value instead."
         },
         "complexType": {
           "original": "DeprecatedEventPayload",
@@ -1251,7 +1251,7 @@ export class Combobox {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Fires when the component is requested to be closed and before the closing transition begins."
+          "text": "Fires when the component is requested to be closed, and before the closing transition begins."
         },
         "complexType": {
           "original": "void",

package/dist/collection/components/combobox/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.604
+ * v1.0.0-next.606
  */
 export const ComboboxItem = "CALCITE-COMBOBOX-ITEM";
 export const ComboboxItemGroup = "CALCITE-COMBOBOX-ITEM-GROUP";

package/dist/collection/components/combobox/utils.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.604
+ * v1.0.0-next.606
  */
 import { nodeListToArray } from "../../utils/dom";
 import { ComboboxChildSelector } from "./resources";

package/dist/collection/components/combobox-item/combobox-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.604
+ * v1.0.0-next.606
  */
 import { Host, h } from "@stencil/core";
 import { getElementProp, getSlotted } from "../../utils/dom";
@@ -20,13 +20,15 @@ export class ComboboxItem {
     //  Properties
     //
     // --------------------------------------------------------------------------
-    /** When true, the item cannot be clicked and is visually muted. */
+    /** When `true`, interaction is prevented and the component is displayed with lower opacity. */
     this.disabled = false;
-    /** Set this to true to pre-select an item. Toggles when an item is checked/unchecked. */
+    /**
+     * When `true`, the component is selected.
+     */
     this.selected = false;
-    /** True when item is highlighted either from keyboard or mouse hover */
+    /** When `true`, the component is active. */
     this.active = false;
-    /** Unique identifier, used for accessibility */
+    /** The `id` attribute of the component. When omitted, a globally unique identifier is used. */
     this.guid = guid();
     this.scale = "m";
     // --------------------------------------------------------------------------
@@ -143,7 +145,7 @@ export class ComboboxItem {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "When true, the item cannot be clicked and is visually muted."
+          "text": "When `true`, interaction is prevented and the component is displayed with lower opacity."
         },
         "attribute": "disabled",
         "reflect": true,
@@ -161,7 +163,7 @@ export class ComboboxItem {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Set this to true to pre-select an item. Toggles when an item is checked/unchecked."
+          "text": "When `true`, the component is selected."
         },
         "attribute": "selected",
         "reflect": true,
@@ -179,7 +181,7 @@ export class ComboboxItem {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "True when item is highlighted either from keyboard or mouse hover"
+          "text": "When `true`, the component is active."
         },
         "attribute": "active",
         "reflect": true,
@@ -202,7 +204,7 @@ export class ComboboxItem {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Parent and grandparent combobox items, this is set internally for use from combobox"
+          "text": "Specifies the parent and grandparent items, which are set on `calcite-combobox`."
         }
       },
       "guid": {
@@ -217,7 +219,7 @@ export class ComboboxItem {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Unique identifier, used for accessibility"
+          "text": "The `id` attribute of the component. When omitted, a globally unique identifier is used."
         },
         "attribute": "guid",
         "reflect": true,
@@ -235,7 +237,7 @@ export class ComboboxItem {
         "optional": true,
         "docs": {
           "tags": [],
-          "text": "Custom icon to display both in combobox chips and next to combobox item text"
+          "text": "Specifies an icon to display."
         },
         "attribute": "icon",
         "reflect": true
@@ -252,7 +254,7 @@ export class ComboboxItem {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The main label for this item."
+          "text": "The component's text."
         },
         "attribute": "text-label",
         "reflect": true
@@ -269,7 +271,7 @@ export class ComboboxItem {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "The item's associated value"
+          "text": "The component's value."
         },
         "attribute": "value",
         "reflect": false
@@ -287,9 +289,9 @@ export class ComboboxItem {
         "docs": {
           "tags": [{
               "name": "deprecated",
-              "text": "use filterDisabled instead"
+              "text": "use `filterDisabled` instead."
             }],
-          "text": "Don't filter this item based on the search text"
+          "text": "When `true`, omits the component from the `calcite-combobox` filtered search results."
         },
         "attribute": "constant",
         "reflect": true
@@ -306,7 +308,7 @@ export class ComboboxItem {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Do not filter this item based on the search text"
+          "text": "When `true`, omits the component from the `calcite-combobox` filtered search results."
         },
         "attribute": "filter-disabled",
         "reflect": true
@@ -322,7 +324,7 @@ export class ComboboxItem {
         "composed": true,
         "docs": {
           "tags": [],
-          "text": "Emitted whenever the item is selected or unselected.\n\n**Note:**: The event's payload is deprecated, please use the event's `target`/`currentTarget` instead"
+          "text": "Emits whenever the component is selected or unselected.\n\n**Note:**: The event's payload is deprecated, please use the event's `target`/`currentTarget` instead"
         },
         "complexType": {
           "original": "DeprecatedEventPayload",

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

package/dist/collection/components/combobox-item-group/combobox-item-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.604
+ * v1.0.0-next.606
  */
 import { h } from "@stencil/core";
 import { CSS } from "./resources";
@@ -66,7 +66,7 @@ export class ComboboxItemGroup {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Parent and grandparent combobox items, this is set internally for use from combobox"
+          "text": "Specifies the parent and grandparent `calcite-combobox-item`s, which are set on `calcite-combobox`."
         }
       },
       "label": {
@@ -81,7 +81,7 @@ export class ComboboxItemGroup {
         "optional": false,
         "docs": {
           "tags": [],
-          "text": "Title of the group"
+          "text": "Specifies the title of the component."
         },
         "attribute": "label",
         "reflect": false

package/dist/collection/components/combobox-item-group/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.604
+ * v1.0.0-next.606
  */
 export const CSS = {
   list: "list",