@mgdis/mg-components 5.19.3 → 5.21.0

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

@@ -3,199 +3,199 @@ import { Width } from '../MgInput.conf';
 import { ClassList } from '../../../../utils/components.utils';
 import { TextType } from './mg-input-text.conf';
 export declare class MgInputText {
-  /************
-   * Internal *
-   ************/
-  private classFocus;
-  private classIsInputGroupAppend;
-  private classHasIcon;
-  private characterLeftId;
-  private datalistId;
-  private input;
-  private messages;
-  private hasDisplayedError;
-  private handlerInProgress;
-  /**************
-   * Decorators *
-   **************/
-  /**
-   * Get component DOM element
-   */
-  element: HTMLMgInputTextElement;
-  /**
-   * Component value
-   */
-  value: string;
-  handleValue(newValue: string): 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;
-  /**
-   * Input type
-   */
-  type: TextType;
-  /**
-   * Input icon
-   */
-  icon: string;
-  validateIcon(newValue: string): void;
-  /**
-   * 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 datalist options
-   */
-  datalistoptions: string[];
-  validateDatalistoptions(newValue: MgInputText['datalistoptions']): void;
-  /**
-   * Input max length
-   */
-  maxlength: number;
-  /**
-   * 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;
-  /**
-   * Define input pattern to validate
-   */
-  pattern: string;
-  /**
-   * Define input pattern error message
-   */
-  patternErrorMessage: string;
-  validatePattern(newValue: string): void;
-  /**
-   * Add a tooltip message next to the input
-   */
-  tooltip: string;
-  /**
-   * Define if component should display character left
-   */
-  displayCharacterLeft: boolean;
-  /**
-   * Add a help text under the input, usually expected data format and example
-   */
-  helpText: string;
-  /**
-   * Define input valid state
-   */
-  valid: boolean;
-  /**
-   * Define input invalid state
-   */
-  invalid: boolean;
-  /**
-   * Component classes
-   */
-  classCollection: ClassList;
-  /**
-   * Error message to display
-   */
-  errorMessage: string;
-  /**
-   * Emited event when value change
-   */
-  valueChange: EventEmitter<string>;
-  /**
-   * Emited event when checking validity
-   */
-  inputValid: EventEmitter<boolean>;
-  /**
-   * Public method to play input focus
-   */
-  setFocus(): Promise<void>;
-  /**
-   * 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: MgInputText['valid'], errorMessage: string): Promise<void>;
-  /**
-   * Method to set validity values
-   * @param newValue - valid new value
-   */
-  private setValidity;
-  /**
-   * 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;
-  /**
-   * Validate append slot
-   */
-  private validateAppendSlot;
-  /**
-   * Methode to control datalist display condition
-   * @returns true if display condition success
-   */
-  private hasDatalist;
-  /*************
-   * Lifecycle *
-   *************/
-  /**
-   * Check if component props are well configured on init
-   * @returns timeout
-   */
-  componentWillLoad(): ReturnType<typeof setTimeout>;
-  /**
-   * Render
-   * @returns HTML Element
-   */
-  render(): HTMLElement;
+    /************
+     * Internal *
+     ************/
+    private classFocus;
+    private classIsInputGroupAppend;
+    private classHasIcon;
+    private characterLeftId;
+    private datalistId;
+    private input;
+    private messages;
+    private hasDisplayedError;
+    private handlerInProgress;
+    /**************
+     * Decorators *
+     **************/
+    /**
+     * Get component DOM element
+     */
+    element: HTMLMgInputTextElement;
+    /**
+     * Component value
+     */
+    value: string;
+    handleValue(newValue: string): 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;
+    /**
+     * Input type
+     */
+    type: TextType;
+    /**
+     * Input icon
+     */
+    icon: string;
+    validateIcon(newValue: string): void;
+    /**
+     * 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 datalist options
+     */
+    datalistoptions: string[];
+    validateDatalistoptions(newValue: MgInputText['datalistoptions']): void;
+    /**
+     * Input max length
+     */
+    maxlength: number;
+    /**
+     * 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;
+    /**
+     * Define input pattern to validate
+     */
+    pattern: string;
+    /**
+     * Define input pattern error message
+     */
+    patternErrorMessage: string;
+    validatePattern(newValue: string): void;
+    /**
+     * Add a tooltip message next to the input
+     */
+    tooltip: string;
+    /**
+     * Define if component should display character left
+     */
+    displayCharacterLeft: boolean;
+    /**
+     * Add a help text under the input, usually expected data format and example
+     */
+    helpText: string;
+    /**
+     * Define input valid state
+     */
+    valid: boolean;
+    /**
+     * Define input invalid state
+     */
+    invalid: boolean;
+    /**
+     * Component classes
+     */
+    classCollection: ClassList;
+    /**
+     * Error message to display
+     */
+    errorMessage: string;
+    /**
+     * Emited event when value change
+     */
+    valueChange: EventEmitter<HTMLMgInputTextElement['value']>;
+    /**
+     * Emited event when checking validity
+     */
+    inputValid: EventEmitter<HTMLMgInputTextElement['valid']>;
+    /**
+     * Public method to play input focus
+     */
+    setFocus(): Promise<void>;
+    /**
+     * 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: MgInputText['valid'], errorMessage: string): Promise<void>;
+    /**
+     * Method to set validity values
+     * @param newValue - valid new value
+     */
+    private setValidity;
+    /**
+     * 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;
+    /**
+     * Validate append slot
+     */
+    private validateAppendSlot;
+    /**
+     * Methode to control datalist display condition
+     * @returns true if display condition success
+     */
+    private hasDatalist;
+    /*************
+     * Lifecycle *
+     *************/
+    /**
+     * Check if component props are well configured on init
+     * @returns timeout
+     */
+    componentWillLoad(): ReturnType<typeof setTimeout>;
+    /**
+     * Render
+     * @returns HTML Element
+     */
+    render(): HTMLElement;
 }