@mgdis/mg-components 5.19.3 → 5.20.0

package/dist/types/components/molecules/inputs/mg-input-numeric/mg-input-numeric.d.ts

@@ -2,227 +2,227 @@ import { EventEmitter } from '../../../../stencil-public-runtime';
 import { Width } from '../MgInput.conf';
 import { ClassList } from '../../../../utils/components.utils';
 export declare class MgInputNumeric {
-  /************
-   * Internal *
-   ************/
-  private storedValue;
-  private numericValue;
-  private readonlyValue;
-  private input;
-  private locale;
-  private messages;
-  private hasDisplayedError;
-  private handlerInProgress;
-  /**************
-   * Decorators *
-   **************/
-  /**
-   * Get component DOM element
-   */
-  element: HTMLMgInputNumericElement;
-  /**
-   * Component value
-   */
-  value: string;
-  validateValue(newValue: MgInputNumeric['value']): void;
-  /**
-   * Identifier is used for the element ID (id is a reserved prop in Stencil.js)
-   */
-  identifier: string;
-  /**
-   * Input name
-   * If not set the value equals the identifier
-   */
-  name: string;
-  /**
-   * Input label
-   */
-  label: string;
-  /**
-   * Define if label is displayed on top
-   */
-  labelOnTop: boolean;
-  /**
-   * Define if label is visible
-   */
-  labelHide: boolean;
-  /**
-   * Input placeholder.
-   * It should be a word or short phrase that demonstrates the expected type of data, not a replacement for labels or help text.
-   */
-  placeholder: string;
-  /**
-   * Define if input is required
-   */
-  required: boolean;
-  /**
-   * Define if input is readonly
-   */
-  readonly: boolean;
-  /**
-   * Define if input is disabled
-   */
-  disabled: boolean;
-  handleValidityChange(newValue: boolean, _oldValue: boolean, prop: string): void;
-  /**
-   * Define input width
-   */
-  mgWidth: Width;
-  /**
-   * Add a tooltip message next to the input
-   */
-  tooltip: string;
-  /**
-   * Add a help text under the input, usually expected data format and example
-   */
-  helpText: string;
-  /**
-   * Define numeric type
-   */
-  type: string;
-  validateType(newValue: MgInputNumeric['type']): void;
-  /**
-   * Define currency
-   */
-  currency: string;
-  /**
-   * Maximum value
-   */
-  max: number;
-  /**
-   * Minimum value
-   */
-  min: number;
-  /**
-   * Override integer length
-   * integer is the number before the decimal point
-   */
-  integerLength: number;
-  validateIntegerLength(newValue: MgInputNumeric['integerLength']): void;
-  /**
-   * Override decimal length
-   * decimal is the number after the decimal point
-   */
-  decimalLength: number;
-  validateDecimalLength(newValue: MgInputNumeric['decimalLength']): void;
-  /**
-   * Define input pattern to validate
-   */
-  valid: boolean;
-  /**
-   * Define input pattern error message
-   */
-  invalid: boolean;
-  /**
-   * Component classes
-   */
-  classCollection: ClassList;
-  /**
-   * Error message to display
-   */
-  errorMessage: string;
-  /**
-   * Define if input has focus
-   */
-  hasFocus: boolean;
-  /**
-   * Emited event when value change
-   */
-  valueChange: EventEmitter<number>;
-  /**
-   * Emited event when checking validity
-   */
-  inputValid: EventEmitter<boolean>;
-  /**
-   * Display input error if it exists.
-   */
-  displayError(): Promise<void>;
-  /**
-   * Set an error and display a custom error message.
-   * This method can be used to set the component's error state from its context by passing a boolean value to the `valid` parameter.
-   * It must be paired with an error message to display for the given context.
-   * When used to set validity to `false`, you should use this method again to reset the validity to `true`.
-   * @param valid - value indicating the validity
-   * @param errorMessage - the error message to display
-   */
-  setError(valid: MgInputNumeric['valid'], errorMessage: string): Promise<void>;
-  /**
-   * Method to set validity values
-   * @param newValue - valid new value
-   */
-  private setValidity;
-  /**
-   * Checks if the given value is valid according to the defined rules.
-   * @param value - The input value to validate.
-   * @param regex - The regular expression for validation.
-   * @param integer - The integer part of the value.
-   * @param decimal - The decimal part of the value.
-   * @returns Returns true if the value is valid, otherwise false.
-   */
-  private isValidValue;
-  /**
-   * Handles invalid input values and returns a corrected value.
-   * @returns The corrected value.
-   */
-  private handleInvalidValue;
-  /**
-   * Updates the component values based on the validated input value.
-   * @param newValue - The validated input value.
-   */
-  private updateValues;
-  /**
-   * Displayed value in input
-   * Change on focus/blur
-   * @returns display value
-   */
-  private displayValue;
-  /**
-   * Handle input event
-   */
-  private handleInput;
-  /**
-   * Handle focus event
-   */
-  private handleFocus;
-  /**
-   * Handle blur event
-   */
-  private handleBlur;
-  /**
-   * Check if input is valid
-   */
-  private checkValidity;
-  /**
-   * Set input error message
-   * @param errorMessage - errorMessage override
-   */
-  private setErrorMessage;
-  /**
-   * Get input error code
-   * @returns error code
-   */
-  private getInputError;
-  /**
-   * Format value based on type
-   * @param value - value to format
-   * @returns formated local value
-   */
-  private formatValue;
-  /**
-   * Validate append slot
-   */
-  private validateAppendSlot;
-  /*************
-   * Lifecycle *
-   *************/
-  /**
-   * Check if component props are well configured on init
-   * @returns timeout
-   */
-  componentWillLoad(): ReturnType<typeof setTimeout>;
-  /**
-   * Render
-   * @returns HTML Element
-   */
-  render(): HTMLElement;
+    /************
+     * Internal *
+     ************/
+    private storedValue;
+    private numericValue;
+    private readonlyValue;
+    private input;
+    private locale;
+    private messages;
+    private hasDisplayedError;
+    private handlerInProgress;
+    /**************
+     * Decorators *
+     **************/
+    /**
+     * Get component DOM element
+     */
+    element: HTMLMgInputNumericElement;
+    /**
+     * Component value
+     */
+    value: string;
+    validateValue(newValue: MgInputNumeric['value']): void;
+    /**
+     * Identifier is used for the element ID (id is a reserved prop in Stencil.js)
+     */
+    identifier: string;
+    /**
+     * Input name
+     * If not set the value equals the identifier
+     */
+    name: string;
+    /**
+     * Input label
+     */
+    label: string;
+    /**
+     * Define if label is displayed on top
+     */
+    labelOnTop: boolean;
+    /**
+     * Define if label is visible
+     */
+    labelHide: boolean;
+    /**
+     * Input placeholder.
+     * It should be a word or short phrase that demonstrates the expected type of data, not a replacement for labels or help text.
+     */
+    placeholder: string;
+    /**
+     * Define if input is required
+     */
+    required: boolean;
+    /**
+     * Define if input is readonly
+     */
+    readonly: boolean;
+    /**
+     * Define if input is disabled
+     */
+    disabled: boolean;
+    handleValidityChange(newValue: boolean, _oldValue: boolean, prop: string): void;
+    /**
+     * Define input width
+     */
+    mgWidth: Width;
+    /**
+     * Add a tooltip message next to the input
+     */
+    tooltip: string;
+    /**
+     * Add a help text under the input, usually expected data format and example
+     */
+    helpText: string;
+    /**
+     * Define numeric type
+     */
+    type: string;
+    validateType(newValue: MgInputNumeric['type']): void;
+    /**
+     * Define currency
+     */
+    currency: string;
+    /**
+     * Maximum value
+     */
+    max: number;
+    /**
+     * Minimum value
+     */
+    min: number;
+    /**
+     * Override integer length
+     * integer is the number before the decimal point
+     */
+    integerLength: number;
+    validateIntegerLength(newValue: MgInputNumeric['integerLength']): void;
+    /**
+     * Override decimal length
+     * decimal is the number after the decimal point
+     */
+    decimalLength: number;
+    validateDecimalLength(newValue: MgInputNumeric['decimalLength']): void;
+    /**
+     * Define input pattern to validate
+     */
+    valid: boolean;
+    /**
+     * Define input pattern error message
+     */
+    invalid: boolean;
+    /**
+     * Component classes
+     */
+    classCollection: ClassList;
+    /**
+     * Error message to display
+     */
+    errorMessage: string;
+    /**
+     * Define if input has focus
+     */
+    hasFocus: boolean;
+    /**
+     * Emited event when value change
+     */
+    valueChange: EventEmitter<number>;
+    /**
+     * Emited event when checking validity
+     */
+    inputValid: EventEmitter<HTMLMgInputNumericElement['valid']>;
+    /**
+     * Display input error if it exists.
+     */
+    displayError(): Promise<void>;
+    /**
+     * Set an error and display a custom error message.
+     * This method can be used to set the component's error state from its context by passing a boolean value to the `valid` parameter.
+     * It must be paired with an error message to display for the given context.
+     * When used to set validity to `false`, you should use this method again to reset the validity to `true`.
+     * @param valid - value indicating the validity
+     * @param errorMessage - the error message to display
+     */
+    setError(valid: MgInputNumeric['valid'], errorMessage: string): Promise<void>;
+    /**
+     * Method to set validity values
+     * @param newValue - valid new value
+     */
+    private setValidity;
+    /**
+     * Checks if the given value is valid according to the defined rules.
+     * @param value - The input value to validate.
+     * @param regex - The regular expression for validation.
+     * @param integer - The integer part of the value.
+     * @param decimal - The decimal part of the value.
+     * @returns Returns true if the value is valid, otherwise false.
+     */
+    private isValidValue;
+    /**
+     * Handles invalid input values and returns a corrected value.
+     * @returns The corrected value.
+     */
+    private handleInvalidValue;
+    /**
+     * Updates the component values based on the validated input value.
+     * @param newValue - The validated input value.
+     */
+    private updateValues;
+    /**
+     * Displayed value in input
+     * Change on focus/blur
+     * @returns display value
+     */
+    private displayValue;
+    /**
+     * Handle input event
+     */
+    private handleInput;
+    /**
+     * Handle focus event
+     */
+    private handleFocus;
+    /**
+     * Handle blur event
+     */
+    private handleBlur;
+    /**
+     * Check if input is valid
+     */
+    private checkValidity;
+    /**
+     * Set input error message
+     * @param errorMessage - errorMessage override
+     */
+    private setErrorMessage;
+    /**
+     * Get input error code
+     * @returns error code
+     */
+    private getInputError;
+    /**
+     * Format value based on type
+     * @param value - value to format
+     * @returns formated local value
+     */
+    private formatValue;
+    /**
+     * Validate append slot
+     */
+    private validateAppendSlot;
+    /*************
+     * Lifecycle *
+     *************/
+    /**
+     * Check if component props are well configured on init
+     * @returns timeout
+     */
+    componentWillLoad(): ReturnType<typeof setTimeout>;
+    /**
+     * Render
+     * @returns HTML Element
+     */
+    render(): HTMLElement;
 }