@mgdis/mg-components 5.19.3 → 5.21.0

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

@@ -3,197 +3,197 @@ import { Width } from '../MgInput.conf';
 import { ClassList } from '../../../../utils/components.utils';
 import { SelectOption, OptGroup } from './mg-input-select.conf';
 export declare class MgInputSelect {
-  /************
-   * Internal *
-   ************/
-  private input;
-  private messages;
-  private hasDisplayedError;
-  private handlerInProgress;
-  /**************
-   * Decorators *
-   **************/
-  /**
-   * Get component DOM element
-   */
-  element: HTMLMgInputSelectElement;
-  /**
-   * Component value
-   */
-  value: any;
-  validateValue(newValue: MgInputSelect['value']): void;
-  /**
-   * Items are the possible options to select
-   */
-  items: (string | SelectOption)[];
-  validateItems(newValue: MgInputSelect['items']): 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;
-  /**
-   * Option to remove placeholder
-   */
-  placeholderHide: boolean;
-  /**
-   * Option to disable placeholder
-   */
-  placeholderDisabled: boolean;
-  /**
-   * 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 input valid state
-   */
-  valid: boolean;
-  /**
-   * Define input invalid state
-   */
-  invalid: boolean;
-  /**
-   * Component classes
-   */
-  classCollection: ClassList;
-  /**
-   * Error message to display
-   */
-  errorMessage: string;
-  /**
-   * Formated items for display
-   */
-  options: (SelectOption | OptGroup)[];
-  /**
-   * Does value match any item option
-   */
-  valueExist: boolean;
-  /**
-   * Does value match any item option
-   */
-  readonlyValue: string;
-  /**
-   * Emited event when value change
-   */
-  valueChange: EventEmitter<MgInputSelect['value']>;
-  /**
-   * 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: MgInputSelect['valid'], errorMessage: string): Promise<void>;
-  /**
-   * Method to set validity values
-   * @param newValue - valid new value
-   */
-  private setValidity;
-  /**
-   * Handle input event
-   */
-  private handleInput;
-  /**
-   * Method to compare item.title with input.value
-   * @param item - item to compare with
-   * @returns truthy if input.value is an item
-   */
-  private isInputValue;
-  /**
-   * value props setter
-   * @param newValue - value to update with
-   */
-  private setValue;
-  /**
-   * Update value from input.value
-   */
-  private updateValue;
-  /**
-   * Handle blur event
-   */
-  private handleBlur;
-  /**
-   * Input value is disabled
-   * @returns truthy if input value is disabled
-   */
-  private isDisabledValue;
-  /**
-   * Check if input is valid
-   */
-  private checkValidity;
-  /**
-   * Set input error message
-   * @param errorMessage - errorMessage override
-   */
-  private setErrorMessage;
-  /*************
-   * Lifecycle *
-   *************/
-  /**
-   * Check if component props are well configured on init
-   * @returns timeout
-   */
-  componentWillLoad(): ReturnType<typeof setTimeout>;
-  /**
-   * Render option
-   * @param option - to render
-   * @returns render option
-   */
-  private renderOption;
-  /**
-   * Render
-   * @returns HTML Element
-   */
-  render(): HTMLElement;
+    /************
+     * Internal *
+     ************/
+    private input;
+    private messages;
+    private hasDisplayedError;
+    private handlerInProgress;
+    /**************
+     * Decorators *
+     **************/
+    /**
+     * Get component DOM element
+     */
+    element: HTMLMgInputSelectElement;
+    /**
+     * Component value
+     */
+    value: any;
+    validateValue(newValue: MgInputSelect['value']): void;
+    /**
+     * Items are the possible options to select
+     */
+    items: (string | SelectOption)[];
+    validateItems(newValue: MgInputSelect['items']): 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;
+    /**
+     * Option to remove placeholder
+     */
+    placeholderHide: boolean;
+    /**
+     * Option to disable placeholder
+     */
+    placeholderDisabled: boolean;
+    /**
+     * 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 input valid state
+     */
+    valid: boolean;
+    /**
+     * Define input invalid state
+     */
+    invalid: boolean;
+    /**
+     * Component classes
+     */
+    classCollection: ClassList;
+    /**
+     * Error message to display
+     */
+    errorMessage: string;
+    /**
+     * Formated items for display
+     */
+    options: (SelectOption | OptGroup)[];
+    /**
+     * Does value match any item option
+     */
+    valueExist: boolean;
+    /**
+     * Does value match any item option
+     */
+    readonlyValue: string;
+    /**
+     * Emited event when value change
+     */
+    valueChange: EventEmitter<HTMLMgInputCheckboxElement['value']>;
+    /**
+     * Emited event when checking validity
+     */
+    inputValid: EventEmitter<HTMLMgInputCheckboxElement['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: MgInputSelect['valid'], errorMessage: string): Promise<void>;
+    /**
+     * Method to set validity values
+     * @param newValue - valid new value
+     */
+    private setValidity;
+    /**
+     * Handle input event
+     */
+    private handleInput;
+    /**
+     * Method to compare item.title with input.value
+     * @param item - item to compare with
+     * @returns truthy if input.value is an item
+     */
+    private isInputValue;
+    /**
+     * value props setter
+     * @param newValue - value to update with
+     */
+    private setValue;
+    /**
+     * Update value from input.value
+     */
+    private updateValue;
+    /**
+     * Handle blur event
+     */
+    private handleBlur;
+    /**
+     * Input value is disabled
+     * @returns truthy if input value is disabled
+     */
+    private isDisabledValue;
+    /**
+     * Check if input is valid
+     */
+    private checkValidity;
+    /**
+     * Set input error message
+     * @param errorMessage - errorMessage override
+     */
+    private setErrorMessage;
+    /*************
+     * Lifecycle *
+     *************/
+    /**
+     * Check if component props are well configured on init
+     * @returns timeout
+     */
+    componentWillLoad(): ReturnType<typeof setTimeout>;
+    /**
+     * Render option
+     * @param option - to render
+     * @returns render option
+     */
+    private renderOption;
+    /**
+     * Render
+     * @returns HTML Element
+     */
+    render(): HTMLElement;
 }