@mgdis/mg-components 3.1.0 → 4.0.0

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

@@ -1,15 +1,11 @@
-import { Component, Event, h, Prop, State } from '@stencil/core';
+import { Component, Element, Event, h, Prop, State, Method, Watch } from '@stencil/core';
 import { MgInput } from '../MgInput';
 import { createID, ClassList } from '../../../../utils/components.utils';
-import { messages } from '../../../../locales';
-import { InputClass } from '../MgInput.conf';
+import { initLocales } from '../../../../locales';
 export class MgInputPassword {
   constructor() {
-    /************
-     * Internal *
-     ************/
-    // classes
-    this.classError = InputClass.ERROR;
+    // hasError (triggered by blur event)
+    this.hasError = false;
     /**
      * Identifier is used for the element ID (id is a reserved prop in Stencil.js)
      * If not set, it will be created.
@@ -39,7 +35,7 @@ export class MgInputPassword {
     /**
      * Define input width
      */
-    this.width = 'full';
+    this.mgWidth = 'full';
     /**
      * Component classes
      */
@@ -49,56 +45,80 @@ export class MgInputPassword {
      */
     this.handleInput = () => {
       this.checkValidity();
+      if (this.hasError) {
+        this.checkError();
+      }
       this.value = this.input.value;
-      this.valueChange.emit(this.value);
     };
     /**
      * Handle blur event
      */
     this.handleBlur = () => {
-      this.checkValidity();
-      this.checkError();
+      this.displayError();
+    };
+    /**
+     * Check if input is valid
+     */
+    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
+     */
+    this.checkError = () => {
+      // Set error message
+      this.errorMessage = undefined;
+      // required
+      if (!this.valid && this.input.validity.valueMissing) {
+        this.errorMessage = this.messages.errors.required;
+      }
     };
   }
-  /**
-   * 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 display errors
+   *
+   * @returns {Promise<void>}
    */
-  checkError() {
-    // Set error message
-    this.errorMessage = undefined;
-    // required
-    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();
+    this.hasError = this.invalid;
   }
   /*************
    * Lifecycle *
    *************/
+  /**
+   * Check if component props are well configured on init
+   *
+   * @returns {ReturnType<typeof setTimeout>} timeout
+   */
   componentWillLoad() {
+    // Get locales
+    this.messages = initLocales(this.element).messages;
+    // 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: this.value !== undefined ? '•'.repeat(this.value.length) : undefined, tooltip: this.tooltip, displayCharacterLeft: false, characterLeftTemplate: undefined, maxlength: undefined, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: false },
+    return (h(MgInput, { identifier: this.identifier, classList: this.classList, ariaDescribedbyIDs: [], label: this.label, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: this.required, readonly: this.readonly, mgWidth: this.mgWidth, disabled: this.disabled, value: this.value, readonlyValue: this.value !== undefined ? '•'.repeat(this.value.length) : undefined, tooltip: this.tooltip, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: false },
       h("input", { type: "password", class: "mg-input__box", value: this.value, id: this.identifier, name: this.name, placeholder: this.placeholder, title: this.placeholder, disabled: this.disabled, required: this.required, onInput: this.handleInput, onBlur: this.handleBlur, ref: el => (this.input = el) })));
   }
   static get is() { return "mg-input-password"; }
@@ -136,7 +156,7 @@ export class MgInputPassword {
         "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."
@@ -154,7 +174,7 @@ export class MgInputPassword {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Input name\nIf not set the value equals the identifier"
@@ -175,7 +195,7 @@ export class MgInputPassword {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Input label\nRequired"
+        "text": "Input label"
       },
       "attribute": "label",
       "reflect": false
@@ -286,7 +306,7 @@ export class MgInputPassword {
       "reflect": false,
       "defaultValue": "false"
     },
-    "width": {
+    "mgWidth": {
       "type": "any",
       "mutable": false,
       "complexType": {
@@ -305,7 +325,7 @@ export class MgInputPassword {
         "tags": [],
         "text": "Define input width"
       },
-      "attribute": "width",
+      "attribute": "mg-width",
       "reflect": false,
       "defaultValue": "'full'"
     },
@@ -355,7 +375,7 @@ export class MgInputPassword {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define input pattern to validate"
+        "text": "Define input valid state"
       },
       "attribute": "valid",
       "reflect": false
@@ -372,7 +392,7 @@ export class MgInputPassword {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define input pattern error message"
+        "text": "Define input invalid state"
       },
       "attribute": "invalid",
       "reflect": false
@@ -390,12 +410,53 @@ export class MgInputPassword {
       "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 {
+    "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"
     }]; }
 }

package/dist/collection/components/molecules/inputs/mg-input-radio/{mg-input-radio.stories.js → doc/mg-input-radio.stories.js}

@@ -8,12 +8,17 @@ export default {
       control: { type: 'radio' },
     },
   },
+  parameters: { actions: { handles: ['value-change', 'input-valid'] } },
 };
 /**
  * 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 helpText = args.helpText;

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

@@ -10,16 +10,10 @@
   align-items: flex-start;
   min-height: var(--default-size);
   max-width: 100%;
-  /* Style when input is not valid */
+  margin-bottom: var(--mg-inputs-margin-bottom, 0);
   /* Label */
   /* Label-on-top */
 }
-.mg-input.is-not-valid {
-  color: hsl(var(--color-danger));
-}
-.mg-input.is-not-valid .mg-input__box {
-  border-color: hsl(var(--color-danger));
-}
 .mg-input mg-input-title {
   flex-shrink: var(--mg-inputs-shrink, 1);
   width: var(--mg-inputs-title-width, auto);
@@ -73,6 +67,11 @@
 .mg-input__input-container mg-icon {
   display: flex;
 }
+.mg-input__input-container .mg-input__help-text,
+.mg-input__input-container .mg-input__error {
+  text-align: start;
+  font-size: 1.2rem;
+}
 
 .mg-input__input {
   display: flex;
@@ -81,17 +80,29 @@
 .mg-input__input mg-tooltip {
   margin-top: calc((var(--default-size) - var(--mg-icon-regular-size)) / 2);
 }
-.mg-input__input + * {
-  text-align: start;
+.mg-input__input.mg-input__input--has-error .mg-input__box {
+  border-color: hsl(var(--color-danger));
+}
+.mg-input__input + .mg-input__help-text, .mg-input__input + .mg-input__error {
   margin-top: 0.5rem;
 }
 
+.mg-input__error {
+  display: inline-block;
+  margin-top: 0.2rem;
+  padding: 0.3rem 0.8rem;
+  border-radius: 0.3rem;
+  background: hsl(var(--mg-inputs-error-bg-color));
+  color: hsl(var(--color-danger));
+}
+
 /**
  * Manage style when input needs to be a fieldset, like checkbox and radio.
  */
 fieldset.mg-input {
   border: 0;
-  margin: 0;
+  margin-left: 0;
+  margin-right: 0;
   padding: 0;
 }
 fieldset.mg-input input[type=radio],
@@ -110,7 +121,7 @@ fieldset.mg-input.mg-input--label-on-top .mg-input__input-group-container {
 }
 
 .mg-input__input-container mg-tooltip {
-  margin-left: 2rem;
+  margin-left: 3rem;
 }
 
 /* input group container */
@@ -133,6 +144,9 @@ fieldset.mg-input.mg-input--label-on-top .mg-input__input-group-container {
   display: flex;
   align-items: top;
 }
+.mg-input__input-group.mg-input__input-group--disabled label {
+  opacity: 0.3;
+}
 
 /**
  * A11Y

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

@@ -1,12 +1,14 @@
-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, Element, Event, h, Prop, State, Watch, Method } from '@stencil/core';
 import { MgInput } from '../MgInput';
 import { createID, ClassList, allItemsAreString } from '../../../../utils/components.utils';
-import { messages } from '../../../../locales';
-import { InputClass } from '../MgInput.conf';
+import { initLocales } from '../../../../locales';
 /**
  * type Option validation function
- * @param option
- * @returns {boolean}
+ *
+ * @param {RadioOption} option radio option
+ * @returns {boolean} radio option type is valid
  */
 const isOption = (option) => typeof option === 'object' && typeof option.title === 'string' && option.value !== undefined;
 export class MgInputRadio {
@@ -14,8 +16,6 @@ export class MgInputRadio {
     /************
      * Internal *
      ************/
-    // classes
-    this.classError = InputClass.ERROR;
     // HTML selector
     this.inputs = [];
     /**
@@ -58,25 +58,61 @@ export class MgInputRadio {
     this.classList = new ClassList(['mg-input--radio']);
     /**
      * Handle input event
+     *
+     * @param {event} event input event
+     * @returns {void}
      */
     this.handleInput = (event) => {
       this.checkValidity();
       this.value = this.options[event.target.value].value;
-      this.valueChange.emit(this.value);
     };
     /**
      * Handle blur event
+     *
+     * @returns {void}
      */
     this.handleBlur = () => {
       this.checkValidity();
       this.checkError();
     };
+    /**
+     * Check if input is valid
+     *
+     * @returns {void}
+     */
+    this.checkValidity = () => {
+      if (!this.readonly) {
+        const validity = this.getInvalidElement() === undefined;
+        // Set validity
+        this.valid = validity;
+        this.invalid = !validity;
+        //Send event
+        this.inputValid.emit(validity);
+      }
+    };
+    /**
+     * Check input errors
+     *
+     * @returns {void}
+     */
+    this.checkError = () => {
+      const invalidElement = this.getInvalidElement();
+      // Set error message
+      this.errorMessage = undefined;
+      if (!this.valid && invalidElement.validity.valueMissing) {
+        this.errorMessage = this.messages.errors.required;
+      }
+    };
     /**
      * get invalid element
-     * @returns element: HTMLInputElement
+     *
+     * @returns {HTMLInputElement} element
      */
     this.getInvalidElement = () => this.inputs.find((element) => !element.disabled && !element.checkValidity());
   }
+  handleValue(newValue) {
+    this.valueChange.emit(newValue);
+  }
   validateItems(newValue) {
     // Validate if items have required min length
     if (typeof newValue === 'object' && newValue.length < 2) {
@@ -95,47 +131,42 @@ export class MgInputRadio {
     }
   }
   /**
-   * Check if input is valid
+   * Public method to display errors
+   *
+   * @returns {Promise<void>}
    */
-  checkValidity() {
-    if (!this.readonly) {
-      const validity = this.getInvalidElement() === undefined;
-      // Set validity
-      this.valid = validity;
-      this.invalid = !validity;
-    }
-  }
-  /**
-   * Check input errors
-   */
-  checkError() {
-    const invalidElement = this.getInvalidElement();
-    // Set error message
-    this.errorMessage = undefined;
-    if (!this.valid && invalidElement.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
+    // Get locales
+    this.messages = initLocales(this.element).messages;
+    // Validate
     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, disabled: this.disabled, readonly: this.readonly, width: undefined, value: this.value && this.value.toString(), readonlyValue: this.value && this.value.toString(), tooltip: this.tooltip, displayCharacterLeft: undefined, characterLeftTemplate: undefined, maxlength: undefined, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: true },
-      h("ul", { class: `mg-input__input-group-container${this.inputVerticalList ? ' mg-input__input-group-container--vertical' : ''}` }, this.options.map((input, index) => (h("li", { class: "mg-input__input-group" },
+    return (h(MgInput, { identifier: this.identifier, classList: this.classList, ariaDescribedbyIDs: [], label: this.label, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: this.required, disabled: this.disabled, readonly: this.readonly, mgWidth: undefined, value: this.value, readonlyValue: this.value, tooltip: this.tooltip, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: true },
+      h("ul", { class: { 'mg-input__input-group-container': true, 'mg-input__input-group-container--vertical': this.inputVerticalList } }, this.options.map((input, index) => (h("li", { class: { 'mg-input__input-group': true, 'mg-input__input-group--disabled': this.disabled || input.disabled } },
         h("input", { type: "radio", id: this.identifier + '_' + index, name: this.identifier, value: index, checked: JSON.stringify(this.value) === JSON.stringify(this.options[index].value), disabled: this.disabled || input.disabled, required: this.required, onBlur: this.handleBlur, onInput: this.handleInput, ref: el => this.inputs.push(el) }),
         h("label", { htmlFor: this.identifier + '_' + index }, input.title)))))));
   }
@@ -233,7 +264,7 @@ export class MgInputRadio {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Input label\nRequired"
+        "text": "Input label"
       },
       "attribute": "label",
       "reflect": false
@@ -392,7 +423,7 @@ export class MgInputRadio {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Force valid component"
+        "text": "Define input valid state"
       },
       "attribute": "valid",
       "reflect": false
@@ -409,7 +440,7 @@ export class MgInputRadio {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Force invalid component"
+        "text": "Define input invalid state"
       },
       "attribute": "invalid",
       "reflect": false
@@ -435,8 +466,48 @@ export class MgInputRadio {
         "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 elementRef() { return "element"; }
   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 → doc/mg-input-select.stories.js}

@@ -1,13 +1,30 @@
 import { h } from '@stencil/core';
+import messages from '../../../../../locales/en/messages.json';
 export default {
   component: 'mg-input-select',
   title: 'Molecules/Inputs/mg-input-select',
+  argTypes: {
+    placeholder: {
+      table: {
+        defaultValue: { summary: messages.input.select.placeholder },
+      },
+    },
+    mgWidth: {
+      options: [undefined, 2, 4, 16, 'full'],
+      control: { type: 'select' },
+    },
+  },
+  parameters: { actions: { handles: ['value-change', 'input-valid'] } },
 };
 /**
  * 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;
@@ -18,8 +35,10 @@ const Template = args => {
   delete args.placeholderDisabled;
   const placeholderHide = args.placeholderHide;
   delete args.placeholderHide;
+  const mgWidth = args.mgWidth;
+  delete args.mgWidth;
   // return element
-  return (h("mg-input-select", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "help-text": helpText, "placeholder-hide": placeholderHide, "placeholder-disabled": placeholderDisabled })));
+  return (h("mg-input-select", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "help-text": helpText, "placeholder-hide": placeholderHide, "placeholder-disabled": placeholderDisabled, "mg-width": mgWidth })));
 };
 export const MgInputSelect = Template.bind({});
 MgInputSelect.args = {
@@ -36,6 +55,7 @@ MgInputSelect.args = {
   readonly: false,
   disabled: false,
   items: ['blu', 'bli', 'blo', 'bla'],
+  mgWidth: undefined,
   // Tooltip
   tooltip: 'This is a tooltip',
   // Help Text