@esri/calcite-components 1.0.0-next.503 → 1.0.0-next.506

package/dist/types/components/input/input.d.ts

@@ -7,31 +7,41 @@ import { FormComponent } from "../../utils/form";
 import { InteractiveComponent } from "../../utils/interactive";
 declare type NumberNudgeDirection = "up" | "down";
 /**
- * @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 declare class Input implements LabelableComponent, FormComponent, InteractiveComponent {
   el: HTMLCalciteInputElement;
-  /** specify the alignment of the value of the input */
+  /** Specifies the text alignment of the component's value. */
   alignment: Position;
-  /** 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)
+   */
   autofocus: boolean;
   /**
-   * 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.
    */
   clearable: boolean;
-  /** 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)
+   */
   disabled: boolean;
   disabledWatcher(): void;
-  /** for number values, displays the locale's group separator */
+  /**
+   * When true, number values are displayed with the locale's group separator.
+   */
   groupSeparator: boolean;
-  /** 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)
+   */
   hidden: boolean;
   /**
-   * when used as a boolean set to true, show a default recommended icon for certain
-   * input types (tel, password, email, date, time, search). You can also pass a
-   * calcite-ui-icon name to this prop to display a requested icon for any input type
+   * When true, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon.
    */
   icon: string | boolean;
   /**
@@ -39,21 +49,23 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
    */
   intlClear?: string;
   /**
-   * string to override English loading text
+   * Accessible name that will appear while loading.
    *
    * @default "Loading"
    */
   intlLoading?: string;
-  /** flip the icon in rtl */
+  /** When true, the icon is flipped in RTL. */
   iconFlipRtl: boolean;
-  /** Applies to the aria-label attribute on the button or hyperlink */
+  /** Accessible name for the component's button or hyperlink. */
   label?: string;
-  /** specify if the input is in loading state */
+  /** When true, the component is in the loading state and `calcite-progress` is displayed. */
   loading: boolean;
-  /** BCP 47 language tag for desired language and country format */
+  /** Specifies the BCP 47 language tag for the desired language and country format. */
   locale: string;
   /**
-   * standard UniCode numeral system tag for localization
+   * Specifies the Unicode numeral system used by the component for localization.
+   *
+   * @mdn [numberingSystem](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/numberingSystem)
    */
   numberingSystem?: string;
   /**
@@ -62,55 +74,87 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
    * @internal
    */
   localeFormat: boolean;
-  /** input max */
+  /**
+   * Specifies the maximum value for type "number".
+   *
+   * @mdn [max](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max)
+   */
   max?: number;
   /** watcher to update number-to-string for max */
   maxWatcher(): void;
-  /** input min */
+  /**
+   * Specifies the minimum value for type "number".
+   *
+   * @mdn [min](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min)
+   */
   min?: number;
   /** watcher to update number-to-string for min */
   minWatcher(): void;
   /**
-   * Maximum length of text input.
+   * Specifies the maximum length of text for the component's value.
    *
    * @deprecated use maxLength instead
    */
   maxlength?: number;
-  /** Maximum length of the input value */
+  /**
+   * Specifies the maximum length of text for the component's value.
+   *
+   * @mdn [maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength)
+   */
   maxLength?: number;
-  /** Minimum length of the text input */
+  /**
+   * Specifies the minimum length of text for the component's value.
+   *
+   * @mdn [minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength)
+   */
   minLength?: number;
-  /** The name of the input */
+  /**
+   * Specifies the name of the component.
+   *
+   * @mdn [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)
+   */
   name: string;
-  /** specify the placement of the number buttons */
+  /** Specifies the placement of the buttons for type "number". */
   numberButtonType?: InputPlacement;
-  /** explicitly whitelist placeholder attribute */
+  /**
+   * Specifies placeholder text for the component.
+   *
+   * @mdn [placeholder](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder)
+   */
   placeholder: string;
-  /** optionally add prefix  */
+  /** Adds text to the start of the component. */
   prefixText?: string;
-  /** 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)
+   */
   readOnly: boolean;
-  /** is the input required */
+  /** When true, the component must have a value in order for the form to submit. */
   required: boolean;
-  /** specify the scale of the input, defaults to m */
+  /** Specifies the size of the component. */
   scale: Scale;
-  /** specify the status of the input field, determines message and icons */
+  /** Specifies the status of the input field, which determines message and icons. */
   status: Status;
-  /** input step */
+  /**
+   * Specifies the granularity that the component's value must adhere to.
+   *
+   * @mdn [step](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/step)
+   */
   step?: number | "any";
-  /** optionally add suffix  */
+  /** Adds text to the end of the component.  */
   suffixText?: string;
   /**
    * @internal
    */
   editingEnabled: boolean;
   /**
-   * 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".
    */
   type: "color" | "date" | "datetime-local" | "email" | "file" | "image" | "month" | "number" | "password" | "search" | "tel" | "text" | "textarea" | "time" | "url" | "week";
-  /** input value */
+  /** The component's value. */
   value: string;
   valueWatcher(newValue: string, previousValue: string): void;
   updateRequestedIcon(): void;
@@ -151,15 +195,17 @@ export declare class Input implements LabelableComponent, FormComponent, Interac
    */
   calciteInternalInputBlur: EventEmitter;
   /**
-   * This event fires each time a new value is typed.
+   * Fires each time a new value is typed.
    */
   calciteInputInput: EventEmitter;
   /**
-   * This event fires each time a new value is typed and committed.
+   * Fires each time a new value is typed and committed.
    */
   calciteInputChange: EventEmitter<void>;
   /** Sets focus on the component. */
   setFocus(): Promise<void>;
+  /** Selects all text of the component's `value`. */
+  selectText(): Promise<void>;
   keyDownHandler: (event: KeyboardEvent) => void;
   onLabelClick(): void;
   incrementOrDecrementNumberValue(direction: NumberNudgeDirection, inputMax: number | null, inputMin: number | null, nativeEvent: KeyboardEvent | MouseEvent): void;

package/dist/types/components.d.ts

@@ -771,6 +771,10 @@ export namespace Components {
           * @default "Value"
          */
         "intlValue": string;
+        /**
+          * standard UniCode numeral system tag for localization
+         */
+        "numberingSystem"?: string;
         /**
           * The scale of the color picker.
          */
@@ -805,6 +809,10 @@ export namespace Components {
           * @default "No color"
          */
         "intlNoColor": string;
+        /**
+          * standard UniCode numeral system tag for localization
+         */
+        "numberingSystem"?: string;
         /**
           * The component's scale.
          */
@@ -1476,36 +1484,39 @@ export namespace Components {
     }
     interface CalciteInput {
         /**
-          * specify the alignment of the value of the input
+          * Specifies the text alignment of the component's value.
          */
         "alignment": Position;
         /**
-          * 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)
          */
         "autofocus": boolean;
         /**
-          * 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.
          */
         "clearable": boolean;
         /**
-          * 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)
          */
         "disabled": boolean;
         "editingEnabled": boolean;
         /**
-          * for number values, displays the locale's group separator
+          * When true, number values are displayed with the locale's group separator.
          */
         "groupSeparator": boolean;
         /**
-          * 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)
          */
         "hidden": boolean;
         /**
-          * when used as a boolean set to true, show a default recommended icon for certain input types (tel, password, email, date, time, search). You can also pass a calcite-ui-icon name to this prop to display a requested icon for any input type
+          * When true, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon.
          */
         "icon": string | boolean;
         /**
-          * flip the icon in rtl
+          * When true, the icon is flipped in RTL.
          */
         "iconFlipRtl": boolean;
         /**
@@ -1513,20 +1524,20 @@ export namespace Components {
          */
         "intlClear"?: string;
         /**
-          * string to override English loading text
+          * Accessible name that will appear while loading.
           * @default "Loading"
          */
         "intlLoading"?: string;
         /**
-          * Applies to the aria-label attribute on the button or hyperlink
+          * Accessible name for the component's button or hyperlink.
          */
         "label"?: string;
         /**
-          * specify if the input is in loading state
+          * When true, the component is in the loading state and `calcite-progress` is displayed.
          */
         "loading": boolean;
         /**
-          * BCP 47 language tag for desired language and country format
+          * Specifies the BCP 47 language tag for the desired language and country format.
          */
         "locale": string;
         /**
@@ -1534,76 +1545,89 @@ export namespace Components {
          */
         "localeFormat": boolean;
         /**
-          * input max
+          * Specifies the maximum value for type "number".
+          * @mdn [max](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max)
          */
         "max"?: number;
         /**
-          * Maximum length of the input value
+          * Specifies the maximum length of text for the component's value.
+          * @mdn [maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength)
          */
         "maxLength"?: number;
         /**
-          * Maximum length of text input.
+          * Specifies the maximum length of text for the component's value.
           * @deprecated use maxLength instead
          */
         "maxlength"?: number;
         /**
-          * input min
+          * Specifies the minimum value for type "number".
+          * @mdn [min](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min)
          */
         "min"?: number;
         /**
-          * Minimum length of the text input
+          * Specifies the minimum length of text for the component's value.
+          * @mdn [minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength)
          */
         "minLength"?: number;
         /**
-          * The name of the input
+          * Specifies the name of the component.
+          * @mdn [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)
          */
         "name": string;
         /**
-          * specify the placement of the number buttons
+          * Specifies the placement of the buttons for type "number".
          */
         "numberButtonType"?: InputPlacement;
         /**
-          * standard UniCode numeral system tag for localization
+          * Specifies the Unicode numeral system used by the component for localization.
+          * @mdn [numberingSystem](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/numberingSystem)
          */
         "numberingSystem"?: string;
         /**
-          * explicitly whitelist placeholder attribute
+          * Specifies placeholder text for the component.
+          * @mdn [placeholder](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder)
          */
         "placeholder": string;
         /**
-          * optionally add prefix
+          * Adds text to the start of the component.
          */
         "prefixText"?: string;
         /**
-          * 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)
          */
         "readOnly": boolean;
         /**
-          * is the input required
+          * When true, the component must have a value in order for the form to submit.
          */
         "required": boolean;
         /**
-          * specify the scale of the input, defaults to m
+          * Specifies the size of the component.
          */
         "scale": Scale;
+        /**
+          * Selects all text of the component's `value`.
+         */
+        "selectText": () => Promise<void>;
         /**
           * Sets focus on the component.
          */
         "setFocus": () => Promise<void>;
         /**
-          * specify the status of the input field, determines message and icons
+          * Specifies the status of the input field, which determines message and icons.
          */
         "status": Status;
         /**
-          * input step
+          * Specifies the granularity that the component's value must adhere to.
+          * @mdn [step](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/step)
          */
         "step"?: number | "any";
         /**
-          * optionally add suffix
+          * Adds text to the end of the component.
          */
         "suffixText"?: string;
         /**
-          * specify the input type  Note that the following types add type-specific icons by default: `date`, `email`, `password`, `search`, `tel`, `time`
+          * Specifies the component type.  Note that the following types add type-specific icons by default: "date", "email", "password", "search", "tel", "time".
          */
         "type": | "color"
     | "date"
@@ -1622,7 +1646,7 @@ export namespace Components {
     | "url"
     | "week";
         /**
-          * input value
+          * The component's value.
          */
         "value": string;
     }
@@ -5232,6 +5256,10 @@ declare namespace LocalJSX {
           * @default "Value"
          */
         "intlValue"?: string;
+        /**
+          * standard UniCode numeral system tag for localization
+         */
+        "numberingSystem"?: string;
         /**
           * Fires when the color value has changed.
          */
@@ -5270,6 +5298,10 @@ declare namespace LocalJSX {
           * @default "No color"
          */
         "intlNoColor"?: string;
+        /**
+          * standard UniCode numeral system tag for localization
+         */
+        "numberingSystem"?: string;
         /**
           * Emitted when the hex value changes.
          */
@@ -5971,35 +6003,38 @@ declare namespace LocalJSX {
     }
     interface CalciteInput {
         /**
-          * specify the alignment of the value of the input
+          * Specifies the text alignment of the component's value.
          */
         "alignment"?: Position;
         /**
-          * 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)
          */
         "autofocus"?: boolean;
         /**
-          * 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.
          */
         "clearable"?: boolean;
         /**
-          * 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)
          */
         "disabled"?: boolean;
         /**
-          * for number values, displays the locale's group separator
+          * When true, number values are displayed with the locale's group separator.
          */
         "groupSeparator"?: boolean;
         /**
-          * 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)
          */
         "hidden"?: boolean;
         /**
-          * when used as a boolean set to true, show a default recommended icon for certain input types (tel, password, email, date, time, search). You can also pass a calcite-ui-icon name to this prop to display a requested icon for any input type
+          * When true, shows a default recommended icon. Alternatively, pass a Calcite UI Icon name to display a specific icon.
          */
         "icon"?: string | boolean;
         /**
-          * flip the icon in rtl
+          * When true, the icon is flipped in RTL.
          */
         "iconFlipRtl"?: boolean;
         /**
@@ -6007,97 +6042,106 @@ declare namespace LocalJSX {
          */
         "intlClear"?: string;
         /**
-          * string to override English loading text
+          * Accessible name that will appear while loading.
           * @default "Loading"
          */
         "intlLoading"?: string;
         /**
-          * Applies to the aria-label attribute on the button or hyperlink
+          * Accessible name for the component's button or hyperlink.
          */
         "label"?: string;
         /**
-          * specify if the input is in loading state
+          * When true, the component is in the loading state and `calcite-progress` is displayed.
          */
         "loading"?: boolean;
         /**
-          * BCP 47 language tag for desired language and country format
+          * Specifies the BCP 47 language tag for the desired language and country format.
          */
         "locale"?: string;
         /**
-          * input max
+          * Specifies the maximum value for type "number".
+          * @mdn [max](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max)
          */
         "max"?: number;
         /**
-          * Maximum length of the input value
+          * Specifies the maximum length of text for the component's value.
+          * @mdn [maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength)
          */
         "maxLength"?: number;
         /**
-          * Maximum length of text input.
+          * Specifies the maximum length of text for the component's value.
           * @deprecated use maxLength instead
          */
         "maxlength"?: number;
         /**
-          * input min
+          * Specifies the minimum value for type "number".
+          * @mdn [min](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min)
          */
         "min"?: number;
         /**
-          * Minimum length of the text input
+          * Specifies the minimum length of text for the component's value.
+          * @mdn [minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength)
          */
         "minLength"?: number;
         /**
-          * The name of the input
+          * Specifies the name of the component.
+          * @mdn [name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)
          */
         "name"?: string;
         /**
-          * specify the placement of the number buttons
+          * Specifies the placement of the buttons for type "number".
          */
         "numberButtonType"?: InputPlacement;
         /**
-          * standard UniCode numeral system tag for localization
+          * Specifies the Unicode numeral system used by the component for localization.
+          * @mdn [numberingSystem](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/numberingSystem)
          */
         "numberingSystem"?: string;
         /**
-          * This event fires each time a new value is typed and committed.
+          * Fires each time a new value is typed and committed.
          */
         "onCalciteInputChange"?: (event: CalciteInputCustomEvent<void>) => void;
         /**
-          * This event fires each time a new value is typed.
+          * Fires each time a new value is typed.
          */
         "onCalciteInputInput"?: (event: CalciteInputCustomEvent<any>) => void;
         /**
-          * explicitly whitelist placeholder attribute
+          * Specifies placeholder text for the component.
+          * @mdn [placeholder](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder)
          */
         "placeholder"?: string;
         /**
-          * optionally add prefix
+          * Adds text to the start of the component.
          */
         "prefixText"?: string;
         /**
-          * 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)
          */
         "readOnly"?: boolean;
         /**
-          * is the input required
+          * When true, the component must have a value in order for the form to submit.
          */
         "required"?: boolean;
         /**
-          * specify the scale of the input, defaults to m
+          * Specifies the size of the component.
          */
         "scale"?: Scale;
         /**
-          * specify the status of the input field, determines message and icons
+          * Specifies the status of the input field, which determines message and icons.
          */
         "status"?: Status;
         /**
-          * input step
+          * Specifies the granularity that the component's value must adhere to.
+          * @mdn [step](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/step)
          */
         "step"?: number | "any";
         /**
-          * optionally add suffix
+          * Adds text to the end of the component.
          */
         "suffixText"?: string;
         /**
-          * specify the input type  Note that the following types add type-specific icons by default: `date`, `email`, `password`, `search`, `tel`, `time`
+          * Specifies the component type.  Note that the following types add type-specific icons by default: "date", "email", "password", "search", "tel", "time".
          */
         "type"?: | "color"
     | "date"
@@ -6116,7 +6160,7 @@ declare namespace LocalJSX {
     | "url"
     | "week";
         /**
-          * input value
+          * The component's value.
          */
         "value"?: string;
     }