@heartlandone/vega 2.77.1 → 2.78.0

package/dist/types/components/vega-input-numeric/vega-input-numeric.d.ts

@@ -27,158 +27,233 @@ export declare class VegaInputNumeric {
   host: HTMLVegaInputNumericElement;
   isCompactInputWidth: boolean;
   /**
-   * 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
    */
   prefixText: string;
   watchPrefixText(): void;
   /**
-   * Defines the suffix for the input numeric field.
-   * It provides additional context or information displayed
-   *    after the numeric value, helping to
-   *    clarify its purpose or usage.
+   * Text displayed after (to the right of) the numeric value inside the input
+   * field. Use this to provide contextual information such as a unit suffix
+   * (e.g., `'%'`, `'kg'`, `'USD'`).
    *
+   * @default undefined
    * @vegaVersion 2.29.0
    */
   suffixText: string;
   watchSuffixText(): void;
   /**
-   * Specifies an icon or symbol that appears before the input field,
-   *    providing visual context or enhancing the aesthetic appearance
-   *    of the input numeric.
+   * Name of a Vega icon rendered before (to the left of) the input field,
+   * providing additional visual context. The icon is purely decorative and
+   * does not affect the input value.
    *
+   * @default undefined
    * @vegaVersion 2.29.0
    */
   prefixIcon: string;
   /**
-   * 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
    */
   value: string;
   watchValue(): void;
   /**
-   * 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
    */
   size: 'medium' | 'small';
   /**
-   * Specifies a placeholder string that displays as a temporary hint
-   *    or example inside the input numeric field.
+   * Specifies placeholder text displayed inside the input field when it is
+   * empty. The placeholder disappears once the user begins typing and is
+   * typically used to indicate the expected format (e.g., `'0.00'`).
    *
+   * @default undefined
    * @vegaVersion 2.29.0
    */
   placeholder: string;
   /**
-   * 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
    */
   thousandComma: boolean;
   /**
-   * 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
    */
   integerOnly: boolean;
   /**
-   * 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
    */
   disabled: boolean;
   /**
-   * 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
    */
   minorIncrement: number;
   /**
-   * 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
    */
   majorIncrement: number;
   /**
-   * 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
    */
   label: string;
   /**
-   * Provides a supplementary prompt message that
-   *    assists users in selecting the appropriate
-   *    value for the input numeric.
+   * Supplementary helper message displayed below the input field that
+   * assists users in understanding the expected value or range. Visible
+   * at all times (not just on focus).
    *
+   * @default undefined
    * @vegaVersion 2.29.0
    */
   hint: string;
   /**
-   * Determines whether the input numeric field is required.
+   * Determines whether the numeric input field must have a value before the
+   * form can be submitted. When `true`, the built-in `RequiredFieldRule` is
+   * applied during validation and a required indicator is shown on the label.
    *
+   * @default undefined
    * @vegaVersion 2.29.0
    */
   required: boolean;
   /**
-   * 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
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
-   * 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
    */
   isValid: boolean;
   /**
-   * 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
    */
   autoValidation: boolean;
   /**
-   * 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
    */
   showClearIcon: boolean;
   /**
-   * 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
    */
   min: number | 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
    */
   max: number | null;
   /**
-   * An event emitter notifying a value change.
+   * Fires whenever the numeric input's value changes — including typing,
+   * keyboard increment/decrement, clearing, and programmatic updates.
+   *
+   * The event detail contains the new numeric value (`number`), or `NaN`
+   * when the field is empty.
    *
+   * @eventDetail number
    * @vegaVersion 2.29.0
    */
   vegaChange: EventEmitter<number>;
   /**
-   * An event emitter notifying a value change.
+   * Native-equivalent mirror of `vegaChange`. Fires with the same payload
+   * and at the same time, allowing consumers to listen using the standard
+   * `change` event name.
    *
+   * @eventDetail number
    * @eventSemantics namespace:native
    * @vegaVersion 2.29.0
    */

package/dist/types/components/vega-input-passcode/vega-input-passcode.d.ts

@@ -26,107 +26,161 @@ export declare class VegaInputPasscode {
   vegaInputValues: ImmutableArray<string>;
   watchVegaInputValues(): void;
   /**
-   * Specifies the label or title for the input passcode.
-   *
-   * It provides descriptive text that helps identify the
-   *    purpose or content expected in the input passcode.
+   * Specifies the visible label text rendered above the passcode input.
+   * The label identifies the purpose of the field (e.g., "Enter verification
+   * code") and serves as the accessible name for screen readers.
    *
+   * @default ''
    * @vegaVersion 2.66.0
    */
   label: string;
   /**
-   * Determines whether the input passcode is disabled.
+   * Specifies whether the passcode input is disabled. When `true`, all
+   * individual input boxes become non-interactive — the user cannot type,
+   * paste, or focus any box.
    *
+   * @default false
    * @vegaVersion 2.66.0
    */
   disabled: boolean;
   /**
-   * Defines the size of the input passcode,
-   *    specifying its width or length.
+   * Controls the visual size of the passcode input boxes.
+   *
+   * - `'medium'` — Standard height, suitable for most form layouts.
+   * - `'small'` — Compact height, useful for dense UIs.
    *
+   * @default 'medium'
    * @vegaVersion 2.66.0
    */
   size: 'medium' | 'small';
   /**
-   * Provides a supplementary prompt message that assists users in
-   *    understanding the expected value for the input passcode.
+   * Supplementary helper message displayed below the passcode input that
+   * assists users in understanding the expected input. For example,
+   * `'Enter the 4-digit code sent to your email'`.
    *
+   * @default ''
    * @vegaVersion 2.66.0
    */
   hint: string;
   /**
-   * Specifies the number of input boxes to display.
+   * Specifies the number of individual input boxes rendered for the passcode.
+   * Each box accepts a single character. Common values are `4` for a PIN and
+   * `6` for a two-factor authentication code.
    *
+   * @default 4
    * @vegaVersion 2.66.0
    */
   length: number;
   /**
-   * Specifies the input type of the input passcode
-   *    Numeric type: only 0-9 are accepted
-   *    Text type: any non-space character is accepted
-   *    Spaces are rejected for all types
+   * Specifies the type of characters accepted by each passcode box.
+   *
+   * - `'numeric'` — Only digits `0`–`9` are accepted.
+   * - `'text'` — Any non-space character is accepted.
    *
+   * Spaces are always rejected regardless of the selected type.
+   *
+   * @default 'numeric'
    * @vegaVersion 2.66.0
    */
   inputType: 'numeric' | 'text';
   watchLengthAndInputType(): void;
   /**
-   * Specifies the value of the input passcode.
+   * The current value of the passcode input, represented as a concatenated
+   * string of all box values (e.g., `'1234'` for a 4-digit passcode).
+   *
+   * This property is mutable and reflected to the host element attribute.
+   * It updates as the user types into the boxes and can be set externally
+   * to pre-populate or reset the field.
    *
+   * @default ''
    * @vegaVersion 2.66.0
    */
   value: string;
   watchValue(): void;
   /**
-   * Determines whether the input passcode field is required.
+   * Determines whether the passcode field must have a value before the form
+   * can be submitted. When `true`, the built-in `RequiredFieldRule` is
+   * applied during validation and a required indicator is shown on the label.
    *
+   * @default false
    * @vegaVersion 2.66.0
    */
   required: boolean;
   /**
-   * Defines custom validation rules for the input passcode.
+   * An array of custom validation rules applied to the passcode input in
+   * addition to the built-in `RequiredFieldRule`. 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.66.0
    */
   validationRules: FormFieldValidationRule<unknown>[];
   watchValidationRules(): void;
   /**
-   * Determines whether the input passcode should undergo automatic validation
-   *    during the user's input.
+   * Determines whether the passcode input should be validated automatically
+   * as the user types. When `true`, validation rules (including `required`
+   * and custom `validationRules`) are evaluated and the `isValid` property
+   * is updated accordingly.
    *
+   * Set to `false` to handle validation manually.
+   *
+   * @default true
    * @vegaVersion 2.66.0
    */
   autoValidation: boolean;
   /**
-   * Specifies the validation status of the input passcode.
+   * Reflects the current validation status of the passcode 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.66.0
    */
   isValid: boolean | null;
   /**
-   * An event emitter notifying the change of the value in the input passcode,
-   *    whether triggered programmatically or through user interaction.
+   * Fires whenever the passcode value changes — each time a character is
+   * entered, deleted, or pasted into any box. The event detail contains the
+   * concatenated string of all box values at the time of the change.
    *
+   * @eventDetail string
    * @vegaVersion 2.66.0
    */
   vegaChange: EventEmitter<string>;
   /**
-   * An event emitter notifying the change of the value in the input passcode,
-   *    whether triggered programmatically or through user interaction.
+   * Native-equivalent mirror of `vegaChange`. Fires with the same payload
+   * and at the same time, allowing consumers to listen using the standard
+   * `change` event name.
+   *
+   * @eventDetail string
    * @eventSemantics namespace:native
    * @vegaVersion 2.66.0
    */
   change: EventEmitter<string>;
   /**
-   * An event emitter notifying the completion of all input passcode boxes.
-   *    whether triggered programmatically or through user interaction.
+   * Fires when all passcode boxes have been filled (i.e., the value length
+   * equals the configured `length`). The event detail contains the complete
+   * passcode string. Useful for triggering auto-submit or verification
+   * workflows.
    *
+   * @eventDetail string
    * @vegaVersion 2.66.0
    */
   vegaComplete: EventEmitter<string>;
   /**
-   * An event emitter notifying the completion of all input passcode boxes.
-   *    whether triggered programmatically or through user interaction.
+   * Native-equivalent mirror of `vegaComplete`. Fires with the same payload
+   * and at the same time, allowing consumers to listen using the standard
+   * `complete` event name.
+   *
+   * @eventDetail string
    * @eventSemantics namespace:native
    * @vegaVersion 2.66.0
    */