@mgdis/mg-components 3.1.0 → 3.2.0

package/dist/collection/components/molecules/inputs/mg-input-select/mg-input-select.js

@@ -1,31 +1,35 @@
-import { Component, Event, h, Prop, State, Watch } from '@stencil/core';
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { Component, Event, h, Prop, State, Watch, Method } from '@stencil/core';
 import { MgInput } from '../MgInput';
+import { InputClass } from '../MgInput.conf';
 import { createID, ClassList, allItemsAreString } from '../../../../utils/components.utils';
 import { messages } from '../../../../locales';
-import { InputClass } from '../MgInput.conf';
 /**
  * Check if item is a well configured option
- * @param option
- * @returns {boolean}
+ *
+ * @param {SelectOption} option select option
+ * @returns {boolean} select option type is valid
  */
 const isOption = (option) => typeof option === 'object' && typeof option.title === 'string' && option.value !== undefined;
 /**
  * Group options
- * @param acc
- * @param {SelectOption} item
- * @param {string} item.group
- * @param {string} item.title
- * @param {any} item.value
- * @param {boolean} item.disabled
- * @returns {OptGroup} grouped options
+ *
+ * @param {(SelectOption | OptGroup)[]} acc reduce accumulator
+ * @param {SelectOption} item item to add
+ * @param {string} item.group item group
+ * @param {string} item.title item title
+ * @param {unknown} item.value item value
+ * @param {boolean} item.disabled is item disabled
+ * @returns {(SelectOption | OptGroup)[]} grouped options
  */
 const groupOptions = (acc, { group, title, value, disabled }) => {
   if (group !== undefined) {
     // Check if group is already created
-    const optgroup = acc.find((grp) => grp.group === group);
+    const optGroup = acc.find(grp => grp.group === group);
     // Add to group
-    if (optgroup) {
-      optgroup.options.push({ title, value, disabled });
+    if (optGroup !== undefined) {
+      optGroup.options.push({ title, value, disabled });
     }
     // Create group
     else {
@@ -92,8 +96,12 @@ export class MgInputSelect {
      */
     this.handleInput = () => {
       this.checkValidity();
-      this.value = this.input.value !== '' ? this.options[this.input.value].value : null;
-      this.valueChange.emit(this.value);
+      if (this.input.value !== '') {
+        this.value = allItemsAreString(this.items) ? this.input.value : this.items.find(item => item.title === this.input.value).value;
+      }
+      else {
+        this.value = null;
+      }
     };
     /**
      * Handle blur event
@@ -102,18 +110,57 @@ export class MgInputSelect {
       this.checkValidity();
       this.checkError();
     };
+    /**
+     * Check if input is valid
+     */
+    this.checkValidity = () => {
+      if (!this.readonly && this.input !== undefined) {
+        const validity = this.input.checkValidity && this.input.checkValidity();
+        // Set validity
+        this.valid = validity;
+        this.invalid = !validity;
+        //Send event
+        this.inputValid.emit(validity);
+      }
+    };
+    /**
+     * Check input errors
+     */
+    this.checkError = () => {
+      // Set error message
+      this.errorMessage = undefined;
+      if (!this.valid && this.input.validity.valueMissing) {
+        this.errorMessage = messages.errors.required;
+      }
+      // Update class
+      if (this.valid) {
+        this.classList.delete(this.classError);
+      }
+      else {
+        this.classList.add(this.classError);
+      }
+    };
+  }
+  handleValue(newValue) {
+    if (newValue !== null) {
+      this.readonlyValue = allItemsAreString(this.items) ? this.input.value : this.items.find(item => item.value === newValue).title;
+    }
+    else {
+      this.readonlyValue = null;
+    }
+    this.valueChange.emit(newValue);
   }
   validateItems(newValue) {
     // String array
     if (allItemsAreString(newValue)) {
       this.valueExist = newValue.includes(this.value);
-      this.options = newValue.map(item => ({ title: item, value: item }));
+      this.options = newValue.map((item) => ({ title: item, value: item }));
     }
     // Object array
     else if (newValue && newValue.every(item => isOption(item))) {
       this.valueExist = newValue.map(item => item.value).includes(this.value);
       // Grouped object options
-      if (newValue.some((item) => item.group !== undefined)) {
+      if (newValue.some(item => item.group !== undefined)) {
         this.options = newValue.reduce(groupOptions, []);
       }
       // Standart object options
@@ -126,49 +173,43 @@ export class MgInputSelect {
     }
   }
   /**
-   * Check if input is valid
-   */
-  checkValidity() {
-    if (!this.readonly && this.input !== undefined) {
-      const validity = this.input.checkValidity && this.input.checkValidity();
-      // Set validity
-      this.valid = validity;
-      this.invalid = !validity;
-    }
-  }
-  /**
-   * Check input errors
+   * Public method to display errors
+   *
+   * @returns {Promise<void>}
    */
-  checkError() {
-    // Set error message
-    this.errorMessage = undefined;
-    if (!this.valid && this.input.validity.valueMissing) {
-      this.errorMessage = messages.errors.required;
-    }
-    // Update class
-    if (this.valid) {
-      this.classList.delete(this.classError);
-    }
-    else {
-      this.classList.add(this.classError);
-    }
+  async displayError() {
+    this.checkValidity();
+    this.checkError();
   }
   /*************
    * Lifecycle *
    *************/
+  /**
+   * Check if component props are well configured on init
+   *
+   * @returns {ReturnType<typeof setTimeout>} timeout
+   */
   componentWillLoad() {
     // Check items format
     this.validateItems(this.items);
+    // Check validity when component is ready
     // return a promise to process action only in the FIRST render().
     // https://stenciljs.com/docs/component-lifecycle#componentwillload
-    return setTimeout(() => this.checkValidity(), 0);
+    return setTimeout(() => {
+      this.checkValidity();
+    }, 0);
   }
+  /**
+   * Render
+   *
+   * @returns {HTMLElement} HTML Element
+   */
   render() {
-    return (h(MgInput, { identifier: this.identifier, classList: this.classList, label: this.label, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: this.required, readonly: this.readonly, width: this.width, disabled: this.disabled, value: this.value, readonlyValue: undefined, tooltip: this.tooltip, displayCharacterLeft: undefined, characterLeftTemplate: undefined, maxlength: undefined, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: false },
+    return (h(MgInput, { identifier: this.identifier, classList: this.classList, label: this.label, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: this.required, readonly: this.readonly, width: this.width, disabled: this.disabled, value: this.value, readonlyValue: this.readonlyValue, tooltip: this.tooltip, displayCharacterLeft: undefined, characterLeftTemplate: undefined, maxlength: undefined, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: false },
       h("select", { class: "mg-input__box", id: this.identifier, name: this.name, title: this.placeholder, disabled: this.disabled, required: this.required, onInput: this.handleInput, onBlur: this.handleBlur, ref: el => (this.input = el) },
         (!this.placeholderHide || !this.valueExist) && ( // In case passed value does not match any option we display the placeholder
         h("option", { value: "", disabled: this.placeholderDisabled && this.valueExist }, this.placeholder)),
-        this.options.map((option, optionIndex) => option.group !== undefined ? (h("optgroup", { label: option.group }, option.options.map((optgroup, optgroupIndex) => (h("option", { value: optgroupIndex, selected: JSON.stringify(this.value) === JSON.stringify(optgroup.value), disabled: optgroup.disabled }, optgroup.title))))) : (h("option", { value: optionIndex, selected: JSON.stringify(this.value) === JSON.stringify(option.value), disabled: option.disabled }, option.title))))));
+        this.options.map(option => option.group !== undefined ? (h("optgroup", { label: option.group }, option.options.map(optgroup => (h("option", { value: optgroup.title, selected: JSON.stringify(this.value) === JSON.stringify(optgroup.value), disabled: optgroup.disabled }, optgroup.title))))) : (h("option", { value: option.title, selected: JSON.stringify(this.value) === JSON.stringify(option.value), disabled: option.disabled }, option.title))))));
   }
   static get is() { return "mg-input-select"; }
   static get encapsulation() { return "shadow"; }
@@ -264,7 +305,7 @@ export class MgInputSelect {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Input label\nRequired"
+        "text": "Input label"
       },
       "attribute": "label",
       "reflect": false
@@ -507,7 +548,8 @@ export class MgInputSelect {
     "classList": {},
     "errorMessage": {},
     "options": {},
-    "valueExist": {}
+    "valueExist": {},
+    "readonlyValue": {}
   }; }
   static get events() { return [{
       "method": "valueChange",
@@ -517,15 +559,54 @@ export class MgInputSelect {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Emmited event when value change"
+        "text": "Emited event when value change"
       },
       "complexType": {
-        "original": "string",
-        "resolved": "string",
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      }
+    }, {
+      "method": "inputValid",
+      "name": "input-valid",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": "Emited event when checking validity"
+      },
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
         "references": {}
       }
     }]; }
+  static get methods() { return {
+    "displayError": {
+      "complexType": {
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "references": {
+          "Promise": {
+            "location": "global"
+          }
+        },
+        "return": "Promise<void>"
+      },
+      "docs": {
+        "text": "Public method to display errors",
+        "tags": [{
+            "name": "returns",
+            "text": undefined
+          }]
+      }
+    }
+  }; }
   static get watchers() { return [{
+      "propName": "value",
+      "methodName": "handleValue"
+    }, {
       "propName": "items",
       "methodName": "validateItems"
     }]; }

package/dist/collection/components/molecules/inputs/mg-input-select/mg-input-select.stories.js

@@ -1,13 +1,26 @@
 import { h } from '@stencil/core';
+import { messages } from '../../../../locales';
 export default {
   component: 'mg-input-select',
   title: 'Molecules/Inputs/mg-input-select',
+  parameters: { actions: { handles: ['value-change', 'input-valid'] } },
+  argTypes: {
+    placeholder: {
+      table: {
+        defaultValue: { summary: messages.input.select.placeholder },
+      },
+    },
+  },
 };
 /**
  * 1. camelCase arguments must be written in the template, for exemple labelOnTop must be placed in the template as label-on-top={args.labelOnTop}
  * 2. boolean arguments with a default true value must be added like display-character-left={args.displayCharacterLeft ? 'true' : 'false'}
+ *
+ * @param {any} args component arguments
+ * @returns {HTMLElement} HTMLElement
  */
-const Template = args => {
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const Template = (args) => {
   const labelOnTop = args.labelOnTop;
   delete args.labelOnTop;
   const labelHide = args.labelHide;

package/dist/collection/components/molecules/inputs/mg-input-text/mg-input-text.css

@@ -10,6 +10,7 @@
   align-items: flex-start;
   min-height: var(--default-size);
   max-width: 100%;
+  margin-bottom: var(--mg-inputs-margin-bottom, 0);
   /* Style when input is not valid */
   /* Label */
   /* Label-on-top */
@@ -96,6 +97,7 @@
  */
 .mg-input__box {
   padding: calc((var(--default-size) - var(--font-size) * var(--line-height)) / 2) var(--mg-inputs-spacer);
+  width: 100%;
   height: var(--default-size);
   box-sizing: border-box;
   border-width: var(--mg-inputs-border-width);
@@ -145,6 +147,31 @@
   display: none;
 }
 
+.mg-input.mg-input--label-on-top .mg-input__box {
+  width: auto;
+  max-width: 100%;
+}
+
+.mg-input.mg-input--has-buttons-group-append ::slotted([slot=append-input]) {
+  --mg-button-border-radius-top-right: 0;
+  --mg-button-border-radius-bottom-right: 0;
+  --mg-button-border-radius-top-left: 0;
+  /* IE FIX */
+  --mg-button-border-radius-bottom-left: 0;
+  /* IE FIX */
+}
+.mg-input.mg-input--has-buttons-group-append ::slotted([slot=append-input]:not(:last-of-type)) {
+  --mg-button-border-right-width: 0;
+}
+.mg-input.mg-input--has-buttons-group-append ::slotted([slot=append-input]:last-of-type) {
+  --mg-button-border-radius-top-right: var(--mg-inputs-border-radius);
+  --mg-button-border-radius-bottom-right: var(--mg-inputs-border-radius);
+  --mg-button-border-radius-top-left: 0;
+  /* IE FIX */
+  --mg-button-border-radius-bottom-left: 0;
+  /* IE FIX */
+}
+
 .mg-input.mg-input--is-append-input-slot-content:not(.mg-input--readonly) ::slotted([slot=append-input]) {
   padding-top: calc((var(--default-size) - var(--mg-icon-regular-size)) / 2);
 }

package/dist/collection/components/molecules/inputs/mg-input-text/mg-input-text.js

@@ -1,8 +1,8 @@
-import { Component, Event, h, Prop, State, Element } from '@stencil/core';
+import { Component, Event, h, Prop, State, Element, Method, Watch } from '@stencil/core';
 import { MgInput } from '../MgInput';
+import { InputClass } from '../MgInput.conf';
 import { createID, ClassList } from '../../../../utils/components.utils';
 import { messages } from '../../../../locales';
-import { InputClass } from '../MgInput.conf';
 export class MgInputText {
   constructor() {
     /************
@@ -10,6 +10,7 @@ export class MgInputText {
      ************/
     // classes
     this.classFocus = 'is-focused';
+    this.isInputGroupAppend = 'mg-input--is-input-group-append';
     this.classError = InputClass.ERROR;
     /**
      * Identifier is used for the element ID (id is a reserved prop in Stencil.js)
@@ -59,14 +60,17 @@ export class MgInputText {
     this.classList = new ClassList(['mg-input--text']);
     /**
      * Handle input event
+     *
+     * @returns {void}
      */
     this.handleInput = () => {
       this.checkValidity();
       this.value = this.input.value;
-      this.valueChange.emit(this.value);
     };
     /**
      * Handle focus event
+     *
+     * @returns {void}
      */
     this.handleFocus = () => {
       this.classList.add(this.classFocus);
@@ -74,6 +78,8 @@ export class MgInputText {
     };
     /**
      * Handle blur event
+     *
+     * @returns {void}
      */
     this.handleBlur = () => {
       // Manage focus
@@ -83,8 +89,49 @@ export class MgInputText {
       this.checkValidity();
       this.checkError();
     };
+    /**
+     * Check if input is valid
+     *
+     * @returns {void}
+     */
+    this.checkValidity = () => {
+      if (!this.readonly && this.input !== undefined) {
+        const validity = this.input.checkValidity();
+        // Set validity
+        this.valid = validity;
+        this.invalid = !validity;
+        //Send event
+        this.inputValid.emit(validity);
+      }
+    };
+    /**
+     * Check input errors
+     *
+     * @returns {void}
+     */
+    this.checkError = () => {
+      // Set error message
+      this.errorMessage = undefined;
+      // Does not match pattern
+      if (!this.valid && this.input.validity.patternMismatch) {
+        this.errorMessage = this.patternErrorMessage;
+      }
+      // required
+      else if (!this.valid && this.input.validity.valueMissing) {
+        this.errorMessage = messages.errors.required;
+      }
+      // Update class
+      if (this.valid) {
+        this.classList.delete(this.classError);
+      }
+      else {
+        this.classList.add(this.classError);
+      }
+    };
     /**
      * Validate patern configuration
+     *
+     * @returns {void}
      */
     this.validatePattern = () => {
       if (this.pattern &&
@@ -94,72 +141,68 @@ export class MgInputText {
         throw new Error('<mg-input-text> prop "pattern" must be paired with the prop "patternErrorMessage"');
       }
     };
+    /**
+     * Validate append slot
+     *
+     * @returns {void}
+     */
+    this.validateAppendSlot = () => {
+      const slotAppendInput = Array.from(this.element.querySelectorAll('[slot="append-input"]'));
+      if (slotAppendInput.length === 1) {
+        this.classList.add(slotAppendInput[0].nodeName === 'MG-BUTTON' ? this.isInputGroupAppend : 'mg-input--is-append-input-slot-content');
+      }
+      else if (slotAppendInput.filter(slot => slot.nodeName === 'MG-BUTTON').length > 1) {
+        this.classList.add(this.isInputGroupAppend);
+        this.classList.add('mg-input--has-buttons-group-append');
+      }
+    };
   }
-  /**
-   * Check if input is valid
-   */
-  checkValidity() {
-    if (!this.readonly && this.input !== undefined) {
-      const validity = this.input.checkValidity();
-      // Set validity
-      this.valid = validity;
-      this.invalid = !validity;
-    }
+  handleValue(newValue) {
+    this.valueChange.emit(newValue);
   }
   /**
-   * Check input errors
+   * Public method to play input focus
+   *
+   * @returns {Promise<void>}
    */
-  checkError() {
-    // Set error message
-    this.errorMessage = undefined;
-    // Does not match pattern
-    if (!this.valid && this.input.validity.patternMismatch) {
-      this.errorMessage = this.patternErrorMessage;
-    }
-    // required
-    else if (!this.valid && this.input.validity.valueMissing) {
-      this.errorMessage = messages.errors.required;
-    }
-    // Update class
-    if (this.valid) {
-      this.classList.delete(this.classError);
-    }
-    else {
-      this.classList.add(this.classError);
-    }
+  async setFocus() {
+    this.input.focus();
   }
   /**
-   * Validate append slot
+   * Public method to display errors
+   *
+   * @returns {Promise<void>}
    */
-  validateAppendSlot() {
-    const slotAppendInput = this.element.querySelector('[slot="append-input"]');
-    if (slotAppendInput !== null && slotAppendInput.querySelector('.mg-button') !== null) {
-      this.classList.add('mg-input--is-input-group-append');
-      this.classList = new ClassList(this.classList.classes);
-    }
-    else if (slotAppendInput !== null) {
-      this.classList.add('mg-input--is-append-input-slot-content');
-      this.classList = new ClassList(this.classList.classes);
-    }
+  async displayError() {
+    this.checkValidity();
+    this.checkError();
   }
   /*************
    * Lifecycle *
    *************/
   /**
    * Check if component props are well configured on init
+   *
+   * @returns {ReturnType<typeof setTimeout>} timeout
    */
   componentWillLoad() {
     if (this.icon !== undefined) {
       this.classList.add('mg-input--has-icon');
     }
     this.validatePattern();
+    this.validateAppendSlot();
+    // Check validity when component is ready
     // return a promise to process action only in the FIRST render().
     // https://stenciljs.com/docs/component-lifecycle#componentwillload
-    return setTimeout(() => this.checkValidity(), 0);
-  }
-  componentDidLoad() {
-    this.validateAppendSlot();
+    return setTimeout(() => {
+      this.checkValidity();
+    }, 0);
   }
+  /**
+   * Render
+   *
+   * @returns {HTMLElement} HTML Element
+   */
   render() {
     return (h(MgInput, { identifier: this.identifier, classList: this.classList, label: this.label, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: this.required, readonly: this.readonly, width: this.width, disabled: this.disabled, value: this.value, readonlyValue: undefined, tooltip: this.tooltip, displayCharacterLeft: this.displayCharacterLeft, characterLeftTemplate: this.characterLeftTemplate, maxlength: this.maxlength, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: false },
       this.icon !== undefined && h("mg-icon", { icon: this.icon }),
@@ -201,7 +244,7 @@ export class MgInputText {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Identifier is used for the element ID (id is a reserved prop in Stencil.js)\nIf not set, it will be created."
@@ -219,7 +262,7 @@ export class MgInputText {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Input name\nIf not set the value equals the identifier"
@@ -240,7 +283,7 @@ export class MgInputText {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Input label\nRequired"
+        "text": "Input label"
       },
       "attribute": "label",
       "reflect": false
@@ -542,7 +585,7 @@ export class MgInputText {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define input pattern to validate"
+        "text": "Define input valid state"
       },
       "attribute": "valid",
       "reflect": false
@@ -559,7 +602,7 @@ export class MgInputText {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define input pattern error message"
+        "text": "Define input invalid state"
       },
       "attribute": "invalid",
       "reflect": false
@@ -577,13 +620,72 @@ export class MgInputText {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Emmited event when value change"
+        "text": "Emited event when value change"
       },
       "complexType": {
         "original": "string",
         "resolved": "string",
         "references": {}
       }
+    }, {
+      "method": "inputValid",
+      "name": "input-valid",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": "Emited event when checking validity"
+      },
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      }
     }]; }
+  static get methods() { return {
+    "setFocus": {
+      "complexType": {
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "references": {
+          "Promise": {
+            "location": "global"
+          }
+        },
+        "return": "Promise<void>"
+      },
+      "docs": {
+        "text": "Public method to play input focus",
+        "tags": [{
+            "name": "returns",
+            "text": undefined
+          }]
+      }
+    },
+    "displayError": {
+      "complexType": {
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "references": {
+          "Promise": {
+            "location": "global"
+          }
+        },
+        "return": "Promise<void>"
+      },
+      "docs": {
+        "text": "Public method to display errors",
+        "tags": [{
+            "name": "returns",
+            "text": undefined
+          }]
+      }
+    }
+  }; }
   static get elementRef() { return "element"; }
+  static get watchers() { return [{
+      "propName": "value",
+      "methodName": "handleValue"
+    }]; }
 }