@esri/calcite-components 5.2.0-next.1 → 5.2.0-next.100

package/dist/components/calcite-input-number/customElement.d.ts

@@ -1,31 +1,72 @@
 /// <reference path="../../index.d.ts" />
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { Alignment, Scale, Status } from "../interfaces.js";
+import type { Alignment, Scale, Status } from "../types.js";
 import type { NumberingSystem } from "../../utils/locale.js";
-import type { InputPlacement } from "../calcite-input/interfaces.js";
-import type { IconName } from "../calcite-icon/interfaces.js";
+import type { InputPlacement } from "../calcite-input/types.js";
+import type { IconName } from "../calcite-icon/types.js";
+
+declare module "@arcgis/lumina" {
+export interface DeclareCssProperties {
+  /** Specifies the background color of the component's `clearable` and `number-button-type` elements. */
+  "--calcite-input-actions-background-color": "*";
+  /** Specifies the background color of the component's `clearable` and `number-button-type` elements when hovered. */
+  "--calcite-input-actions-background-color-hover": "*";
+  /** Specifies the background color of the component's `clearable` and `number-button-type` elements when pressed. */
+  "--calcite-input-actions-background-color-press": "*";
+  /** Specifies the icon color of the component's `clearable` and `number-button-type` elements. */
+  "--calcite-input-actions-icon-color": "*";
+  /** Specifies the icon color of the component's `clearable` and `number-button-type` elements when hovered. */
+  "--calcite-input-actions-icon-color-hover": "*";
+  /** Specifies the icon color of the component's `clearable` and `number-button-type` elements when pressed. */
+  "--calcite-input-actions-icon-color-press": "*";
+  /** When `loading`, specifies the background color of the component's `loading` element. */
+  "--calcite-input-loading-background-color": "*";
+  /** When `loading`, specifies the fill color of the component's `loading` element. */
+  "--calcite-input-loading-fill-color": "*";
+  /** Specifies the component's background color. */
+  "--calcite-input-number-background-color": "*";
+  /** Specifies the component's border color. */
+  "--calcite-input-number-border-color": "*";
+  /** Specifies the component's border radius. */
+  "--calcite-input-number-corner-radius": "*";
+  /** Specifies the component's icon color. */
+  "--calcite-input-number-icon-color": "*";
+  /** Specifies the component's height. */
+  "--calcite-input-number-height": "*";
+  /** Specifies the text color of the component's placeholder. */
+  "--calcite-input-number-placeholder-text-color": "*";
+  /** Specifies the component's text color. */
+  "--calcite-input-number-text-color": "*";
+  /** Specifies the component's text color when focused. */
+  "--calcite-input-number-text-color-focus": "*";
+  /** When `prefixText` is provided, specifies the width of the component's prefix element. */
+  "--calcite-input-prefix-size": "*";
+  /** When `prefixText` is provided, specifies the text color of the component's prefix element. */
+  "--calcite-input-prefix-text-color": "*";
+  /** When `suffixText` is provided, specifies the width of the component's suffix element. */
+  "--calcite-input-suffix-size": "*";
+  /** When `suffixText` is provided, specifies the text color of the component's suffix element. */
+  "--calcite-input-suffix-text-color": "*";
+  /** When `inlineEdit` is defined and `inlineEditing` is not set, specifies the component's background color when hovered. */
+  "--calcite-input-number-inline-edit-background-color-hover": "*";
+  /** When `inlineEdit` is defined, specifies the background color of the component's editing controls. */
+  "--calcite-input-number-inline-edit-control-background-color": "*";
+  /** When `inlineEdit` is defined, specifies the background color of the component's editing controls when hovered. */
+  "--calcite-input-number-inline-edit-control-background-color-hover": "*";
+  /** When `inlineEdit` is defined, specifies the background color of the component's editing controls when pressed. */
+  "--calcite-input-number-inline-edit-control-background-color-press": "*";
+  /** When `inlineEdit` is defined, specifies the corner radius of the component's editing controls. */
+  "--calcite-input-number-inline-edit-control-corner-radius": "*";
+  /** When `inlineEdit` is `true`, specifies the loader color of the component's confirm control. */
+  "--calcite-input-number-inline-edit-control-loader-color": "*";
+  /** When `inlineEdit` is defined, specifies the text color of the component's editing controls. */
+  "--calcite-input-number-inline-edit-control-text-color": "*";
+  /** When `inlineEdit` is defined, specifies the text color of the component's editing controls when pressed or hovered. */
+  "--calcite-input-number-inline-edit-control-text-color-press": "*";
+}
+}
 
 /**
- * @cssproperty [--calcite-input-actions-background-color] - Specifies the background color of the component's `clearable` and `number-button-type` elements.
- * @cssproperty [--calcite-input-actions-background-color-hover] - Specifies the background color of the component's `clearable` and `number-button-type` elements when hovered.
- * @cssproperty [--calcite-input-actions-background-color-press] - Specifies the background color of the component's `clearable` and `number-button-type` elements when pressed.
- * @cssproperty [--calcite-input-actions-icon-color] - Specifies the icon color of the component's `clearable` and `number-button-type` elements.
- * @cssproperty [--calcite-input-actions-icon-color-hover] - Specifies the icon color of the component's `clearable` and `number-button-type` elements when hovered.
- * @cssproperty [--calcite-input-actions-icon-color-press] - Specifies the icon color of the component's `clearable` and `number-button-type` elements when pressed.
- * @cssproperty [--calcite-input-loading-background-color] - When `loading`, specifies the background color of the component's `loading` element.
- * @cssproperty [--calcite-input-loading-fill-color] - When `loading`, specifies the fill color of the component's `loading` element.
- * @cssproperty [--calcite-input-number-background-color] - Specifies the component's background color.
- * @cssproperty [--calcite-input-number-border-color] - Specifies the component's border color.
- * @cssproperty [--calcite-input-number-corner-radius] - Specifies the component's border radius.
- * @cssproperty [--calcite-input-number-icon-color] - Specifies the component's icon color.
- * @cssproperty [--calcite-input-number-height] - Specifies the component's height.
- * @cssproperty [--calcite-input-number-placeholder-text-color] - Specifies the text color of the component's placeholder.
- * @cssproperty [--calcite-input-number-text-color] - Specifies the component's text color.
- * @cssproperty [--calcite-input-number-text-color-focus] - Specifies the component's text color when focused.
- * @cssproperty [--calcite-input-prefix-size] - When `prefixText` is provided, specifies the width of the component's prefix element.
- * @cssproperty [--calcite-input-prefix-text-color] - When `prefixText` is provided, specifies the text color of the component's prefix element.
- * @cssproperty [--calcite-input-suffix-size] - When `suffixText` is provided, specifies the width of the component's suffix element.
- * @cssproperty [--calcite-input-suffix-text-color] - When `suffixText` is provided, specifies the text color of the component's suffix element.
  * @slot [action] - A slot for positioning a `calcite-action` or other interactive content adjacent to the component.
  * @slot [label-content] - A slot for rendering content next to the component's `labelText`.
  */
@@ -42,7 +83,7 @@ export abstract class InputNumber extends LitElement {
    *
    * @see [MDN - autocomplete](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete)
    */
-  accessor autocomplete: AutoFill;
+  accessor autocomplete: AutoFill | undefined;
   /**
    * When `true` and the component has a `value`, a clear button is displayed.
    *
@@ -56,12 +97,8 @@ export abstract class InputNumber extends LitElement {
    * @see [MDN - disabled](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/disabled)
    */
   accessor disabled: boolean;
-  /**
-   * Specifies the `id` of the component's associated form.
-   *
-   * When not set, the component is associated with its ancestor form element, if one exists.
-   */
-  accessor form: string;
+  /** Specifies the `id` of the component's associated form. When not set, the component is associated with its ancestor form element, if one exists. */
+  accessor form: string | undefined;
   /**
    * When `true`, number values are displayed with a group separator corresponding to the language and country format.
    *
@@ -73,23 +110,39 @@ export abstract class InputNumber extends LitElement {
    *
    * @futureBreaking Remove boolean type as it is not supported.
    */
-  accessor icon: IconName | boolean;
+  accessor icon: IconName | boolean | undefined;
   /**
    * When `true` and the element direction is right-to-left (`"rtl"`), flips the component`s `icon`.
    *
    * @default false
    */
   accessor iconFlipRtl: boolean;
+  /**
+   * Enables inline editing. When not editing, the component displays without a border.
+   * When `true`, edits must be saved or cancelled via controls.
+   * When `"controls-disabled"` is specified, edits are saved on blur.
+   *
+   * @default false
+   */
+  accessor inlineEdit: boolean | "controls-disabled";
+  /**
+   * When `true` and `inlineEdit` is defined, the component is editable.
+   *
+   * @default false
+   */
+  accessor inlineEditing: boolean;
+  /** When `inlineEdit` is `true`, specifies a callback to be run when changes are saved. */
+  accessor inlineEditingBeforeConfirm: (() => Promise<void>) | undefined;
   /**
    * When `true`, restricts the component to integer numbers only and disables exponential notation.
    *
    * @default false
    */
   accessor integer: boolean;
-  /** Specifies an accessible label for the component's button or hyperlink. */
-  accessor label: string;
+  /** Specifies an accessible label for the component. */
+  accessor label: string | undefined;
   /** Specifies the component's label text. */
-  accessor labelText: string;
+  accessor labelText: string | undefined;
   /**
    * When `true`, displays a busy indicator.
    *
@@ -102,7 +155,7 @@ export abstract class InputNumber extends LitElement {
    *
    * @see [MDN - max](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#max)
    */
-  accessor max: number;
+  accessor max: number | undefined;
   /**
    * When the component resides in a form,
    * specifies the maximum length of text for the component's `value`.
@@ -110,12 +163,19 @@ export abstract class InputNumber extends LitElement {
    * @deprecated in v3.0.0, removal target v6.0.0 - This property has no effect on the component.
    * @see [MDN - maxlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#maxlength)
    */
-  accessor maxLength: number;
-  /** Overrides individual strings used by the component. */
+  accessor maxLength: number | undefined;
+  /**
+   * Replace localized message strings with your own strings.
+   *
+   * _**Note**: Individual message keys may change between releases._
+   */
   accessor messageOverrides: {
-      clear?: string;
-      loading?: string;
-      required?: string;
+      cancelInlineEditing?: string | undefined;
+      clear?: string | undefined;
+      confirmInlineEditingChanges?: string | undefined;
+      enableInlineEditing?: string | undefined;
+      loading?: string | undefined;
+      required?: string | undefined;
   };
   /**
    * When the component resides in a form,
@@ -123,7 +183,7 @@ export abstract class InputNumber extends LitElement {
    *
    * @see [MDN - min](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#min)
    */
-  accessor min: number;
+  accessor min: number | undefined;
   /**
    * When the component resides in a form,
    * specifies the minimum length of text for the component's `value`.
@@ -131,7 +191,7 @@ export abstract class InputNumber extends LitElement {
    * @deprecated in v3.0.0, removal target v6.0.0 - This property has no effect on the component.
    * @see [MDN - minlength](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#minlength)
    */
-  accessor minLength: number;
+  accessor minLength: number | undefined;
   /**
    * Specifies the name of the component.
    *
@@ -139,7 +199,7 @@ export abstract class InputNumber extends LitElement {
    *
    * @see [MDN - name](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#name)
    */
-  accessor name: string;
+  accessor name: string | undefined;
   /**
    * Specifies the placement of the buttons.
    *
@@ -147,15 +207,15 @@ export abstract class InputNumber extends LitElement {
    */
   accessor numberButtonType: InputPlacement;
   /** Specifies the Unicode numeral system used by the component for localization. */
-  accessor numberingSystem: NumberingSystem;
+  accessor numberingSystem: NumberingSystem | undefined;
   /**
    * Specifies the component's placeholder text.
    *
    * @see [MDN - placeholder](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#placeholder)
    */
-  accessor placeholder: string;
+  accessor placeholder: string | undefined;
   /** Specifies text to display at the start of the component. */
-  accessor prefixText: string;
+  accessor prefixText: string | undefined;
   /**
    * When `true`, the component's `value` can be read, but cannot be modified.
    *
@@ -187,13 +247,13 @@ export abstract class InputNumber extends LitElement {
    *
    * @see [MDN - step](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/step)
    */
-  accessor step: number | "any";
+  accessor step: number | "any" | undefined;
   /** Specifies text to display at the end of the component. */
-  accessor suffixText: string;
+  accessor suffixText: string | undefined;
   /** Specifies the validation icon to display under the component. */
-  accessor validationIcon: IconName | boolean;
+  accessor validationIcon: IconName | boolean | undefined;
   /** Specifies the validation message to display under the component. */
-  accessor validationMessage: string;
+  accessor validationMessage: string | undefined;
   /**
    * The component's current validation state.
    *
@@ -211,12 +271,21 @@ export abstract class InputNumber extends LitElement {
    * @see [MDN - focus(options)](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/focus#options)
    */
   setFocus(options?: FocusOptions): Promise<void>;
-  /** Fires each time a new `value` is typed and committed. */
+  /** Fires each time a new `value` is committed. */
   readonly calciteInputNumberChange: import("@arcgis/lumina").TargetedEvent<this, void>;
-  /** Fires each time a new `value` is typed. */
+  /** When `inlineEdit` is defined, fires when editing is cancelled. */
+  readonly calciteInputNumberInlineEditingCancel: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /** When `inlineEdit` is defined, fires when `inlineEditing` is enabled or disabled. */
+  readonly calciteInputNumberInlineEditingChange: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /** When `inlineEdit` is `true`, fires after editing is confirmed. */
+  readonly calciteInputNumberInlineEditingConfirm: import("@arcgis/lumina").TargetedEvent<this, void>;
+  /** When `inlineEdit` is `false`, fires each time a new `value` is typed. */
   readonly calciteInputNumberInput: import("@arcgis/lumina").TargetedEvent<this, void>;
   readonly "@eventTypes": {
     calciteInputNumberChange: InputNumber["calciteInputNumberChange"]["detail"];
+    calciteInputNumberInlineEditingCancel: InputNumber["calciteInputNumberInlineEditingCancel"]["detail"];
+    calciteInputNumberInlineEditingChange: InputNumber["calciteInputNumberInlineEditingChange"]["detail"];
+    calciteInputNumberInlineEditingConfirm: InputNumber["calciteInputNumberInlineEditingConfirm"]["detail"];
     calciteInputNumberInput: InputNumber["calciteInputNumberInput"]["detail"];
   };
 }