@mgdis/mg-components 5.10.0 → 5.10.1

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,30 +49,26 @@ 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;
   /*************
@@ -80,17 +76,15 @@ export declare class MgPopover {
    *************/
   /**
    * 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;
 }

package/dist/types/components.d.ts

@@ -26,7 +26,7 @@ import { TagVariantType } from "./components/atoms/mg-tag/mg-tag.conf";
 export namespace Components {
     interface MgActionMore {
         /**
-          * Define button properties Default: {variant: 'flat', isIcon: true}.
+          * Define button properties
          */
         "button": MgActionMoreButtonType;
         /**
@@ -34,7 +34,7 @@ export namespace Components {
          */
         "displayChevron": boolean;
         /**
-          * Define displaied icon Default: {icon: 'ellipsis'}
+          * Define displaied icon
          */
         "icon": MgActionMoreIconType;
         /**
@@ -100,11 +100,11 @@ export namespace Components {
     }
     interface MgCard {
         /**
-          * Define variant prop Default: undefined
+          * Define variant prop
          */
         "variant": undefined | VariantType1;
         /**
-          * Define variantStyle prop Default: undefined
+          * Define variantStyle prop
          */
         "variantStyle": undefined | VariantStyleType;
     }
@@ -153,7 +153,6 @@ export namespace Components {
         "disabled": boolean;
         /**
           * Public method to display errors
-          * @returns
          */
         "displayError": () => Promise<void>;
         /**
@@ -216,7 +215,6 @@ export namespace Components {
         "disabled": boolean;
         /**
           * Public method to display errors
-          * @returns
          */
         "displayError": () => Promise<void>;
         /**
@@ -279,7 +277,6 @@ export namespace Components {
         "disabled": boolean;
         /**
           * Public method to display errors
-          * @returns
          */
         "displayError": () => Promise<void>;
         /**
@@ -354,7 +351,6 @@ export namespace Components {
         "disabled": boolean;
         /**
           * Public method to display errors
-          * @returns
          */
         "displayError": () => Promise<void>;
         /**
@@ -437,7 +433,6 @@ export namespace Components {
         "disabled": boolean;
         /**
           * Public method to display errors
-          * @returns
          */
         "displayError": () => Promise<void>;
         /**
@@ -504,7 +499,6 @@ export namespace Components {
         "disabled": boolean;
         /**
           * Public method to display errors
-          * @returns
          */
         "displayError": () => Promise<void>;
         /**
@@ -571,7 +565,6 @@ export namespace Components {
         "disabled": boolean;
         /**
           * Public method to display errors
-          * @returns
          */
         "displayError": () => Promise<void>;
         /**
@@ -654,7 +647,6 @@ export namespace Components {
         "displayCharacterLeft": boolean;
         /**
           * Public method to display errors
-          * @returns
          */
         "displayError": () => Promise<void>;
         /**
@@ -719,7 +711,6 @@ export namespace Components {
         "required": boolean;
         /**
           * Public method to play input focus
-          * @returns
          */
         "setFocus": () => Promise<void>;
         /**
@@ -750,7 +741,6 @@ export namespace Components {
         "displayCharacterLeft": boolean;
         /**
           * Public method to display errors
-          * @returns
          */
         "displayError": () => Promise<void>;
         /**
@@ -867,7 +857,6 @@ export namespace Components {
         "isOnOff": boolean;
         /**
           * Items are the possible options to select
-          * @returns
          */
         "items": string[] | ToggleValue[];
         /**
@@ -901,7 +890,7 @@ export namespace Components {
     }
     interface MgItemMore {
         /**
-          * Define icon Default: {icon: 'ellipsis-vertical'}
+          * Define icon
          */
         "icon": IconType;
         /**
@@ -909,13 +898,13 @@ export namespace Components {
          */
         "size": SizeType;
         /**
-          * Define slot label element Default: {display: false}
+          * Define slot label element
          */
         "slotlabel": SlotLabelType;
     }
     interface MgMenu {
         /**
-          * Component display direction. Default: "horizontal"
+          * Component display direction.
          */
         "direction": Direction;
         /**
@@ -927,13 +916,13 @@ export namespace Components {
          */
         "label": string;
         /**
-          * Define mg-menu size Default: 'regular'
+          * Define mg-menu size
          */
         "size": MenuSizeType;
     }
     interface MgMenuItem {
         /**
-          * Define menu-item content expanded. Default: false.
+          * Define menu-item content expanded.
          */
         "expanded": boolean;
         /**
@@ -941,11 +930,11 @@ export namespace Components {
          */
         "href": string;
         /**
-          * Identifier is used to control mg-popover Default: createID('mg-menu-item');
+          * Identifier is used to control mg-popover
          */
         "identifier": string;
         /**
-          * Define menu-item status. Default: "visible"
+          * Define menu-item status.
          */
         "status": Status;
     }
@@ -1443,7 +1432,7 @@ declare global {
 declare namespace LocalJSX {
     interface MgActionMore {
         /**
-          * Define button properties Default: {variant: 'flat', isIcon: true}.
+          * Define button properties
          */
         "button"?: MgActionMoreButtonType;
         /**
@@ -1451,7 +1440,7 @@ declare namespace LocalJSX {
          */
         "displayChevron"?: boolean;
         /**
-          * Define displaied icon Default: {icon: 'ellipsis'}
+          * Define displaied icon
          */
         "icon"?: MgActionMoreIconType;
         /**
@@ -1521,11 +1510,11 @@ declare namespace LocalJSX {
     }
     interface MgCard {
         /**
-          * Define variant prop Default: undefined
+          * Define variant prop
          */
         "variant"?: undefined | VariantType1;
         /**
-          * Define variantStyle prop Default: undefined
+          * Define variantStyle prop
          */
         "variantStyle"?: undefined | VariantStyleType;
     }
@@ -2314,7 +2303,6 @@ declare namespace LocalJSX {
         "isOnOff"?: boolean;
         /**
           * Items are the possible options to select
-          * @returns
          */
         "items": string[] | ToggleValue[];
         /**
@@ -2356,7 +2344,7 @@ declare namespace LocalJSX {
     }
     interface MgItemMore {
         /**
-          * Define icon Default: {icon: 'ellipsis-vertical'}
+          * Define icon
          */
         "icon"?: IconType;
         /**
@@ -2364,13 +2352,13 @@ declare namespace LocalJSX {
          */
         "size"?: SizeType;
         /**
-          * Define slot label element Default: {display: false}
+          * Define slot label element
          */
         "slotlabel"?: SlotLabelType;
     }
     interface MgMenu {
         /**
-          * Component display direction. Default: "horizontal"
+          * Component display direction.
          */
         "direction"?: Direction;
         /**
@@ -2382,13 +2370,13 @@ declare namespace LocalJSX {
          */
         "label": string;
         /**
-          * Define mg-menu size Default: 'regular'
+          * Define mg-menu size
          */
         "size"?: MenuSizeType;
     }
     interface MgMenuItem {
         /**
-          * Define menu-item content expanded. Default: false.
+          * Define menu-item content expanded.
          */
         "expanded"?: boolean;
         /**
@@ -2396,7 +2384,7 @@ declare namespace LocalJSX {
          */
         "href"?: string;
         /**
-          * Identifier is used to control mg-popover Default: createID('mg-menu-item');
+          * Identifier is used to control mg-popover
          */
         "identifier"?: string;
         /**
@@ -2408,7 +2396,7 @@ declare namespace LocalJSX {
          */
         "onStatus-change"?: (event: MgMenuItemCustomEvent<MgMenuItem['status']>) => void;
         /**
-          * Define menu-item status. Default: "visible"
+          * Define menu-item status.
          */
         "status"?: Status;
     }

package/dist/types/locales/index.d.ts

@@ -126,8 +126,8 @@ declare const messages: {
 };
 /**
  * Get Intl object
- * @param {HTMLElement} element element we need to get the language
- * @returns {{ locale: string; messages: Record<string, unknown> }} messages object
+ * @param element - element we need to get the language
+ * @returns messages object
  */
 export declare const initLocales: (element: HTMLElement) => {
   locale: string;

package/dist/types/utils/behaviors.utils.d.ts

@@ -15,7 +15,6 @@ export declare class OverflowBehavior {
    **********/
   /**
    * Disconnect ResizeObserver
-   * @returns {void}
    */
   disconnect: () => void;
   /************
@@ -23,53 +22,48 @@ export declare class OverflowBehavior {
    ************/
   /**
    * run overflow behavior
-   * @param {number} width width of the container. Optional.
-   * @returns {void}
+   * @param width - width of the container. Optional.
    */
   private run;
   /**
    * Get interactive children filtred by authorized nodeName ['MG-MENU-ITEM', 'MG-BUTTON']
-   * @param {Element} element element to parse
-   * @returns {Element[]} children
+   * @param element - element to parse
+   * @returns children
    */
   private getInteractiveItems;
   /**
    * Update displayed items in container from a given available space
-   * @param {number} availableWidth available width in container to display child items
-   * @returns {void}
+   * @param availableWidth - available width in container to display child items
    */
   private updateDisplayedItems;
   /**
    * Utility method to know if item overflow partialy or totaly in the container
-   * @param {number} cumulateWidth previous sibling elements cumulate width + item width
-   * @param {HTMLElement} item item HTML element
-   * @param {number} availableWidth container available width
-   * @returns {boolean} truthy if element is overflow
+   * @param cumulateWidth - previous sibling elements cumulate width + item width
+   * @param item - item HTML element
+   * @param availableWidth - container available width
+   * @returns truthy if element is overflow
    */
   private isOverflowElement;
   /**
    * Utility method to know if a given element is the 'MORE' element
-   * @param {Element} element element to match with 'MORE' element
-   * @returns {boolean} truthy if element is the 'MORE' element
+   * @param element - element to match with 'MORE' element
+   * @returns truthy if element is the 'MORE' element
    */
   private isMoreElement;
   /**
    * Toggle display item element
-   * @param {HTMLElement} item item to control
-   * @param {boolean} isHidden is item hidden
-   * @returns {void}
+   * @param item - item to control
+   * @param isHidden - is item hidden
    */
   private toggleItem;
   /**
    * Toggle element's hidde attribute
-   * @param {Element} element element to toggle
-   * @param {boolean} isHidden element is hidden
-   * @returns {void}
+   * @param element - element to toggle
+   * @param isHidden - element is hidden
    */
   private toggleElement;
   /**
    * Remove hidden attributes on all items
-   * @returns {void}
    */
   private restoreItems;
 }