@mgdis/mg-components 5.10.0 → 5.10.1

package/dist/types/components/atoms/mg-badge/mg-badge.d.ts

@@ -32,15 +32,14 @@ export declare class MgBadge {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Check if props are well configured on init
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/atoms/mg-button/mg-button.d.ts

@@ -69,37 +69,33 @@ export declare class MgButton {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Emmited event when disabled change
    */
   disabledChange: EventEmitter<MgButton['disabled']>;
   /**
    * Trigger actions onClick event
-   * @param {MouseEvent} event click event
-   * @returns {void}
+   * @param event - click event
    */
   private handleClick;
   /**
    * Handle onKeydown event
-   * @param {KeyboardEvent} event keyboard event
-   * @returns {void}
+   * @param event - keyboard event
    */
   private handleKeydown;
   /**
    * Handle onKeyup event
-   * @param {KeyboardEvent} event keyboard event
-   * @returns {void}
+   * @param event - keyboard event
    */
   private handleKeyup;
   /**
    * Check if props are well configured on init
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render component
-   * @returns {HTMLElement} html element
+   * @returns html element
    */
   render(): HTMLElement;
 }

package/dist/types/components/atoms/mg-card/mg-card.d.ts

@@ -11,24 +11,21 @@ export declare class MgCard {
    *************/
   /**
    * Define variant prop
-   * Default: undefined
    */
   variant: undefined | VariantType;
   validateVariant(newValue: MgCard['variant'], oldValue?: MgCard['variant']): void;
   /**
    * Define variantStyle prop
-   * Default: undefined
    */
   variantStyle: undefined | VariantStyleType;
   validateVariantStyle(newValue: MgCard['variantStyle'], oldValue?: MgCard['variantStyle']): void;
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Methode to set default varianStyle props
    * needeed has stencil doesn't know that props is mutated when updated in prop watcher
-   * @returns {void}
    */
   private setDefaultVariantStyle;
   /*************
@@ -36,12 +33,11 @@ export declare class MgCard {
    *************/
   /**
    * Check if props are well configured on init
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/atoms/mg-character-left/mg-character-left.d.ts

@@ -29,12 +29,11 @@ export declare class MgCharacterLeft {
    *************/
   /**
    * Check if props are well configured on init
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render component
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/atoms/mg-divider/mg-divider.d.ts

@@ -8,7 +8,7 @@ export declare class MgDivider {
   size: 'regular' | 'full';
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/atoms/mg-icon/mg-icon.d.ts

@@ -33,26 +33,24 @@ export declare class MgIcon {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * getIcon
-   * @returns {HTMLElement} icon html
+   * @returns icon html
    */
   private getIcon;
   /**
    * Method to set default varianStyle props
    * needeed has stencil doesn't know that props is mutated when updated in prop watcher
-   * @returns {void}
    */
   private setDefaultVariantStyle;
   /**
    * Check if props are well configured on init
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render component
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/atoms/mg-input-title/mg-input-title.d.ts

@@ -22,12 +22,11 @@ export declare class MgInputTitle {
    *************/
   /**
    * Init tag name
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML element
    */
   render(): HTMLElement;
 }

package/dist/types/components/atoms/mg-tag/mg-tag.d.ts

@@ -31,14 +31,13 @@ export declare class MgTag {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /*************
    * Methods *
    *************/
   /**
    * Validate the given textContent
-   * @param {string} textContent html element textContent property
-   * @returns {void}
+   * @param textContent - html element textContent property
    */
   private validateTextContent;
   /*************
@@ -46,12 +45,11 @@ export declare class MgTag {
    *************/
   /**
    * Check if props are well configured on init
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/atoms/mg-tooltip/mg-tooltip.d.ts

@@ -40,56 +40,48 @@ export declare class MgTooltip {
   disabled: boolean;
   /**
    * Show tooltip
-   * @returns {void}
    */
   private show;
   /**
    * Hide tooltip
-   * @returns {void}
    */
   private hide;
   /**
    * Check if clicked outside of component and hidde tooltip
-   * @param {MouseEvent} event mouse event
-   * @returns {void}
+   * @param event - mouse event
    */
   private clickOutside;
   /**
    * Check if 'Escape' key is pressed of component and hidde tooltip
-   * @param {KeyboardEvent} event keyboard event
-   * @returns {void}
+   * @param event - keyboard event
    */
   private pressEscape;
   /**
    * Method to set display prop
-   * @param {boolean} newValue display prop new value
-   * @param {boolean} condition additionnal condition to apply display prop newValue
-   * @returns {void}
+   * @param newValue - display prop new value
+   * @param condition - additionnal condition to apply display prop newValue
    */
   private setDisplay;
   /**
    * Action for tooltip element and tooltiped element mouse listener
-   * @param {Guard} elementGuard tooltip element guard
-   * @param {boolean} isMouseenter mouseenter validation
-   * @param {Guard} conditionalGuard guard condition
-   * @returns {void}
+   * @param elementGuard -  tooltip element guard
+   * @param isMouseenter - mouseenter validation
+   * @param conditionalGuard - guard condition
    */
   private tooltipMouseListenerAction;
   /**
    * Method to reset guard value
-   * @returns {void}
    */
   private resetGuard;
   /**
    * Update slot content when it is a mg-button
-   * @param {HTMLMgButtonElement} mgButton slotted mg-button
-   * @returns {void}
+   * @param mgButton - slotted mg-button
    */
   private setMgButtonWrapper;
   /**
    * Init tooltip
-   * @param {HTMLElement} slotElement slotted element
-   * @param {HTMLElement} interactiveElement interactive element
+   * @param slotElement - slotted element
+   * @param interactiveElement - interactive element
    */
   private initTooltip;
   /*************
@@ -97,19 +89,17 @@ export declare class MgTooltip {
    *************/
   /**
    * set variables
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Get slotted element
    * Check if it already contain an interactive element, if not we need to add a tabIndex attribute
    * We need to attach the focused element to the tooltip (aria-describedby)
-   * @returns {void}
    */
   componentDidLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/molecules/inputs/MgInput.conf.d.ts

@@ -1,7 +1,8 @@
 /**
  * Possible input width
  */
-export type Width = 2 | 4 | 16 | 'full';
+export declare const widths: readonly [2, 4, 16, "full"];
+export type Width = (typeof widths)[number];
 /**
  * Possible Input types
  */

package/dist/types/components/molecules/inputs/MgInput.d.ts

@@ -6,7 +6,7 @@ import { ClassList } from '../../../utils/components.utils';
  */
 interface MgInputProps {
   identifier: string;
-  classList: ClassList;
+  classCollection: ClassList;
   label: string;
   labelOnTop: boolean;
   labelHide: boolean;
@@ -24,10 +24,10 @@ interface MgInputProps {
 }
 /**
  * Get input template
- * @param {MgInputProps} props MgInput Interface Props
- * @param {VNode[]} children Represent scoped elements
- * @param {FunctionalUtilities} utils Stencil.js utils
- * @returns {VNode[]} input template
+ * @param props - MgInput Interface Props
+ * @param children - Represent scoped elements
+ * @param utils - Stencil.js utils
+ * @returns input template
  */
 export declare const MgInput: FunctionalComponent<MgInputProps>;
 export {};

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

@@ -79,7 +79,7 @@ export declare class MgInputCheckbox {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Error message to display
    */
@@ -98,12 +98,11 @@ export declare class MgInputCheckbox {
   inputValid: EventEmitter<MgInputCheckbox['valid']>;
   /**
    * Public method to display errors
-   * @returns {Promise<void>}
    */
   displayError(): Promise<void>;
   /**
    * Handle input event
-   * @param {InputEvent} event input event
+   * @param event - input event
    */
   private handleInput;
   /**
@@ -112,7 +111,7 @@ export declare class MgInputCheckbox {
   private handleBlur;
   /**
    * get invalid element
-   * @returns {HTMLInputElement} element
+   * @returns element
    */
   private getInvalidElement;
   /**
@@ -128,12 +127,12 @@ export declare class MgInputCheckbox {
    *************/
   /**
    * Check if component props are well configured on init
-   * @returns {ReturnType<typeof setTimeout>} timeout
+   * @returns timeout
    */
   componentWillLoad(): ReturnType<typeof setTimeout>;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

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

@@ -84,7 +84,7 @@ export declare class MgInputDate {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Error message to display
    */
@@ -99,7 +99,6 @@ export declare class MgInputDate {
   inputValid: EventEmitter<boolean>;
   /**
    * Public method to display errors
-   * @returns {Promise<void>}
    */
   displayError(): Promise<void>;
   /**
@@ -116,12 +115,11 @@ export declare class MgInputDate {
   private checkValidity;
   /**
    * get input error code
-   * @returns {null | InputError} error code
+   * @returns error code
    */
   private getInputError;
   /**
    * Check input errors
-   * @returns {void}
    */
   private setErrorMessage;
   /*************
@@ -129,12 +127,12 @@ export declare class MgInputDate {
    *************/
   /**
    * Check if component props are well configured on init
-   * @returns {ReturnType<typeof setTimeout>} timeout
+   * @returns timeout
    */
   componentWillLoad(): ReturnType<typeof setTimeout>;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

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

@@ -115,7 +115,7 @@ export declare class MgInputNumeric {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Error message to display
    */
@@ -134,54 +134,47 @@ export declare class MgInputNumeric {
   inputValid: EventEmitter<boolean>;
   /**
    * Public method to display errors
-   * @returns {Promise<void>}
    */
   displayError(): Promise<void>;
   /**
    * Displayed value in input
    * Change on focus/blur
-   * @returns {MgInputNumeric['value'] | MgInputNumeric['readonlyValue']} display value
+   * @returns display value
    */
   private displayValue;
   /**
    * Handle input event
-   * @returns {void}
    */
   private handleInput;
   /**
    * Handle focus event
-   * @returns {void}
    */
   private handleFocus;
   /**
    * Handle blur event
-   * @returns {void}
    */
   private handleBlur;
   /**
    * Check if input is valid
-   * @returns {void}
    */
   private checkValidity;
   /**
    * Set input error message
-   * @returns {void}
    */
   private setErrorMessage;
   /**
    * Get input error code
-   * @returns {null | InputError} error code
+   * @returns error code
    */
   private getInputError;
   /**
    * Format value based on type
-   * @param {number} value value to format
-   * @returns {string} formated local value
+   * @param value - value to format
+   * @returns formated local value
    */
   private formatValue;
   /**
    * Validate append slot
-   * @returns {void}
    */
   private validateAppendSlot;
   /*************
@@ -189,12 +182,12 @@ export declare class MgInputNumeric {
    *************/
   /**
    * Check if component props are well configured on init
-   * @returns {ReturnType<typeof setTimeout>} timeout
+   * @returns timeout
    */
   componentWillLoad(): ReturnType<typeof setTimeout>;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

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

@@ -82,7 +82,7 @@ export declare class MgInputPassword {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Error message to display
    */
@@ -97,7 +97,6 @@ export declare class MgInputPassword {
   inputValid: EventEmitter<boolean>;
   /**
    * Public method to display errors
-   * @returns {Promise<void>}
    */
   displayError(): Promise<void>;
   /**
@@ -121,12 +120,12 @@ export declare class MgInputPassword {
    *************/
   /**
    * Check if component props are well configured on init
-   * @returns {ReturnType<typeof setTimeout>} timeout
+   * @returns timeout
    */
   componentWillLoad(): ReturnType<typeof setTimeout>;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

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

@@ -83,7 +83,7 @@ export declare class MgInputRadio {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Error message to display
    */
@@ -102,33 +102,28 @@ export declare class MgInputRadio {
   inputValid: EventEmitter<boolean>;
   /**
    * Public method to display errors
-   * @returns {Promise<void>}
    */
   displayError(): Promise<void>;
   /**
    * Handle input event
-   * @param {event} event input event
-   * @returns {void}
+   * @param event - input event
    */
   private handleInput;
   /**
    * Handle blur event
-   * @returns {void}
    */
   private handleBlur;
   /**
    * Check if input is valid
-   * @returns {void}
    */
   private checkValidity;
   /**
    * Set input error message
-   * @returns {void}
    */
   private setErrorMessage;
   /**
    * get invalid element
-   * @returns {HTMLInputElement} element
+   * @returns element
    */
   private getInvalidElement;
   /*************
@@ -136,12 +131,12 @@ export declare class MgInputRadio {
    *************/
   /**
    * Check if component props are well configured on init
-   * @returns {ReturnType<typeof setTimeout>} timeout
+   * @returns timeout
    */
   componentWillLoad(): ReturnType<typeof setTimeout>;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

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

@@ -1,6 +1,6 @@
 /**
  * type SelectOption
- * use to match select>option attributes
+ * use to match select \> option attributes
  */
 export type SelectOption = {
   title: string;
@@ -10,7 +10,7 @@ export type SelectOption = {
 };
 /**
  * type OptGroup
- * use to match select>optgroup attributes
+ * use to match select \> optgroup attributes
  */
 export type OptGroup = {
   group: string;

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

@@ -96,7 +96,7 @@ export declare class MgInputSelect {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Error message to display
    */
@@ -123,29 +123,25 @@ export declare class MgInputSelect {
   inputValid: EventEmitter<boolean>;
   /**
    * Public method to display errors
-   * @returns {Promise<void>}
    */
   displayError(): Promise<void>;
   /**
    * Handle input event
-   * @returns {void}
    */
   private handleInput;
   /**
    * Method to compare item.title with input.value
-   * @param {SelectOption} item item to compare with
-   * @returns {boolean} truthy if input.value is an item
+   * @param item - item to compare with
+   * @returns truthy if input.value is an item
    */
   private isInputValue;
   /**
    * value props setter
-   * @param {MgInputSelect['value']} newValue value to update with
-   * @returns {void}
+   * @param newValue - value to update with
    */
   private setValue;
   /**
    * Update value from input.value
-   * @returns {void}
    */
   private updateValue;
   /**
@@ -154,7 +150,7 @@ export declare class MgInputSelect {
   private handleBlur;
   /**
    * Input value is disabled
-   * @returns {boolean} truthy if input value is disabled
+   * @returns truthy if input value is disabled
    */
   private isDisabledValue;
   /**
@@ -170,18 +166,18 @@ export declare class MgInputSelect {
    *************/
   /**
    * Check if component props are well configured on init
-   * @returns {ReturnType<typeof setTimeout>} timeout
+   * @returns timeout
    */
   componentWillLoad(): ReturnType<typeof setTimeout>;
   /**
    * Render option
-   * @param {SelectOption} option to render
-   * @returns {HTMLElement} render option
+   * @param option - to render
+   * @returns render option
    */
   private renderOption;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }