@esri/calcite-components 1.0.0-beta.83 → 1.0.0-beta.86

package/dist/collection/components/input/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-beta.83
+ * v1.0.0-beta.86
  */
 import { Component, Element, Event, h, Host, Method, Prop, State, Watch } from "@stencil/core";
 import { getElementDir, getElementProp, getSlotted, setRequestedIcon } from "../../utils/dom";
@@ -16,7 +16,7 @@ import { decimalPlaces } from "../../utils/math";
 import { createObserver } from "../../utils/observers";
 import { updateHostInteraction } from "../../utils/interactive";
 /**
- * @slot action - A slot for positioning a button next to an input
+ * @slot action - A slot for positioning a button next to the component.
  */
 export class Input {
   constructor() {
@@ -25,33 +25,45 @@ export class Input {
     //  Properties
     //
     //--------------------------------------------------------------------------
-    /** specify the alignment of the value of the input */
+    /** Specifies the text alignment of the component's value. */
     this.alignment = "start";
-    /** should the input autofocus */
+    /**
+     * When true, the component is focused on page load.
+     *
+     * @mdn [autofocus](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)
+     */
     this.autofocus = false;
     /**
-     * optionally display a clear button that displays when field has a value
-     * shows by default for search, time, date
-     * will not display for type="textarea"
+     * When true, a clear button is displayed when the component has a value. The clear button shows by default for "search", "time", and "date" types, and will not display for the "textarea" type.
      */
     this.clearable = false;
-    /** is the input disabled  */
+    /**
+     * When true, interaction is prevented and the component is displayed with lower opacity.
+     *
+     * @mdn [disabled](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled)
+     */
     this.disabled = false;
-    /** for number values, displays the locale's group separator */
+    /**
+     * When true, number values are displayed with the locale's group separator.
+     */
     this.groupSeparator = false;
-    /** when true, the component will not be visible */
+    /**
+     * When true, the component will not be visible.
+     *
+     * @mdn [hidden](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/hidden)
+     */
     this.hidden = false;
     /**
-     * string to override English loading text
+     * Accessible name that will appear while loading.
      *
      * @default "Loading"
      */
     this.intlLoading = COMMON_TEXT.loading;
-    /** flip the icon in rtl */
+    /** When true, the icon is flipped in RTL. */
     this.iconFlipRtl = false;
-    /** specify if the input is in loading state */
+    /** When true, the component is in the loading state and `calcite-progress` is displayed. */
     this.loading = false;
-    /** BCP 47 language tag for desired language and country format */
+    /** Specifies the BCP 47 language tag for the desired language and country format. */
     this.locale = document.documentElement.lang || "en";
     /**
      * Toggles locale formatting for numbers.
@@ -59,27 +71,31 @@ export class Input {
      * @internal
      */
     this.localeFormat = false;
-    /** specify the placement of the number buttons */
+    /** Specifies the placement of the buttons for type "number". */
     this.numberButtonType = "vertical";
-    /** When true, a field cannot be modified. */
+    /**
+     * When true, the value cannot be modified.
+     *
+     * @mdn [readOnly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly)
+     */
     this.readOnly = false;
-    /** is the input required */
+    /** When true, the component must have a value in order for the form to submit. */
     this.required = false;
-    /** specify the scale of the input, defaults to m */
+    /** Specifies the size of the component. */
     this.scale = "m";
-    /** specify the status of the input field, determines message and icons */
+    /** Specifies the status of the input field, which determines message and icons. */
     this.status = "idle";
     /**
      * @internal
      */
     this.editingEnabled = false;
     /**
-     * specify the input type
+     * Specifies the component type.
      *
-     * Note that the following types add type-specific icons by default: `date`, `email`, `password`, `search`, `tel`, `time`
+     * Note that the following types add type-specific icons by default: "date", "email", "password", "search", "tel", "time".
      */
     this.type = "text";
-    /** input value */
+    /** The component's value. */
     this.value = "";
     /** keep track of the rendered child type */
     this.childElType = "input";
@@ -258,13 +274,15 @@ export class Input {
         this.incrementOrDecrementNumberValue(direction, inputMax, inputMin, nativeEvent);
       }, valueNudgeDelayInMs);
     };
-    this.numberButtonMouseUpAndMouseOutHandler = () => {
+    this.numberButtonPointerUpAndOutHandler = () => {
       window.clearInterval(this.nudgeNumberValueIntervalId);
     };
-    this.numberButtonMouseDownHandler = (event) => {
+    this.numberButtonPointerDownHandler = (event) => {
       event.preventDefault();
       const direction = event.target.dataset.adjustment;
-      this.nudgeNumberValue(direction, event);
+      if (!this.disabled) {
+        this.nudgeNumberValue(direction, event);
+      }
     };
     this.setChildElRef = (el) => {
       this.childEl = el;
@@ -446,6 +464,16 @@ export class Input {
       (_b = this.childEl) === null || _b === void 0 ? void 0 : _b.focus();
     }
   }
+  /** Selects all text of the component's `value`. */
+  async selectText() {
+    var _a, _b;
+    if (this.type === "number") {
+      (_a = this.childNumberEl) === null || _a === void 0 ? void 0 : _a.select();
+    }
+    else {
+      (_b = this.childEl) === null || _b === void 0 ? void 0 : _b.select();
+    }
+  }
   onLabelClick() {
     this.setFocus();
   }
@@ -524,12 +552,12 @@ export class Input {
     const numberButtonsHorizontalUp = (h("button", { class: {
         [CSS.numberButtonItem]: true,
         [CSS.buttonItemHorizontal]: isHorizontalNumberButton
-      }, "data-adjustment": "up", disabled: this.disabled || this.readOnly, onMouseDown: this.numberButtonMouseDownHandler, onMouseOut: this.numberButtonMouseUpAndMouseOutHandler, onMouseUp: this.numberButtonMouseUpAndMouseOutHandler, tabIndex: -1, type: "button" },
+      }, "data-adjustment": "up", disabled: this.disabled || this.readOnly, onPointerDown: this.numberButtonPointerDownHandler, onPointerOut: this.numberButtonPointerUpAndOutHandler, onPointerUp: this.numberButtonPointerUpAndOutHandler, tabIndex: -1, type: "button" },
       h("calcite-icon", { icon: "chevron-up", scale: "s" })));
     const numberButtonsHorizontalDown = (h("button", { class: {
         [CSS.numberButtonItem]: true,
         [CSS.buttonItemHorizontal]: isHorizontalNumberButton
-      }, "data-adjustment": "down", disabled: this.disabled || this.readOnly, onMouseDown: this.numberButtonMouseDownHandler, onMouseOut: this.numberButtonMouseUpAndMouseOutHandler, onMouseUp: this.numberButtonMouseUpAndMouseOutHandler, tabIndex: -1, type: "button" },
+      }, "data-adjustment": "down", disabled: this.disabled || this.readOnly, onPointerDown: this.numberButtonPointerDownHandler, onPointerOut: this.numberButtonPointerUpAndOutHandler, onPointerUp: this.numberButtonPointerUpAndOutHandler, tabIndex: -1, type: "button" },
       h("calcite-icon", { icon: "chevron-down", scale: "s" })));
     const numberButtonsVertical = (h("div", { class: CSS.numberButtonWrapper },
       numberButtonsHorizontalUp,
@@ -596,7 +624,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the alignment of the value of the input"
+        "text": "Specifies the text alignment of the component's value."
       },
       "attribute": "alignment",
       "reflect": true,
@@ -613,8 +641,11 @@ export class Input {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "should the input autofocus"
+        "tags": [{
+            "name": "mdn",
+            "text": "[autofocus](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)"
+          }],
+        "text": "When true, the component is focused on page load."
       },
       "attribute": "autofocus",
       "reflect": false,
@@ -632,7 +663,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "optionally display a clear button that displays when field has a value\nshows by default for search, time, date\nwill not display for type=\"textarea\""
+        "text": "When true, a clear button is displayed when the component has a value. The clear button shows by default for \"search\", \"time\", and \"date\" types, and will not display for the \"textarea\" type."
       },
       "attribute": "clearable",
       "reflect": true,
@@ -649,8 +680,11 @@ export class Input {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "is the input disabled"
+        "tags": [{
+            "name": "mdn",
+            "text": "[disabled](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled)"
+          }],
+        "text": "When true, interaction is prevented and the component is displayed with lower opacity."
       },
       "attribute": "disabled",
       "reflect": true,
@@ -668,7 +702,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "for number values, displays the locale's group separator"
+        "text": "When true, number values are displayed with the locale's group separator."
       },
       "attribute": "group-separator",
       "reflect": false,
@@ -685,8 +719,11 @@ export class Input {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "when true, the component will not be visible"
+        "tags": [{
+            "name": "mdn",
+            "text": "[hidden](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/hidden)"
+          }],
+        "text": "When true, the component will not be visible."
       },
       "attribute": "hidden",
       "reflect": false,
@@ -704,7 +741,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "when used as a boolean set to true, show a default recommended icon for certain\ninput types (tel, password, email, date, time, search). You can also pass a\ncalcite-ui-icon name to this prop to display a requested icon for any input type"
+        "text": "When true, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon."
       },
       "attribute": "icon",
       "reflect": true
@@ -741,7 +778,7 @@ export class Input {
             "name": "default",
             "text": "\"Loading\""
           }],
-        "text": "string to override English loading text"
+        "text": "Accessible name that will appear while loading."
       },
       "attribute": "intl-loading",
       "reflect": false,
@@ -759,7 +796,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "flip the icon in rtl"
+        "text": "When true, the icon is flipped in RTL."
       },
       "attribute": "icon-flip-rtl",
       "reflect": true,
@@ -777,7 +814,7 @@ export class Input {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "Applies to the aria-label attribute on the button or hyperlink"
+        "text": "Accessible name for the component's button or hyperlink."
       },
       "attribute": "label",
       "reflect": false
@@ -794,7 +831,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify if the input is in loading state"
+        "text": "When true, the component is in the loading state and `calcite-progress` is displayed."
       },
       "attribute": "loading",
       "reflect": true,
@@ -812,7 +849,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "BCP 47 language tag for desired language and country format"
+        "text": "Specifies the BCP 47 language tag for the desired language and country format."
       },
       "attribute": "locale",
       "reflect": false,
@@ -829,8 +866,11 @@ export class Input {
       "required": false,
       "optional": true,
       "docs": {
-        "tags": [],
-        "text": "standard UniCode numeral system tag for localization"
+        "tags": [{
+            "name": "mdn",
+            "text": "[numberingSystem](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/numberingSystem)"
+          }],
+        "text": "Specifies the Unicode numeral system used by the component for localization."
       },
       "attribute": "numbering-system",
       "reflect": false
@@ -867,8 +907,11 @@ export class Input {
       "required": false,
       "optional": true,
       "docs": {
-        "tags": [],
-        "text": "input max"
+        "tags": [{
+            "name": "mdn",
+            "text": "[max](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max)"
+          }],
+        "text": "Specifies the maximum value for type \"number\"."
       },
       "attribute": "max",
       "reflect": true
@@ -884,8 +927,11 @@ export class Input {
       "required": false,
       "optional": true,
       "docs": {
-        "tags": [],
-        "text": "input min"
+        "tags": [{
+            "name": "mdn",
+            "text": "[min](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min)"
+          }],
+        "text": "Specifies the minimum value for type \"number\"."
       },
       "attribute": "min",
       "reflect": true
@@ -905,7 +951,7 @@ export class Input {
             "name": "deprecated",
             "text": "use maxLength instead"
           }],
-        "text": "Maximum length of text input."
+        "text": "Specifies the maximum length of text for the component's value."
       },
       "attribute": "maxlength",
       "reflect": true
@@ -921,8 +967,11 @@ export class Input {
       "required": false,
       "optional": true,
       "docs": {
-        "tags": [],
-        "text": "Maximum length of the input value"
+        "tags": [{
+            "name": "mdn",
+            "text": "[maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength)"
+          }],
+        "text": "Specifies the maximum length of text for the component's value."
       },
       "attribute": "max-length",
       "reflect": true
@@ -938,8 +987,11 @@ export class Input {
       "required": false,
       "optional": true,
       "docs": {
-        "tags": [],
-        "text": "Minimum length of the text input"
+        "tags": [{
+            "name": "mdn",
+            "text": "[minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength)"
+          }],
+        "text": "Specifies the minimum length of text for the component's value."
       },
       "attribute": "min-length",
       "reflect": true
@@ -955,8 +1007,11 @@ export class Input {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "The name of the input"
+        "tags": [{
+            "name": "mdn",
+            "text": "[name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)"
+          }],
+        "text": "Specifies the name of the component."
       },
       "attribute": "name",
       "reflect": true
@@ -978,7 +1033,7 @@ export class Input {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "specify the placement of the number buttons"
+        "text": "Specifies the placement of the buttons for type \"number\"."
       },
       "attribute": "number-button-type",
       "reflect": true,
@@ -995,8 +1050,11 @@ export class Input {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "explicitly whitelist placeholder attribute"
+        "tags": [{
+            "name": "mdn",
+            "text": "[placeholder](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder)"
+          }],
+        "text": "Specifies placeholder text for the component."
       },
       "attribute": "placeholder",
       "reflect": false
@@ -1013,7 +1071,7 @@ export class Input {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "optionally add prefix"
+        "text": "Adds text to the start of the component."
       },
       "attribute": "prefix-text",
       "reflect": false
@@ -1029,8 +1087,11 @@ export class Input {
       "required": false,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "When true, a field cannot be modified."
+        "tags": [{
+            "name": "mdn",
+            "text": "[readOnly](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/readonly)"
+          }],
+        "text": "When true, the value cannot be modified."
       },
       "attribute": "read-only",
       "reflect": false,
@@ -1048,7 +1109,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "is the input required"
+        "text": "When true, the component must have a value in order for the form to submit."
       },
       "attribute": "required",
       "reflect": false,
@@ -1071,7 +1132,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the scale of the input, defaults to m"
+        "text": "Specifies the size of the component."
       },
       "attribute": "scale",
       "reflect": true,
@@ -1094,7 +1155,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the status of the input field, determines message and icons"
+        "text": "Specifies the status of the input field, which determines message and icons."
       },
       "attribute": "status",
       "reflect": true,
@@ -1111,8 +1172,11 @@ export class Input {
       "required": false,
       "optional": true,
       "docs": {
-        "tags": [],
-        "text": "input step"
+        "tags": [{
+            "name": "mdn",
+            "text": "[step](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/step)"
+          }],
+        "text": "Specifies the granularity that the component's value must adhere to."
       },
       "attribute": "step",
       "reflect": true
@@ -1129,7 +1193,7 @@ export class Input {
       "optional": true,
       "docs": {
         "tags": [],
-        "text": "optionally add suffix"
+        "text": "Adds text to the end of the component."
       },
       "attribute": "suffix-text",
       "reflect": false
@@ -1167,7 +1231,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "specify the input type\n\nNote that the following types add type-specific icons by default: `date`, `email`, `password`, `search`, `tel`, `time`"
+        "text": "Specifies the component type.\n\nNote that the following types add type-specific icons by default: \"date\", \"email\", \"password\", \"search\", \"tel\", \"time\"."
       },
       "attribute": "type",
       "reflect": true,
@@ -1185,7 +1249,7 @@ export class Input {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "input value"
+        "text": "The component's value."
       },
       "attribute": "value",
       "reflect": false,
@@ -1239,7 +1303,7 @@ export class Input {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "This event fires each time a new value is typed."
+        "text": "Fires each time a new value is typed."
       },
       "complexType": {
         "original": "any",
@@ -1254,7 +1318,7 @@ export class Input {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "This event fires each time a new value is typed and committed."
+        "text": "Fires each time a new value is typed and committed."
       },
       "complexType": {
         "original": "void",
@@ -1278,6 +1342,22 @@ export class Input {
         "text": "Sets focus on the component.",
         "tags": []
       }
+    },
+    "selectText": {
+      "complexType": {
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "references": {
+          "Promise": {
+            "location": "global"
+          }
+        },
+        "return": "Promise<void>"
+      },
+      "docs": {
+        "text": "Selects all text of the component's `value`.",
+        "tags": []
+      }
     }
   }; }
   static get elementRef() { return "el"; }

package/dist/collection/components/input/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-beta.83
+ * v1.0.0-beta.86
  */
 export {};

package/dist/collection/components/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-beta.83
+ * v1.0.0-beta.86
  */
 export const CSS = {
   loader: "loader",