@heartlandone/vega 2.77.1 → 2.79.0

package/dist/collection/components/vega-input-credit-card/vega-input-credit-card.js

@@ -150,7 +150,7 @@ export class VegaInputCreditCard {
           DomNodeSubjectObserverFactory.addUniqueObserverToNode(ref, VegaFocus, () => {
             this.handleVegaFocus();
           });
-        } }));
+        }, "data-aria-label": this.label || 'Input credit card' }));
     };
     this.handleVegaChange = (e) => {
       this.value = e.detail;

package/dist/collection/components/vega-input-numeric/vega-input-numeric.js

@@ -57,106 +57,166 @@ export class VegaInputNumeric {
     this.vegaComponentUsageRuntimeMetricsSlimmer = new VegaComponentUsageRuntimeMetricsSlimmer();
     this.isCompactInputWidth = true;
     /**
-     * Defines the prefix for the input numeric field.
-     * It provides additional context or information displayed
-     *    before the numeric value, helping to
-     *    clarify its purpose or usage.
+     * Text displayed before (to the left of) the numeric value inside the input
+     * field. Use this to provide contextual information such as a currency
+     * symbol (e.g., `'$'`) or unit prefix.
      *
+     * @default ''
      * @vegaVersion 2.29.0
      */
     this.prefixText = '';
     /**
-     * Represents a pre-set or default value for the input numeric field.
+     * The current value of the numeric input field, represented as a string.
      *
+     * This property is mutable and will be updated when the user types or uses
+     * keyboard increment/decrement actions. It can also be set externally to
+     * pre-populate or reset the field. When `thousandComma` is enabled, the
+     * display is formatted with separators but the underlying value remains
+     * unformatted. Changes to this property trigger the `vegaChange` event.
+     *
+     * @default ''
      * @vegaVersion 2.29.0
      */
     /* eslint-disable-next-line @stencil/strict-mutable */
     this.value = '';
     /**
-     * Defines the size of the input numeric field.
+     * Controls the visual size of the numeric input field.
+     *
+     * - `'medium'` — Standard height, suitable for most form layouts.
+     * - `'small'` — Compact height, useful for dense UIs or inline editing.
      *
+     * @default 'medium'
      * @vegaVersion 2.29.0
      */
     this.size = 'medium';
     /**
-     * Determines whether the numeric input field should format numbers
-     *    with thousand separators (commas) during user input.
+     * When `true`, the numeric input automatically formats the displayed value
+     * with thousand separators (commas) as the user types (e.g., `1,000,000`).
+     * The underlying `value` property remains an unformatted numeric string.
      *
+     * @default false
      * @vegaVersion 2.29.0
      */
     this.thousandComma = false;
     /**
-     * Determines whether the numeric input field should restrict
-     *    input to integers only.
+     * When `true`, restricts user input to whole numbers only — decimal points
+     * and fractional digits are rejected. Useful for fields like quantity,
+     * count, or age.
      *
+     * @default false
      * @vegaVersion 2.29.0
      */
     this.integerOnly = false;
     /**
-     * Determines whether the input numeric field is disabled.
+     * Specifies whether the numeric input field is disabled. When `true`, the
+     * field is non-interactive — the user cannot type, focus, or use keyboard
+     * controls to change the value.
      *
+     * @default false
      * @vegaVersion 2.29.0
      */
     this.disabled = false;
     /**
-     * Specifies the step value for increasing or decreasing the input
-     *    when pressing the ArrowUp or ArrowDown key.
-     *    It controls the finer adjustments in the numeric input.
+     * The step value used when the user presses the `ArrowUp` or `ArrowDown`
+     * key to increment or decrement the value. This controls fine-grained
+     * adjustments to the numeric input.
      *
+     * For larger jumps, see `majorIncrement` (activated with `Shift` + arrow
+     * keys).
+     *
+     * @default 1
      * @vegaVersion 2.29.0
      */
     this.minorIncrement = 1;
     /**
-     * Specifies the step value for increasing or decreasing the input
-     *    when pressing the ArrowUp or ArrowDown key
-     *    while holding the Shift key.
-     *    It controls larger adjustments in the numeric input.
+     * The step value used when the user presses `Shift` + `ArrowUp` or
+     * `Shift` + `ArrowDown` to increment or decrement the value by a larger
+     * amount. This enables quick coarse-grained adjustments.
+     *
+     * For smaller steps, see `minorIncrement`.
      *
+     * @default 10
      * @vegaVersion 2.29.0
      */
     this.majorIncrement = 10;
     /**
-     * Provides a descriptive text or string that serves
-     *    as the label or title for the input numeric.
+     * Specifies the visible label text rendered above the numeric input.
+     * The label identifies the purpose of the field and serves as the
+     * accessible name for screen readers.
      *
+     * @default ''
      * @vegaVersion 2.29.0
      */
     this.label = '';
     /**
-     * Defines custom validation rules for the input numeric field.
+     * An array of custom validation rules applied to the numeric input in
+     * addition to the built-in rules (`RequiredFieldRule`, `MinNumberRule`,
+     * `MaxNumberRule`). Each rule must implement the `FormFieldValidationRule`
+     * interface.
      *
+     * Rules are evaluated in order when `autoValidation` is enabled or when
+     * validation is triggered programmatically.
+     *
+     * @default []
      * @vegaVersion 2.29.0
      */
     this.validationRules = [];
     /**
-     * Specifies the validation status of the input numeric field.
+     * Reflects the current validation status of the numeric input.
+     *
+     * - `true` — the field value passes all validation rules.
+     * - `false` — one or more validation rules have failed.
+     * - `null` — the field has not been validated yet (initial state).
      *
+     * This property is mutable: it is updated automatically when
+     * `autoValidation` is enabled, but can also be set manually to override
+     * the validation state.
+     *
+     * @default null
      * @vegaVersion 2.29.0
      */
     /* eslint-disable-next-line @stencil/strict-mutable */
     this.isValid = null;
     /**
-     * Determines whether the input field should undergo automatic validation
-     *    during the user's input.
+     * Determines whether the numeric input should be validated automatically as
+     * the user interacts with it. When `true`, validation rules (including
+     * `required`, `min`, `max`, and custom `validationRules`) are evaluated
+     * and the `isValid` property is updated accordingly.
+     *
+     * Set to `false` to handle validation manually.
      *
+     * @default true
      * @vegaVersion 2.29.0
      */
     this.autoValidation = true;
     /**
-     * Determines whether the clear icon should be displayed or hidden.
+     * Controls whether a clear (×) icon button is shown inside the input field
+     * when a value is present. Clicking the button resets the value to an empty
+     * string and triggers the `vegaChange` event.
      *
+     * @default true
      * @vegaVersion 2.53.0
      */
     this.showClearIcon = true;
     /**
-     * Sets the minimum allowable value for the numeric input.
+     * Sets the minimum allowable value for the numeric input. When set, the
+     * built-in `MinNumberRule` is applied during validation. Values below this
+     * threshold will cause validation to fail.
      *
+     * Set to `null` to remove the lower bound.
+     *
+     * @default null
      * @vegaVersion 2.63.0
      */
     this.min = null;
     /**
-     * Sets the maximum allowable value for the numeric input.
+     * Sets the maximum allowable value for the numeric input. When set, the
+     * built-in `MaxNumberRule` is applied during validation. Values above this
+     * threshold will cause validation to fail.
+     *
+     * Set to `null` to remove the upper bound.
      *
+     * @default null
      * @vegaVersion 2.63.0
      */
     this.max = null;
@@ -197,10 +257,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "''"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Defines the prefix for the input numeric field.\nIt provides additional context or information displayed\n   before the numeric value, helping to\n   clarify its purpose or usage."
+        "text": "Text displayed before (to the left of) the numeric value inside the input\nfield. Use this to provide contextual information such as a currency\nsymbol (e.g., `'$'`) or unit prefix."
       },
       "attribute": "prefix-text",
       "reflect": false,
@@ -218,10 +281,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "undefined"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Defines the suffix for the input numeric field.\nIt provides additional context or information displayed\n   after the numeric value, helping to\n   clarify its purpose or usage."
+        "text": "Text displayed after (to the right of) the numeric value inside the input\nfield. Use this to provide contextual information such as a unit suffix\n(e.g., `'%'`, `'kg'`, `'USD'`)."
       },
       "attribute": "suffix-text",
       "reflect": false
@@ -238,10 +304,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "undefined"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Specifies an icon or symbol that appears before the input field,\n   providing visual context or enhancing the aesthetic appearance\n   of the input numeric."
+        "text": "Name of a Vega icon rendered before (to the left of) the input field,\nproviding additional visual context. The icon is purely decorative and\ndoes not affect the input value."
       },
       "attribute": "prefix-icon",
       "reflect": false
@@ -258,10 +327,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "''"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Represents a pre-set or default value for the input numeric field."
+        "text": "The current value of the numeric input field, represented as a string.\n\nThis property is mutable and will be updated when the user types or uses\nkeyboard increment/decrement actions. It can also be set externally to\npre-populate or reset the field. When `thousandComma` is enabled, the\ndisplay is formatted with separators but the underlying value remains\nunformatted. Changes to this property trigger the `vegaChange` event."
       },
       "attribute": "value",
       "reflect": false,
@@ -279,10 +351,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "'medium'"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Defines the size of the input numeric field."
+        "text": "Controls the visual size of the numeric input field.\n\n- `'medium'` \u2014 Standard height, suitable for most form layouts.\n- `'small'` \u2014 Compact height, useful for dense UIs or inline editing."
       },
       "attribute": "size",
       "reflect": false,
@@ -300,10 +375,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "undefined"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Specifies a placeholder string that displays as a temporary hint\n   or example inside the input numeric field."
+        "text": "Specifies placeholder text displayed inside the input field when it is\nempty. The placeholder disappears once the user begins typing and is\ntypically used to indicate the expected format (e.g., `'0.00'`)."
       },
       "attribute": "placeholder",
       "reflect": false
@@ -320,10 +398,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "false"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Determines whether the numeric input field should format numbers\n   with thousand separators (commas) during user input."
+        "text": "When `true`, the numeric input automatically formats the displayed value\nwith thousand separators (commas) as the user types (e.g., `1,000,000`).\nThe underlying `value` property remains an unformatted numeric string."
       },
       "attribute": "thousand-comma",
       "reflect": false,
@@ -341,10 +422,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "false"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Determines whether the numeric input field should restrict\n   input to integers only."
+        "text": "When `true`, restricts user input to whole numbers only \u2014 decimal points\nand fractional digits are rejected. Useful for fields like quantity,\ncount, or age."
       },
       "attribute": "integer-only",
       "reflect": false,
@@ -362,10 +446,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "false"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Determines whether the input numeric field is disabled."
+        "text": "Specifies whether the numeric input field is disabled. When `true`, the\nfield is non-interactive \u2014 the user cannot type, focus, or use keyboard\ncontrols to change the value."
       },
       "attribute": "disabled",
       "reflect": false,
@@ -383,10 +470,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "1"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Specifies the step value for increasing or decreasing the input\n   when pressing the ArrowUp or ArrowDown key.\n   It controls the finer adjustments in the numeric input."
+        "text": "The step value used when the user presses the `ArrowUp` or `ArrowDown`\nkey to increment or decrement the value. This controls fine-grained\nadjustments to the numeric input.\n\nFor larger jumps, see `majorIncrement` (activated with `Shift` + arrow\nkeys)."
       },
       "attribute": "minor-increment",
       "reflect": false,
@@ -404,10 +494,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "10"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Specifies the step value for increasing or decreasing the input\n   when pressing the ArrowUp or ArrowDown key\n   while holding the Shift key.\n   It controls larger adjustments in the numeric input."
+        "text": "The step value used when the user presses `Shift` + `ArrowUp` or\n`Shift` + `ArrowDown` to increment or decrement the value by a larger\namount. This enables quick coarse-grained adjustments.\n\nFor smaller steps, see `minorIncrement`."
       },
       "attribute": "major-increment",
       "reflect": false,
@@ -425,10 +518,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "''"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Provides a descriptive text or string that serves\n   as the label or title for the input numeric."
+        "text": "Specifies the visible label text rendered above the numeric input.\nThe label identifies the purpose of the field and serves as the\naccessible name for screen readers."
       },
       "attribute": "label",
       "reflect": false,
@@ -446,10 +542,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "undefined"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Provides a supplementary prompt message that\n   assists users in selecting the appropriate\n   value for the input numeric."
+        "text": "Supplementary helper message displayed below the input field that\nassists users in understanding the expected value or range. Visible\nat all times (not just on focus)."
       },
       "attribute": "hint",
       "reflect": false
@@ -466,10 +565,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "undefined"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Determines whether the input numeric field is required."
+        "text": "Determines whether the numeric input field must have a value before the\nform can be submitted. When `true`, the built-in `RequiredFieldRule` is\napplied during validation and a required indicator is shown on the label."
       },
       "attribute": "required",
       "reflect": false
@@ -491,10 +593,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "[]"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Defines custom validation rules for the input numeric field."
+        "text": "An array of custom validation rules applied to the numeric input in\naddition to the built-in rules (`RequiredFieldRule`, `MinNumberRule`,\n`MaxNumberRule`). Each rule must implement the `FormFieldValidationRule`\ninterface.\n\nRules are evaluated in order when `autoValidation` is enabled or when\nvalidation is triggered programmatically."
       },
       "defaultValue": "[]"
     },
@@ -510,10 +615,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "null"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Specifies the validation status of the input numeric field."
+        "text": "Reflects the current validation status of the numeric input.\n\n- `true` \u2014 the field value passes all validation rules.\n- `false` \u2014 one or more validation rules have failed.\n- `null` \u2014 the field has not been validated yet (initial state).\n\nThis property is mutable: it is updated automatically when\n`autoValidation` is enabled, but can also be set manually to override\nthe validation state."
       },
       "attribute": "is-valid",
       "reflect": true,
@@ -531,10 +639,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "true"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "Determines whether the input field should undergo automatic validation\n   during the user's input."
+        "text": "Determines whether the numeric input should be validated automatically as\nthe user interacts with it. When `true`, validation rules (including\n`required`, `min`, `max`, and custom `validationRules`) are evaluated\nand the `isValid` property is updated accordingly.\n\nSet to `false` to handle validation manually."
       },
       "attribute": "auto-validation",
       "reflect": true,
@@ -552,10 +663,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "true"
+          }, {
             "name": "vegaVersion",
             "text": "2.53.0"
           }],
-        "text": "Determines whether the clear icon should be displayed or hidden."
+        "text": "Controls whether a clear (\u00D7) icon button is shown inside the input field\nwhen a value is present. Clicking the button resets the value to an empty\nstring and triggers the `vegaChange` event."
       },
       "attribute": "show-clear-icon",
       "reflect": false,
@@ -573,10 +687,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "null"
+          }, {
             "name": "vegaVersion",
             "text": "2.63.0"
           }],
-        "text": "Sets the minimum allowable value for the numeric input."
+        "text": "Sets the minimum allowable value for the numeric input. When set, the\nbuilt-in `MinNumberRule` is applied during validation. Values below this\nthreshold will cause validation to fail.\n\nSet to `null` to remove the lower bound."
       },
       "attribute": "min",
       "reflect": true,
@@ -594,10 +711,13 @@ export class VegaInputNumeric {
       "optional": false,
       "docs": {
         "tags": [{
+            "name": "default",
+            "text": "null"
+          }, {
             "name": "vegaVersion",
             "text": "2.63.0"
           }],
-        "text": "Sets the maximum allowable value for the numeric input."
+        "text": "Sets the maximum allowable value for the numeric input. When set, the\nbuilt-in `MaxNumberRule` is applied during validation. Values above this\nthreshold will cause validation to fail.\n\nSet to `null` to remove the upper bound."
       },
       "attribute": "max",
       "reflect": true,
@@ -615,10 +735,13 @@ export class VegaInputNumeric {
       "composed": true,
       "docs": {
         "tags": [{
+            "name": "eventDetail",
+            "text": "number"
+          }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "An event emitter notifying a value change."
+        "text": "Fires whenever the numeric input's value changes \u2014 including typing,\nkeyboard increment/decrement, clearing, and programmatic updates.\n\nThe event detail contains the new numeric value (`number`), or `NaN`\nwhen the field is empty."
       },
       "complexType": {
         "original": "number",
@@ -633,13 +756,16 @@ export class VegaInputNumeric {
       "composed": true,
       "docs": {
         "tags": [{
+            "name": "eventDetail",
+            "text": "number"
+          }, {
             "name": "eventSemantics",
             "text": "namespace:native"
           }, {
             "name": "vegaVersion",
             "text": "2.29.0"
           }],
-        "text": "An event emitter notifying a value change."
+        "text": "Native-equivalent mirror of `vegaChange`. Fires with the same payload\nand at the same time, allowing consumers to listen using the standard\n`change` event name."
       },
       "complexType": {
         "original": "number",