@mgdis/mg-components 5.19.2 → 5.20.0

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

@@ -2,264 +2,266 @@ import { EventEmitter } from '../../../../stencil-public-runtime';
 import { ClassList } from '../../../../utils/components.utils';
 import { CheckboxItem, CheckboxType, CheckboxValue, MgInputCheckboxListProps } from './mg-input-checkbox.conf';
 export declare class MgInputCheckbox implements Omit<MgInputCheckboxListProps, 'id' | 'checkboxes' | 'messages'> {
-  /************
-   * Internal *
-   ************/
-  private mgPopover;
-  private searchInput;
-  private messages;
-  private hasDisplayedError;
-  private mode;
-  private readonly baseClassName;
-  private readonly multiStart;
-  private readonly searchStart;
-  /**************
-   * Decorators *
-   **************/
-  /**
-   * Get component DOM element
-   */
-  element: HTMLMgInputCheckboxElement;
-  /**
-   * Component value
-   * If item.value is `null`, checkbox will be indeterminate by default
-   */
-  value: CheckboxValue[];
-  validateValue(newValue: MgInputCheckbox['value']): void;
-  /**
-   * Define checkbox type
-   * When it's undefined the type is dynamic:
-   * - With 0-5 items type is 'checkbox'
-   * - With 5-10 items type is 'multi'
-   * When it set the type is locked to the defined value.
-   * When type is dynamic OR with 'multi' type AND Over 10 items "search" feature is enabled
-   */
-  type: CheckboxType;
-  validateType(newValue: MgInputCheckbox['type']): void;
-  /**
-   * Identifier is used for the element ID (id is a reserved prop in Stencil.js)
-   */
-  identifier: string;
-  /**
-   * Define input name
-   * If not set the value equals the identifier
-   */
-  name: string;
-  /**
-   * Define input label
-   */
-  label: string;
-  /**
-   * Define if label is displayed on top
-   */
-  labelOnTop: boolean;
-  /**
-   * Define if label is visible
-   */
-  labelHide: boolean;
-  /**
-   * Define if inputs are display verticaly
-   */
-  inputVerticalList: boolean;
-  /**
-   * Define if mg-input-checkbox is required
-   */
-  required: boolean;
-  /**
-   * Define if mg-input-checkbox is readonly
-   */
-  readonly: boolean;
-  /**
-   * Display selected values list in "multi" type
-   */
-  displaySelectedValues: boolean;
-  validateDisplaySelectedValues(newValue: MgInputCheckbox['displaySelectedValues']): void;
-  /**
-   * Define if input is disabled
-   */
-  disabled: boolean;
-  handleValidityChange(newValue: boolean, _oldValue: boolean, prop: string): void;
-  validateDisabled(newValue: MgInputCheckbox['disabled']): void;
-  /**
-   * 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 value to display in list
-   */
-  checkboxItems: CheckboxItem[];
-  validateCheckboxItems(newValue: MgInputCheckbox['checkboxItems']): void;
-  /**
-   * Display search input
-   */
-  displaySearchInput: boolean;
-  /**
-   * Search value query
-   */
-  searchValue: string;
-  validateSearchValue(): void;
-  /**
-   * Search current page
-   */
-  searchResults: CheckboxItem[];
-  /**
-   * Emitted event when value change
-   */
-  valueChange: EventEmitter<MgInputCheckbox['value']>;
-  /**
-   * Emited event when checking validity
-   */
-  inputValid: EventEmitter<MgInputCheckbox['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: MgInputCheckbox['valid'], errorMessage: string): Promise<void>;
-  /**
-   * Method to set validity values
-   * @param newValue - valid new value
-   */
-  private setValidity;
-  /**
-   * Handle input event
-   * @param event - input event
-   */
-  private handleInput;
-  /**
-   * Keyboard handler
-   * @param event - to trak "tab" key
-   */
-  private handleKeydown;
-  /**
-   * Handle blur event
-   */
-  private handleBlur;
-  /**
-   * Handle input search value-change event
-   * @param event - input value-change event
-   */
-  private handleSearchChange;
-  /**
-   * popover display-change handler
-   * @param event - mg-popover display-change custom event
-   */
-  private handleMgPopoverDisplayChange;
-  /**
-   * Handle select all button
-   * @param event - mass action event trigger a global select/unselect on values
-   */
-  private handleMassAction;
-  /**
-   * Update values
-   */
-  private updateValues;
-  /**
-   * Update ckecboxes item
-   * @param key - property to update
-   * @param newValue - value to update with
-   * @param condition - condtion to applu change on item
-   */
-  private updateCheckboxItems;
-  /**
-   * get invalid element
-   * @returns element
-   */
-  private getInvalidElement;
-  /**
-   * Method to update searchResults
-   */
-  private updateSearchResults;
-  /**
-   * Methode to validate if one of inputs value is checked id required
-   * @returns truthy if condition is valid
-   */
-  private validateRequired;
-  /**
-   * Check if input is valid
-   */
-  private checkValidity;
-  /**
-   * Render button text
-   * @param selectedValuesNb - nb of selected values
-   * @returns translated message
-   */
-  private renderButtonText;
-  /**
-   * Set input error message
-   * @param displayError - dispay error condition
-   * @param errorMessage - errorMessage override
-   */
-  private setErrorMessage;
-  /**
-   * Method to get mg-popover identifier
-   * @returns MgPopover identifier
-   */
-  private getMgPopoverIdentifier;
-  /**
-   * Manage items to display depending on the search state
-   * @returns items to display
-   */
-  private getDisplayItems;
-  /*************
-   * Lifecycle *
-   *************/
-  /**
-   * Check if component props are well configured on init
-   * @returns timeout
-   */
-  componentWillLoad(): ReturnType<typeof setTimeout>;
-  /**
-   * add listeners
-   */
-  componentDidLoad(): void;
-  /**
-   * Render checkbox multi display values
-   * @param selectedValuesNb - selected values length
-   * @returns display selected values
-   */
-  private renderCheckboxMultiDisplaySelectedValues;
-  /**
-   * Render checkboxes by section
-   * @param checkboxes - checkboxes to render
-   * @returns render sections of checkboxes
-   */
-  private renderCheckboxBySection;
-  /**
-   * render checkbox multi element
-   * @returns html element
-   */
-  private renderCheckboxMulti;
-  /**
-   * Render
-   * @returns HTML Element
-   */
-  render(): HTMLElement;
+    /************
+     * Internal *
+     ************/
+    private mgPopover;
+    private searchInput;
+    private messages;
+    private hasDisplayedError;
+    private handlerInProgress;
+    private mode;
+    private legendId;
+    private readonly baseClassName;
+    private readonly multiStart;
+    private readonly searchStart;
+    /**************
+     * Decorators *
+     **************/
+    /**
+     * Get component DOM element
+     */
+    element: HTMLMgInputCheckboxElement;
+    /**
+     * Component value
+     * If item.value is `null`, checkbox will be indeterminate by default
+     */
+    value: CheckboxValue[];
+    validateValue(newValue: MgInputCheckbox['value']): void;
+    /**
+     * Define checkbox type
+     * When it's undefined the type is dynamic:
+     * - With 0-5 items type is 'checkbox'
+     * - With 5-10 items type is 'multi'
+     * When it set the type is locked to the defined value.
+     * When type is dynamic OR with 'multi' type AND Over 10 items "search" feature is enabled
+     */
+    type: CheckboxType;
+    validateType(newValue: MgInputCheckbox['type']): void;
+    /**
+     * Identifier is used for the element ID (id is a reserved prop in Stencil.js)
+     */
+    identifier: string;
+    /**
+     * Define input name
+     * If not set the value equals the identifier
+     */
+    name: string;
+    /**
+     * Define input label
+     */
+    label: string;
+    /**
+     * Define if label is displayed on top
+     */
+    labelOnTop: boolean;
+    /**
+     * Define if label is visible
+     */
+    labelHide: boolean;
+    /**
+     * Define if inputs are display verticaly
+     */
+    inputVerticalList: boolean;
+    /**
+     * Define if mg-input-checkbox is required
+     */
+    required: boolean;
+    /**
+     * Define if mg-input-checkbox is readonly
+     */
+    readonly: boolean;
+    /**
+     * Display selected values list in "multi" type
+     * This prop is only applied with prop type "multi" or when an "unset" mode render a "multi" type.
+     */
+    displaySelectedValues: boolean;
+    /**
+     * Define if input is disabled
+     */
+    disabled: boolean;
+    handleValidityChange(newValue: boolean, _oldValue: boolean, prop: string): void;
+    validateDisabled(newValue: MgInputCheckbox['disabled']): void;
+    /**
+     * 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 value to display in list
+     */
+    checkboxItems: CheckboxItem[];
+    validateCheckboxItems(newValue: MgInputCheckbox['checkboxItems']): void;
+    /**
+     * Display search input
+     */
+    displaySearchInput: boolean;
+    /**
+     * Search value query
+     */
+    searchValue: string;
+    validateSearchValue(): void;
+    /**
+     * Search current page
+     */
+    searchResults: CheckboxItem[];
+    /**
+     * Emitted 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: MgInputCheckbox['valid'], errorMessage: string): Promise<void>;
+    /**
+     * Method to set validity values
+     * @param newValue - valid new value
+     */
+    private setValidity;
+    /**
+     * Handle input event
+     * @param event - input event
+     */
+    private handleInput;
+    /**
+     * Keyboard handler
+     * @param event - to trak "tab" key
+     */
+    private handleKeydown;
+    /**
+     * Handle blur event
+     */
+    private handleBlur;
+    /**
+     * Handle input search value-change event
+     * @param event - input value-change event
+     */
+    private handleSearchChange;
+    /**
+     * popover display-change handler
+     * @param event - mg-popover display-change custom event
+     */
+    private handleMgPopoverDisplayChange;
+    /**
+     * Handle select all button
+     * @param event - mass action event trigger a global select/unselect on values
+     */
+    private handleMassAction;
+    /**
+     * Update values
+     */
+    private updateValues;
+    /**
+     * Update ckecboxes item
+     * @param key - property to update
+     * @param newValue - value to update with
+     * @param condition - condtion to applu change on item
+     */
+    private updateCheckboxItems;
+    /**
+     * has invalid input
+     * @returns true if at least one input is invalid
+     */
+    private hasInvalidInput;
+    /**
+     * Method to update searchResults
+     */
+    private updateSearchResults;
+    /**
+     * Methode to validate if one of inputs value is checked id required
+     * @returns truthy if condition is valid
+     */
+    private validateRequired;
+    /**
+     * Check if input is valid
+     */
+    private checkValidity;
+    /**
+     * Render button text
+     * @param selectedValuesNb - nb of selected values
+     * @returns translated message
+     */
+    private renderButtonText;
+    /**
+     * Set input error message
+     * @param displayError - dispay error condition
+     * @param errorMessage - errorMessage override
+     */
+    private setErrorMessage;
+    /**
+     * Method to get mg-popover identifier
+     * @returns MgPopover identifier
+     */
+    private getMgPopoverIdentifier;
+    /**
+     * Manage items to display depending on the search state
+     * @returns items to display
+     */
+    private getDisplayItems;
+    /*************
+     * Lifecycle *
+     *************/
+    /**
+     * Check if component props are well configured on init
+     * @returns timeout
+     */
+    componentWillLoad(): ReturnType<typeof setTimeout>;
+    /**
+     * add listeners and DOM attributed
+     */
+    componentDidLoad(): void;
+    /**
+     * Render checkbox multi display values
+     * @param selectedValuesNb - selected values length
+     * @returns display selected values
+     */
+    private renderCheckboxMultiDisplaySelectedValues;
+    /**
+     * Render checkboxes by section
+     * @param checkboxes - checkboxes to render
+     * @returns render sections of checkboxes
+     */
+    private renderCheckboxBySection;
+    /**
+     * render checkbox multi element
+     * @returns html element
+     */
+    private renderCheckboxMulti;
+    /**
+     * Render
+     * @returns HTML Element
+     */
+    render(): HTMLElement;
 }

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

@@ -1,6 +1,6 @@
 export declare enum InputError {
-  MIN = "min",
-  MAX = "max",
-  MINMAX = "minMax",
-  REQUIRED = "required"
+    MIN = "min",
+    MAX = "max",
+    MINMAX = "minMax",
+    REQUIRED = "required"
 }