@mgdis/mg-components 5.10.0 → 5.11.0

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;
 }

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

@@ -111,7 +111,7 @@ export declare class MgInputText {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Error message to display
    */
@@ -126,47 +126,38 @@ export declare class MgInputText {
   inputValid: EventEmitter<boolean>;
   /**
    * Public method to play input focus
-   * @returns {Promise<void>}
    */
   setFocus(): Promise<void>;
   /**
    * Public method to display errors
-   * @returns {Promise<void>}
    */
   displayError(): Promise<void>;
   /**
    * 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;
   /**
    * Validate pattern configuration
-   * @returns {void}
    */
   private validatePattern;
   /**
    * Validate append slot
-   * @returns {void}
    */
   private validateAppendSlot;
   /*************
@@ -174,12 +165,12 @@ export declare class MgInputText {
    *************/
   /**
    * 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-textarea/mg-input-textarea.d.ts

@@ -110,7 +110,7 @@ export declare class MgInputTextarea {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Error message to display
    */
@@ -125,7 +125,6 @@ export declare class MgInputTextarea {
   inputValid: EventEmitter<boolean>;
   /**
    * Public method to display errors
-   * @returns {Promise<void>}
    */
   displayError(): Promise<void>;
   /**
@@ -143,7 +142,7 @@ export declare class MgInputTextarea {
   /**
    * Get pattern validity
    * Pattern is not defined on textarea field: https://developer.mozilla.org/fr/docs/Web/HTML/Element/Textarea
-   * @returns {boolean} is pattern valid
+   * @returns is pattern valid
    */
   private getPatternValidity;
   /**
@@ -163,12 +162,12 @@ export declare class MgInputTextarea {
    *************/
   /**
    * 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-toggle/mg-input-toggle.d.ts

@@ -24,7 +24,6 @@ export declare class MgInputToggle {
   handleValue(newValue: any): void;
   /**
    * Items are the possible options to select
-   * @returns {void}
    */
   items: string[] | ToggleValue[];
   validateItems(newValue: string[] | ToggleValue[]): void;
@@ -80,7 +79,7 @@ export declare class MgInputToggle {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Formated items for display
    */
@@ -100,17 +99,14 @@ export declare class MgInputToggle {
   inputValid: EventEmitter<boolean>;
   /**
    * Change checked value
-   * @returns {void}
    */
   private toggleChecked;
   /**
    * Slots validation
-   * @returns {void}
    */
   private validateSlots;
   /**
    * set checked state
-   * @returns {void}
    */
   private setChecked;
   /*************
@@ -122,7 +118,7 @@ export declare class MgInputToggle {
   componentWillLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/molecules/menu/mg-menu/mg-menu.d.ts

@@ -21,7 +21,7 @@ export declare class MgMenu {
   label: string;
   validateLabel(newValue: MgMenu['label']): void;
   /**
-   * Component display direction. Default: "horizontal"
+   * Component display direction.
    */
   direction: Direction;
   validateDirection(newValue: MgMenu['direction']): void;
@@ -33,7 +33,6 @@ export declare class MgMenu {
   validateItemMore(newValue: MgMenu['itemmore']): void;
   /**
    * Define mg-menu size
-   * Default: 'regular'
    */
   size: MenuSizeType;
   validateSize(newValue: MgMenu['size']): void;
@@ -46,41 +45,36 @@ export declare class MgMenu {
    *************/
   /**
    * Close matching menu-item
-   * @param {HTMLElement} item menu-item to close
-   * @param {boolean} condition addionnal condition
-   * @returns {void}
+   * @param item - menu-item to close
+   * @param condition - addionnal condition
    */
   private closeMenuItem;
   /**
    * get mg-item-more element
-   * @returns {HTMLMgItemMoreElement} mg-item-more element
+   * @returns mg-item-more element
    */
   private getItemMore;
   /**
-   * get mg-item-more >>> mg-menu-item element
-   * @returns {HTMLMgMenuItemElement} mg-item-more >>> mg-menu-item element
+   * get mg-item-more child mg-menu-item element
+   * @returns mg-menu-item element
    */
   private getItemMoreMenuItem;
   /**
    * Set item listend
-   * @param {HTMLMgMenuItemElement} item mg-menu-item element
-   * @param {MgMenu['focusedMenuItem']} index number
-   * @returns {void}
+   * @param item - mg-menu-item element
+   * @param index - number
    */
   private setItemListener;
   /**
    * Store menu-items on component init and add listeners
-   * @returns {void}
    */
   private initMenuItemsListeners;
   /**
    * Handle item-loaded event on mg-item-more element
-   * @returns {void}
    */
   private handleItemLoaded;
   /**
    * render mg-item-more
-   * @returns {void}
    */
   private renderMgItemMore;
   /*************
@@ -88,22 +82,20 @@ export declare class MgMenu {
    *************/
   /**
    * Validate props
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Check if component slots configuration
-   * @returns {ReturnType<typeof setTimeout>} timeout
+   * @returns timeout
    */
   componentDidLoad(): ReturnType<typeof setTimeout>;
   /**
    * Add listeners to items
-   * @returns {void}
    */
   componentDidRender(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/molecules/menu/mg-menu-item/mg-menu-item.d.ts

@@ -22,7 +22,6 @@ export declare class MgMenuItem {
    ************/
   /**
    * Identifier is used to control mg-popover
-   * Default: createID('mg-menu-item');
    */
   identifier: string;
   /**
@@ -31,12 +30,12 @@ export declare class MgMenuItem {
    */
   href: string;
   /**
-   * Define menu-item status. Default: "visible"
+   * Define menu-item status.
    */
   status: Status;
   validateStatus(newValue: MgMenuItem['status'], oldValue?: MgMenuItem['status']): void;
   /**
-   * Define menu-item content expanded. Default: false.
+   * Define menu-item content expanded.
    */
   expanded: boolean;
   validateExpanded(newValue: MgMenuItem['expanded']): void;
@@ -55,7 +54,7 @@ export declare class MgMenuItem {
    * States *
    *********/
   /**
-   * Define menu-item size. Default: "regular".
+   * Define menu-item size.
    */
   size: MenuSizeType;
   validateSize(newValue: MgMenuItem['size'], oldValue?: MgMenuItem['size']): void;
@@ -77,7 +76,7 @@ export declare class MgMenuItem {
    */
   isItemMore: boolean;
   /**
-   * Does component have children. Default: false.
+   * Does component have children.
    */
   hasChildren: boolean;
   validateHasChildren(newValue: boolean): void;
@@ -90,64 +89,58 @@ export declare class MgMenuItem {
    **********/
   /**
    * Toggle expanded prop value
-   * @returns {void}
    */
   private toggleExpanded;
   /**
    * Does an Element have given Status
-   * @param {HTMLMgMenuItemElement} mgMenuItemElement to parse
-   * @param {MgMenuItem['status']} status to check
-   * @returns {boolean} true if element with status is found
+   * @param mgMenuItemElement - to parse
+   * @param status - to check
+   * @returns true if element with status is found
    */
   private hasStatus;
   /**
    * Is component contextual direction match the given direction
-   * @param {MgMenuItem['direction']} direction in parent menu
-   * @param {MgMenuItem['direction']} compareWith direction to compare with. Default: `this.direction`
-   * @returns {boolean} true is direction match the direction propertie
+   * @param direction - in parent menu
+   * @param compareWith - direction to compare with. Default: `this.direction`
+   * @returns true is direction match the direction propertie
    */
   private isDirection;
   /**
    * Update displayNotificationBadge
    * current component notification badge have priority over the slot badge when submenu contain badge
-   * @returns {void} update displayNotificationBadge value
    */
   private updateDisplayNotificationBadge;
   /**
    * Method to control if one of component children have active status
-   * @returns {boolean} truthy if component has active child
+   * @returns truthy if component has active child
    */
   private hasActiveChild;
   /**
    * Validate slots
-   * @param {boolean} guard prevent action whith guard. Default: false.
-   * @returns {void}
+   * @param guard - prevent action whith guard. Default: false.
    */
   private validateSlot;
   /**
    * Update status
-   * @param {Status[]} guard status to exclude from process in addition to [Status.HIDDEN, Status.DISABLED] . Default: [].
-   * @returns {void}
+   * @param guard - status to exclude from process in addition to [Status.HIDDEN, Status.DISABLED] . Default: [].
    */
   private updateStatus;
   /**
    * Init event-listeners
-   * @returns {void}
    */
   private initListeners;
   /**
    * Get mg-popover identifier
-   * @returns {MgPopover['identifier']} generated mg-popover identifier
+   * @returns generated mg-popover identifier
    */
   private getPopoverIdentifier;
   /**
    * Render popover clickoutside guard for content slot
-   * @returns {void}
    */
   private updatePopoverGuard;
   /**
    * Condition to know if component should display a mg-popover
-   * @returns {boolean} truthy if component display popover
+   * @returns truthy if component display popover
    */
   private displayPopover;
   /************
@@ -155,14 +148,12 @@ export declare class MgMenuItem {
    ************/
   /**
    * Handle interacrtive element click
-   * @param {MouseEvent} event click on element
-   * @returns {void}
+   * @param event - click on element
    */
   private handleElementCLick;
   /**
    * Handle popover element display-change event
-   * @param {CustomEvent} event popover display event
-   * @returns {void}
+   * @param event - popover display event
    */
   private handlePopoverDisplay;
   /*************
@@ -170,27 +161,26 @@ export declare class MgMenuItem {
    *************/
   /**
    * Validate props
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Check if component slots configuration
-   * @returns {ReturnType<typeof setTimeout>} timeout
+   * @returns timeout
    */
   componentDidLoad(): ReturnType<typeof setTimeout>;
   /**
    * Render ineractive element
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   private renderInteractiveElement;
   /**
    * Render slot
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   private renderSlot;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/molecules/mg-action-more/mg-action-more.d.ts

@@ -15,13 +15,11 @@ export declare class MgActionMore {
   element: HTMLMgActionMoreElement;
   /**
    * Define displaied icon
-   * Default: {icon: 'ellipsis'}
    */
   icon: MgActionMoreIconType;
   validateIcon(newValue: MgActionMore['icon']): void;
   /**
    * Define button properties
-   * Default: {variant: 'flat', isIcon: true}.
    */
   button: MgActionMoreButtonType;
   validateButton(newValue: MgActionMore['button']): void;
@@ -37,7 +35,6 @@ export declare class MgActionMore {
   validateDisplayChevron(newValue: MgActionMore['displayChevron']): void;
   /**
    * Menu expanded state
-   * Default: false.
    */
   expanded: boolean;
   /************
@@ -45,19 +42,16 @@ export declare class MgActionMore {
    ***********/
   /**
    * Toogle expanded props
-   * @returns {void}
    */
   private toggleExpanded;
   /**
    * Button click handler
-   * @returns {void}
    */
   private handleButton;
   /**
    * Item click handler
-   * @param {MouseEvent} event click event
-   * @param {MgActionMoreItemType['mouseEventHandler']} customHandler item['mouseEventHandler']
-   * @returns {void}
+   * @param event - click event
+   * @param customHandler - item['mouseEventHandler']
    */
   private handleItemClick;
   /*************
@@ -65,12 +59,11 @@ export declare class MgActionMore {
    *************/
   /**
    * Validate props
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/molecules/mg-details/mg-details.d.ts

@@ -31,7 +31,6 @@ export declare class MgDetails {
   expandedChange: EventEmitter<boolean>;
   /**
    * Handle details toggle
-   * @returns {void}
    */
   private handleToggle;
   /*************
@@ -39,12 +38,11 @@ export declare class MgDetails {
    *************/
   /**
    * Check if component props are well configured on init
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/molecules/mg-form/mg-form.d.ts

@@ -46,7 +46,7 @@ export declare class MgForm {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Required message
    */
@@ -62,29 +62,23 @@ export declare class MgForm {
   formSubmit: EventEmitter<boolean>;
   /**
    * Public method to display errors
-   * @returns {Promise<void>}
    */
   displayError(): Promise<void>;
   /**
    * Define required message based on mg-inputs required elements
-   * Also
-   * @returns {void}
    */
   private setRequiredMessage;
   /**
    * Check if form is valid
-   * @returns {void}
    */
   private checkValidity;
   /**
    * Handle Form Submit
-   * @param {SubmitEvent} event submit event
-   * @returns {void}
+   * @param event - submit event
    */
   private handleFormSubmit;
   /**
    * Set mgInputs
-   * @returns {void}
    */
   private setMgInputs;
   /*************
@@ -92,17 +86,15 @@ export declare class MgForm {
    *************/
   /**
    * Check if component props are well configured on init
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Add slot listeners
-   * @returns {void}
    */
   componentDidLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }