@mgdis/mg-components 5.10.0 → 5.11.0

package/dist/types/components/molecules/mg-illustrated-message/mg-illustrated-message.d.ts

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

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

@@ -16,13 +16,11 @@ export declare class MgItemMore {
   element: HTMLMgItemMoreElement;
   /**
    * Define icon
-   * Default: {icon: 'ellipsis-vertical'}
    */
   icon: IconType;
   validateIcon(newValue: MgItemMore['icon']): void;
   /**
    * Define slot label element
-   * Default: {display: false}
    */
   slotlabel: SlotLabelType;
   validateSlotLabel(newValue: MgItemMore['slotlabel']): void;
@@ -40,7 +38,7 @@ export declare class MgItemMore {
    ***********/
   /**
    * render mg-item-more overflow element
-   * @returns {HTMLMgItemMoreElement} mg-item-more element
+   * @returns mg-item-more element
    */
   private renderMgMenuItemOverflowElement;
   /*************
@@ -48,22 +46,19 @@ export declare class MgItemMore {
    *************/
   /**
    * Disconnect overflow ResizeObserver
-   * @returns {void} run overflow resize obeserver disconnexion
    */
   disconnectedCallback(): void;
   /**
    * Set variables and validate props
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Add overflow behavior
-   * @returns {void}
    */
   componentDidLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

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

@@ -48,7 +48,7 @@ export declare class MgMessage {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Define if component is using actions slot
    */
@@ -63,18 +63,15 @@ export declare class MgMessage {
   componentHide: EventEmitter<string>;
   /**
    * Set timer
-   * @returns {void}
    */
   private setTimer;
   /**
    * Clear timer
-   * @returns {void}
    */
   private clearTimer;
   /**
    * Event to add on element
-   * @param {MouseEvent | FocusEvent} event  event
-   * @returns {void}
+   * @param event - event
    */
   private timerEvents;
   /**
@@ -83,7 +80,7 @@ export declare class MgMessage {
   private handleClose;
   /**
    * Get icon corresponding to variant
-   * @returns {MgIcon['icon'] | undefined} icon
+   * @returns icon
    */
   private getIcon;
   /*************
@@ -95,7 +92,7 @@ export declare class MgMessage {
   componentWillLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

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

@@ -48,7 +48,7 @@ export declare class MgModal {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Emmited event when modal is diplayed
    */
@@ -59,8 +59,7 @@ export declare class MgModal {
   componentHide: EventEmitter<string>;
   /**
    * Handle 'escape' key down
-   * @param {KeyboardEvent} event keydown event
-   * @returns {void}
+   * @param event - keydown event
    */
   handleKeyDown(event: KeyboardEvent): void;
   private setFocus;
@@ -69,7 +68,6 @@ export declare class MgModal {
    *************/
   /**
    * Handle close button
-   * @returns {void}
    */
   private handleClose;
   /*************
@@ -77,17 +75,15 @@ export declare class MgModal {
    *************/
   /**
    * Check if component props are well configured on init
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Add observer on component to set focus when displayed
-   * @returns {void}
    */
   componentDidLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

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

@@ -41,8 +41,7 @@ export declare class MgPagination {
   currentPageChange: EventEmitter<number>;
   /**
    * Change current page from target
-   * @param {number} target target page
-   * @returns {void}
+   * @param target - target page
    */
   private goToPage;
   /************
@@ -50,15 +49,13 @@ export declare class MgPagination {
    ************/
   /**
    * select handler
-   * @param {InputEvent} event value change event
-   * @returns {void}
+   * @param event - value change event
    */
   private handleSelect;
   /**
    * Go to 'previous/next' page button handler
-   * @param {string} action navigation action
-   * @param {boolean} disabled button disable state
-   * @returns {void}
+   * @param action - navigation action
+   * @param disabled - button disable state
    */
   private handleGoToPage;
   /*************
@@ -66,12 +63,11 @@ export declare class MgPagination {
    *************/
   /**
    * 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/molecules/mg-panel/mg-panel.d.ts

@@ -48,7 +48,7 @@ export declare class MgPanel {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Title is in edition mode
    */
@@ -70,7 +70,6 @@ export declare class MgPanel {
    ************/
   /**
    * Toggle is editing state
-   * @returns {void}
    */
   private toggleIsEditing;
   /************
@@ -78,28 +77,23 @@ export declare class MgPanel {
    ************/
   /**
    * Collapse button click handler
-   * @returns {void}
    */
   private handleCollapseButton;
   /**
    * Edit button click handler
-   * @returns {void}
    */
   private handleEditButton;
   /**
    * Update title handler
-   * @param {CustomEvent<string>} event input value change event
-   * @returns {void}
+   * @param event - input value change event
    */
   private handleUpdateTitle;
   /**
    * Cancel edition button handler
-   * @returns {void}
    */
   private handleCancelEditButton;
   /**
    * Validate edition button handler
-   * @returns {void}
    */
   private handleValidateEditButton;
   /*************
@@ -107,23 +101,20 @@ export declare class MgPanel {
    *************/
   /**
    * Check if props are well configured on init
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Header left conditional render
-   * @typedef {HTMLElement} HTMLMgButtonElement
-   * @returns {HTMLMgButtonElement | HTMLElement | HTMLElement[]} header left element
+   * @returns header left element
    */
   private headerLeft;
   /**
    * Edit DOM after render
-   * @returns {void}
    */
   componentDidRender(): void;
   /**
    * Render component
-   * @returns {HTMLElement} html element
+   * @returns html element
    */
   render(): HTMLElement;
 }

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

@@ -49,48 +49,46 @@ export declare class MgPopover {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Emited event when display value change
    */
   displayChange: EventEmitter<boolean>;
   /**
    * Check if clicked outside of component
-   * @param {MouseEvent} event mouse event
-   * @returns {void}
+   * @param event - mouse event
    */
   private clickOutside;
   /**
    * Show popover
-   * @returns {void}
    */
   private show;
   /**
    * Hide popover
-   * @returns {void}
    */
   private hide;
   /**
    * Handle action for close button
-   * @returns {void}
    */
   private handleCloseButton;
   /*************
    * Lifecycle *
    *************/
+  /**
+   * update popper position after props change on component did update hook to benefit from render ended
+   */
+  componentDidUpdate(): void;
   /**
    * Check if component props are well configured on init
-   * @returns {void} timeout
    */
   componentWillLoad(): void;
   /**
    * Check if component props are well configured on init
-   * @returns {void}
    */
   componentDidLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }

package/dist/types/components/molecules/mg-skip-links/mg-skip-links.d.ts

@@ -26,8 +26,7 @@ export declare class MgSkipLinks {
    **********/
   /**
    * Handle link click and emit go-to-anchor event
-   * @param {MouseEvent} event mouse event
-   * @returns {void}
+   * @param event - mouse event
    */
   private handleLinkCLick;
   /*************
@@ -35,12 +34,11 @@ export declare class MgSkipLinks {
    *************/
   /**
    * 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/molecules/mg-tabs/mg-tabs.d.ts

@@ -50,56 +50,54 @@ export declare class MgTabs {
   /**
    * Component classes
    */
-  classList: ClassList;
+  classCollection: ClassList;
   /**
    * Emited event when active tab change
    */
   activeTabChange: EventEmitter<number>;
   /**
    * Method to know if given tab has the given status
-   * @param {TabItem} tab item tab key to set to ACTIVE status
-   * @param {Status} status status to valide
-   * @returns {boolean} status comparaison
+   * @param tab - item tab key to set to ACTIVE status
+   * @param status - status to valide
+   * @returns status comparaison
    */
   private tabHasStatus;
   /**
    * Method to get element id from index
-   * @param {string} element to get id
-   * @param {number} index to generate id
-   * @returns {string} generated element id
+   * @param element - to get id
+   * @param index - to generate id
+   * @returns generated element id
    */
   private getElementId;
   /**
    * Method to get tab item index
-   * @param {number} index to get
-   * @returns {number} index
+   * @param index - to get
+   * @returns index
    */
   private getTabItemIndex;
   /**
    * Method to get the active-tab value
-   * @returns {number} of the active-tab
+   * @returns of the active-tab
    */
   private getActiveTab;
   /**
    * Handle click events on tabs
-   * @param {MouseEvent} event mouse event
+   * @param event - mouse event
    */
   private handleClick;
   /**
    * get navigation button class from given status
-   * @param {Status} status button tab status
-   * @returns {string} button class/selector variant
+   * @param status - button tab status
+   * @returns button class/selector variant
    */
   private getNavigationButtonClass;
   /**
    * Handle keyboard event on tabs
-   * @param {MouseEvent} event mouse event
-   * @returns {void}
+   * @param event - mouse event
    */
   private handleKeydown;
   /**
    * Method to reset focus behavior
-   * @returns {void}
    */
   private resetFocus;
   /**
@@ -111,17 +109,15 @@ export declare class MgTabs {
    *************/
   /**
    * Check if component props are well configured on init
-   * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * add listners
-   * @returns {void}
    */
   componentDidLoad(): void;
   /**
    * Render
-   * @returns {HTMLElement} HTML Element
+   * @returns HTML Element
    */
   render(): HTMLElement;
 }