@mgdis/mg-components 5.9.1 → 5.10.0

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

@@ -46,7 +46,6 @@ export declare class MgMenu {
    *************/
   /**
    * Close matching menu-item
-   *
    * @param {HTMLElement} item menu-item to close
    * @param {boolean} condition addionnal condition
    * @returns {void}
@@ -54,19 +53,16 @@ export declare class MgMenu {
   private closeMenuItem;
   /**
    * get mg-item-more element
-   *
    * @returns {HTMLMgItemMoreElement} mg-item-more element
    */
   private getItemMore;
   /**
    * get mg-item-more >>> mg-menu-item element
-   *
    * @returns {HTMLMgMenuItemElement} mg-item-more >>> mg-menu-item element
    */
   private getItemMoreMenuItem;
   /**
    * Set item listend
-   *
    * @param {HTMLMgMenuItemElement} item mg-menu-item element
    * @param {MgMenu['focusedMenuItem']} index number
    * @returns {void}
@@ -74,19 +70,16 @@ export declare class MgMenu {
   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;
@@ -95,25 +88,21 @@ export declare class MgMenu {
    *************/
   /**
    * Validate props
-   *
    * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Check if component slots configuration
-   *
    * @returns {ReturnType<typeof setTimeout>} timeout
    */
   componentDidLoad(): ReturnType<typeof setTimeout>;
   /**
    * Add listeners to items
-   *
    * @returns {void}
    */
   componentDidRender(): void;
   /**
    * Render
-   *
    * @returns {HTMLElement} HTML Element
    */
   render(): HTMLElement;

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

@@ -90,13 +90,11 @@ 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
@@ -104,7 +102,6 @@ export declare class MgMenuItem {
   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
@@ -113,51 +110,43 @@ export declare class MgMenuItem {
   /**
    * 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
    */
   private hasActiveChild;
   /**
    * Validate slots
-   *
    * @param {boolean} guard prevent action whith guard. Default: false.
    * @returns {void}
    */
   private validateSlot;
   /**
    * Update status
-   *
    * @param {Status[]} guard status to exclude from process in addition to [Status.HIDDEN, Status.DISABLED] . Default: [].
    * @returns {void}
    */
   private updateStatus;
   /**
    * Init event-listeners
-   *
    * @returns {void}
    */
   private initListeners;
   /**
    * Get mg-popover identifier
-   *
    * @returns {MgPopover['identifier']} 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
    */
   private displayPopover;
@@ -166,14 +155,12 @@ export declare class MgMenuItem {
    ************/
   /**
    * Handle interacrtive element click
-   *
    * @param {MouseEvent} event click on element
    * @returns {void}
    */
   private handleElementCLick;
   /**
    * Handle popover element display-change event
-   *
    * @param {CustomEvent} event popover display event
    * @returns {void}
    */
@@ -183,31 +170,26 @@ export declare class MgMenuItem {
    *************/
   /**
    * Validate props
-   *
    * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Check if component slots configuration
-   *
    * @returns {ReturnType<typeof setTimeout>} timeout
    */
   componentDidLoad(): ReturnType<typeof setTimeout>;
   /**
    * Render ineractive element
-   *
    * @returns {HTMLElement} HTML Element
    */
   private renderInteractiveElement;
   /**
    * Render slot
-   *
    * @returns {HTMLElement} HTML Element
    */
   private renderSlot;
   /**
    * Render
-   *
    * @returns {HTMLElement} HTML Element
    */
   render(): HTMLElement;

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

@@ -45,19 +45,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}
@@ -68,13 +65,11 @@ export declare class MgActionMore {
    *************/
   /**
    * Validate props
-   *
    * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render
-   *
    * @returns {HTMLElement} 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;
@@ -40,13 +39,11 @@ export declare class MgDetails {
    *************/
   /**
    * Check if component props are well configured on init
-   *
    * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render
-   *
    * @returns {HTMLElement} HTML Element
    */
   render(): HTMLElement;

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

@@ -62,33 +62,28 @@ 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}
    */
   private handleFormSubmit;
   /**
    * Set mgInputs
-   *
    * @returns {void}
    */
   private setMgInputs;
@@ -97,19 +92,16 @@ 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
    */
   render(): HTMLElement;

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

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

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

@@ -40,7 +40,6 @@ export declare class MgItemMore {
    ***********/
   /**
    * render mg-item-more overflow element
-   *
    * @returns {HTMLMgItemMoreElement} mg-item-more element
    */
   private renderMgMenuItemOverflowElement;
@@ -49,25 +48,21 @@ 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
    */
   render(): HTMLElement;

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

@@ -63,19 +63,16 @@ 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}
    */
@@ -86,8 +83,7 @@ export declare class MgMessage {
   private handleClose;
   /**
    * Get icon corresponding to variant
-   *
-   * @returns {string} icon
+   * @returns {MgIcon['icon'] | undefined} icon
    */
   private getIcon;
   /*************
@@ -99,7 +95,6 @@ export declare class MgMessage {
   componentWillLoad(): void;
   /**
    * Render
-   *
    * @returns {HTMLElement} HTML Element
    */
   render(): HTMLElement;

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

@@ -59,7 +59,6 @@ export declare class MgModal {
   componentHide: EventEmitter<string>;
   /**
    * Handle 'escape' key down
-   *
    * @param {KeyboardEvent} event keydown event
    * @returns {void}
    */
@@ -70,7 +69,6 @@ export declare class MgModal {
    *************/
   /**
    * Handle close button
-   *
    * @returns {void}
    */
   private handleClose;
@@ -79,19 +77,16 @@ 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
    */
   render(): HTMLElement;

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

@@ -41,7 +41,6 @@ export declare class MgPagination {
   currentPageChange: EventEmitter<number>;
   /**
    * Change current page from target
-   *
    * @param {number} target target page
    * @returns {void}
    */
@@ -51,14 +50,12 @@ export declare class MgPagination {
    ************/
   /**
    * select handler
-   *
    * @param {InputEvent} event value change event
    * @returns {void}
    */
   private handleSelect;
   /**
    * Go to 'previous/next' page button handler
-   *
    * @param {string} action navigation action
    * @param {boolean} disabled button disable state
    * @returns {void}
@@ -69,13 +66,11 @@ export declare class MgPagination {
    *************/
   /**
    * Check if props are well configured on init
-   *
    * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render
-   *
    * @returns {HTMLElement} HTML Element
    */
   render(): HTMLElement;

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

@@ -70,7 +70,6 @@ export declare class MgPanel {
    ************/
   /**
    * Toggle is editing state
-   *
    * @returns {void}
    */
   private toggleIsEditing;
@@ -79,32 +78,27 @@ 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}
    */
   private handleUpdateTitle;
   /**
    * Cancel edition button handler
-   *
    * @returns {void}
    */
   private handleCancelEditButton;
   /**
    * Validate edition button handler
-   *
    * @returns {void}
    */
   private handleValidateEditButton;
@@ -113,26 +107,22 @@ 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
    */
   private headerLeft;
   /**
    * Edit DOM after render
-   *
    * @returns {void}
    */
   componentDidRender(): void;
   /**
    * Render component
-   *
    * @returns {HTMLElement} html element
    */
   render(): HTMLElement;

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

@@ -56,26 +56,22 @@ export declare class MgPopover {
   displayChange: EventEmitter<boolean>;
   /**
    * Check if clicked outside of component
-   *
    * @param {MouseEvent} event mouse event
    * @returns {void}
    */
   private clickOutside;
   /**
    * Show popover
-   *
    * @returns {void}
    */
   private show;
   /**
    * Hide popover
-   *
    * @returns {void}
    */
   private hide;
   /**
    * Handle action for close button
-   *
    * @returns {void}
    */
   private handleCloseButton;
@@ -84,19 +80,16 @@ 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
    */
   render(): HTMLElement;

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

@@ -26,7 +26,6 @@ export declare class MgSkipLinks {
    **********/
   /**
    * Handle link click and emit go-to-anchor event
-   *
    * @param {MouseEvent} event mouse event
    * @returns {void}
    */
@@ -36,13 +35,11 @@ export declare class MgSkipLinks {
    *************/
   /**
    * Check if props are well configured on init
-   *
    * @returns {void}
    */
   componentWillLoad(): void;
   /**
    * Render
-   *
    * @returns {HTMLElement} HTML Element
    */
   render(): HTMLElement;

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

@@ -57,7 +57,6 @@ export declare class MgTabs {
   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
@@ -65,7 +64,6 @@ export declare class MgTabs {
   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
@@ -73,40 +71,34 @@ export declare class MgTabs {
   private getElementId;
   /**
    * Method to get tab item index
-   *
    * @param {number} index to get
    * @returns {number} index
    */
   private getTabItemIndex;
   /**
    * Method to get the active-tab value
-   *
    * @returns {number} of the active-tab
    */
   private getActiveTab;
   /**
    * Handle click events on tabs
-   *
    * @param {MouseEvent} event mouse event
    */
   private handleClick;
   /**
    * get navigation button class from given status
-   *
    * @param {Status} status button tab status
    * @returns {string} button class/selector variant
    */
   private getNavigationButtonClass;
   /**
    * Handle keyboard event on tabs
-   *
    * @param {MouseEvent} event mouse event
    * @returns {void}
    */
   private handleKeydown;
   /**
    * Method to reset focus behavior
-   *
    * @returns {void}
    */
   private resetFocus;
@@ -119,19 +111,16 @@ 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
    */
   render(): HTMLElement;

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

@@ -126,7 +126,6 @@ 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
  */