@mgdis/mg-components 5.8.2 → 5.10.0

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

@@ -123,33 +123,28 @@ 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
    */
   private isInputValue;
   /**
    * value props setter
-   *
    * @param {MgInputSelect['value']} newValue value to update with
    * @returns {void}
    */
   private setValue;
   /**
    * Update value from input.value
-   *
    * @returns {void}
    */
   private updateValue;
@@ -159,7 +154,6 @@ export declare class MgInputSelect {
   private handleBlur;
   /**
    * Input value is disabled
-   *
    * @returns {boolean} truthy if input value is disabled
    */
   private isDisabledValue;
@@ -176,20 +170,17 @@ export declare class MgInputSelect {
    *************/
   /**
    * Check if component props are well configured on init
-   *
    * @returns {ReturnType<typeof setTimeout>} timeout
    */
   componentWillLoad(): ReturnType<typeof setTimeout>;
   /**
    * Render option
-   *
    * @param {SelectOption} option to render
    * @returns {HTMLElement} render option
    */
   private renderOption;
   /**
    * Render
-   *
    * @returns {HTMLElement} HTML Element
    */
   render(): HTMLElement;

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

@@ -126,55 +126,46 @@ 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;
@@ -183,13 +174,11 @@ export declare class MgInputText {
    *************/
   /**
    * Check if component props are well configured on init
-   *
    * @returns {ReturnType<typeof setTimeout>} timeout
    */
   componentWillLoad(): ReturnType<typeof setTimeout>;
   /**
    * Render
-   *
    * @returns {HTMLElement} HTML Element
    */
   render(): HTMLElement;

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

@@ -125,7 +125,6 @@ export declare class MgInputTextarea {
   inputValid: EventEmitter<boolean>;
   /**
    * Public method to display errors
-   *
    * @returns {Promise<void>}
    */
   displayError(): Promise<void>;
@@ -144,7 +143,6 @@ 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
    */
   private getPatternValidity;
@@ -165,13 +163,11 @@ export declare class MgInputTextarea {
    *************/
   /**
    * Check if component props are well configured on init
-   *
    * @returns {ReturnType<typeof setTimeout>} timeout
    */
   componentWillLoad(): ReturnType<typeof setTimeout>;
   /**
    * Render
-   *
    * @returns {HTMLElement} 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[];
@@ -101,19 +100,16 @@ 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;
@@ -126,7 +122,6 @@ export declare class MgInputToggle {
   componentWillLoad(): void;
   /**
    * Render
-   *
    * @returns {HTMLElement} HTML Element
    */
   render(): HTMLElement;

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.conf.d.ts

@@ -1,4 +1,8 @@
 /**
  * List of all possibles message variants
  */
-export declare const variants: string[];
+export declare const variants: readonly ["info", "warning", "success", "danger"];
+/**
+ * Variant type
+ */
+export type VariantType = (typeof variants)[number];

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

@@ -1,5 +1,6 @@
 import { EventEmitter } from '../../../stencil-public-runtime';
 import { ClassList } from '../../../utils/components.utils';
+import { VariantType } from './mg-message.conf';
 export declare class MgMessage {
   /************
    * Internal *
@@ -27,23 +28,23 @@ export declare class MgMessage {
    * Value is defined in seconds and must greater than 2 seconds (PDA9-314 RG-06)
    */
   delay: number;
-  validateDelay(newValue: number): void;
+  validateDelay(newValue: MgMessage['delay']): void;
   /**
    * Message variant
    */
-  variant: string;
-  validateVariant(newValue: string, oldValue?: string): void;
+  variant: VariantType;
+  validateVariant(newValue: MgMessage['variant'], oldValue?: MgMessage['variant']): void;
   /**
    * Define if message has a cross button
    * RG 01: https://jira.mgdis.fr/browse/PDA9-140
    */
   closeButton: boolean;
-  validateCloseButton(newValue: boolean): void;
+  validateCloseButton(newValue: MgMessage['closeButton']): void;
   /**
    * Define if message is hidden
    */
   hide: boolean;
-  validateHide(newValue: boolean): void;
+  validateHide(newValue: MgMessage['hide']): void;
   /**
    * Component classes
    */
@@ -62,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}
    */
@@ -85,8 +83,7 @@ export declare class MgMessage {
   private handleClose;
   /**
    * Get icon corresponding to variant
-   *
-   * @returns {string} icon
+   * @returns {MgIcon['icon'] | undefined} icon
    */
   private getIcon;
   /*************
@@ -98,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;