@mgdis/mg-components 3.1.0 → 3.2.0

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

@@ -2,12 +2,17 @@ import { h } from '@stencil/core';
 export default {
   component: 'mg-input-text',
   title: 'Molecules/Inputs/mg-input-text',
+  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;
@@ -21,7 +26,7 @@ const Template = args => {
   const helpText = args.helpText;
   delete args.helpText;
   // return element
-  return (h("mg-input-text", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "pattern-error-message": patternErrorMessage, "display-character-left": displayCharacterLeft, "character-left-template": characterLeftTemplate, "help-text": helpText })));
+  return (h("mg-input-text", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "pattern-error-message": patternErrorMessage, "display-character-left": displayCharacterLeft ? 'true' : 'false', "character-left-template": characterLeftTemplate, "help-text": helpText })));
 };
 /**
  * Global use

package/dist/collection/components/molecules/inputs/mg-input-textarea/mg-input-textarea.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-textarea/mg-input-textarea.js

@@ -1,8 +1,8 @@
-import { Component, Event, h, Prop, State } from '@stencil/core';
+import { Component, Event, h, Prop, State, 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 MgInputTextarea {
   constructor() {
     /************
@@ -61,9 +61,7 @@ export class MgInputTextarea {
      * Handle input event
      */
     this.handleInput = () => {
-      this.checkValidity();
       this.value = this.input.value;
-      this.valueChange.emit(this.value);
     };
     /**
      * Handle focus event
@@ -86,9 +84,45 @@ export class MgInputTextarea {
     /**
      * Get pattern validity
      * Pattern is not defined on textarea field : https://developer.mozilla.org/fr/docs/Web/HTML/Element/Textarea
-     * @returns {boolean}
+     *
+     * @returns {boolean} is pattern valid
      */
     this.getPatternValidity = () => this.pattern === undefined || new RegExp(`^${this.pattern}$`, 'u').test(this.value);
+    /**
+     * Check if input is valid
+     */
+    this.checkValidity = () => {
+      if (!this.readonly && this.input !== undefined) {
+        const validity = this.input.checkValidity && this.input.checkValidity() && this.getPatternValidity();
+        // 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;
+      // Does not match pattern
+      if (!this.valid && !this.getPatternValidity()) {
+        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 pattern configuration
      */
@@ -101,49 +135,41 @@ export class MgInputTextarea {
       }
     };
   }
-  /**
-   * Check if input is valid
-   */
-  checkValidity() {
-    if (!this.readonly && this.input !== undefined) {
-      const patternValidity = this.getPatternValidity();
-      const validity = this.input.checkValidity && this.input.checkValidity() && patternValidity;
-      // Set validity
-      this.valid = validity;
-      this.invalid = !validity;
-    }
+  handleValue(newValue) {
+    this.checkValidity();
+    this.valueChange.emit(newValue);
   }
   /**
-   * Check input errors
+   * Public method to display errors
+   *
+   * @returns {Promise<void>}
    */
-  checkError() {
-    const patternValidity = this.getPatternValidity();
-    // Set error message
-    this.errorMessage = undefined;
-    if (!this.valid && !patternValidity) {
-      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 displayError() {
+    this.checkValidity();
+    this.checkError();
   }
   /*************
    * Lifecycle *
    *************/
+  /**
+   * Check if component props are well configured on init
+   *
+   * @returns {ReturnType<typeof setTimeout>} timeout
+   */
   componentWillLoad() {
     this.validatePattern();
+    // 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: this.displayCharacterLeft, characterLeftTemplate: this.characterLeftTemplate, maxlength: this.maxlength, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: false },
       h("textarea", { class: "mg-input__box", value: this.value, id: this.identifier, name: this.name, placeholder: this.placeholder, title: this.placeholder, rows: this.rows, maxlength: this.maxlength, disabled: this.disabled, required: this.required, onInput: this.handleInput, onFocus: this.handleFocus, onBlur: this.handleBlur, ref: el => (this.input = el) })));
@@ -183,7 +209,7 @@ export class MgInputTextarea {
         "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."
@@ -201,7 +227,7 @@ export class MgInputTextarea {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Input name\nIf not set the value equals the identifier"
@@ -222,7 +248,7 @@ export class MgInputTextarea {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Input label\nRequired"
+        "text": "Input label"
       },
       "attribute": "label",
       "reflect": false
@@ -507,7 +533,7 @@ export class MgInputTextarea {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define input pattern to validate"
+        "text": "Define input valid state"
       },
       "attribute": "valid",
       "reflect": false
@@ -524,7 +550,7 @@ export class MgInputTextarea {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define input pattern error message"
+        "text": "Define input invalid state"
       },
       "attribute": "invalid",
       "reflect": false
@@ -542,12 +568,52 @@ export class MgInputTextarea {
       "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 watchers() { return [{
+      "propName": "value",
+      "methodName": "handleValue"
     }]; }
 }

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

@@ -2,12 +2,17 @@ import { h } from '@stencil/core';
 export default {
   component: 'mg-input-textarea',
   title: 'Molecules/Inputs/mg-input-textarea',
+  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;
@@ -21,7 +26,7 @@ const Template = args => {
   const helpText = args.helpText;
   delete args.helpText;
   // return element
-  return (h("mg-input-textarea", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "pattern-error-message": patternErrorMessage, "display-character-left": displayCharacterLeft, "character-left-template": characterLeftTemplate, "help-text": helpText })));
+  return (h("mg-input-textarea", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "pattern-error-message": patternErrorMessage, "display-character-left": displayCharacterLeft ? 'true' : 'false', "character-left-template": characterLeftTemplate, "help-text": helpText })));
 };
 export const MgInputTextarea = Template.bind({});
 MgInputTextarea.args = {

package/dist/collection/components/molecules/inputs/mg-input-toggle/mg-input-toggle.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 */
@@ -128,6 +129,9 @@
   line-height: inherit;
   cursor: pointer;
 }
+.mg-input__button-toggle:disabled {
+  cursor: default;
+}
 
 .mg-input__toggle-item-container {
   padding: 0.5rem 0.9rem;
@@ -209,5 +213,4 @@
 
 .mg-input.mg-input--toggle-disabled .mg-input__button-toggle {
   opacity: 0.3;
-  cursor: not-allowed;
 }

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

@@ -1,10 +1,13 @@
+/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import { Component, Event, h, Prop, State, Watch, Element } from '@stencil/core';
 import { MgInput } from '../MgInput';
 import { createID, ClassList, allItemsAreString } from '../../../../utils/components.utils';
 /**
  * type Option validation function
- * @param option
- * @returns {boolean}
+ *
+ * @param {ToggleValue} option radio option
+ * @returns {boolean} toggle option type is valid
  */
 const isOption = (option) => typeof option === 'object' && typeof option.title === 'string' && option.value !== undefined;
 export class MgInputToggle {
@@ -56,12 +59,16 @@ export class MgInputToggle {
     this.checked = false;
     /**
      * Change checked value
+     *
+     * @returns {void}
      */
     this.toggleChecked = () => {
-      this.setChecked(!this.checked);
+      this.checked = !this.checked;
     };
     /**
      * Slots validation
+     *
+     * @returns {void}
      */
     this.validateSlots = () => {
       const slots = Array.from(this.element.children);
@@ -75,6 +82,12 @@ export class MgInputToggle {
       }
     };
   }
+  handleValue(newValue) {
+    // Swich to the right option
+    this.setChecked();
+    // Emit value-change event
+    this.valueChange.emit(newValue);
+  }
   validateItems(newValue) {
     if (typeof newValue === 'object' && this.items.length !== 2) {
       throw new Error('<mg-input-toggle> prop "items" require 2 items.');
@@ -118,14 +131,14 @@ export class MgInputToggle {
     else
       this.classList.delete(this.classIsActive);
     // update value
-    this.value = this.options[this.checked ? 1 : 0].value;
-    this.valueChange.emit(this.value);
+    this.value = this.options[newValue ? 1 : 0].value;
   }
   /**
    * set checked state
-   * @param newValue?
+   *
+   * @returns {void}
    */
-  setChecked(newValue) {
+  setChecked() {
     // has "value" props type is not a boolean, it is bind/render as an attributes/props
     // true props will be represent by "true" string so we convert it has boolean
     // true attribute will be represent by "" string so we convert it has boolean
@@ -133,15 +146,7 @@ export class MgInputToggle {
     if (['', 'true'].includes(this.value) && this.options.find(option => option.value) !== undefined) {
       this.value = true;
     }
-    if (newValue !== undefined) {
-      this.checked = newValue;
-    }
-    else if (this.value === this.options[1].value) {
-      this.checked = true;
-    }
-    else {
-      this.checked = false;
-    }
+    this.checked = this.value === this.options[1].value;
   }
   /*************
    * Lifecycle *
@@ -152,6 +157,8 @@ export class MgInputToggle {
   componentWillLoad() {
     // Check items format
     this.validateItems(this.items);
+    // Check slots
+    this.validateSlots();
     // init checked value
     this.setChecked();
     // apply handler
@@ -159,14 +166,15 @@ export class MgInputToggle {
     this.handleIsIcon(this.isIcon);
     this.handleReadonly(this.readonly);
     this.handleDisabled(this.disabled);
-    this.validateSlots();
   }
+  /**
+   * Render
+   *
+   * @returns {HTMLElement} HTML Element
+   */
   render() {
-    var _a;
-    return (h(MgInput, { identifier: this.identifier, classList: this.classList, label: this.label, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: undefined, readonly: undefined, width: undefined, disabled: this.disabled, value: (_a = this.value) === null || _a === void 0 ? void 0 : _a.toString(), readonlyValue: undefined, tooltip: !this.readonly && this.tooltip, displayCharacterLeft: undefined, characterLeftTemplate: undefined, maxlength: undefined, helpText: this.helpText, errorMessage: undefined, isFieldset: false },
-      h("button", { type: "button", role: "switch", "aria-checked": this.checked, "aria-readonly": this.disabled || this.readonly, id: this.identifier, class: "mg-input__button-toggle", disabled: this.disabled || this.readonly, 
-        // eslint-disable-next-line react/jsx-no-bind
-        onClick: () => this.toggleChecked() },
+    return (h(MgInput, { identifier: this.identifier, classList: this.classList, label: this.label, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: undefined, readonly: undefined, width: undefined, disabled: this.disabled, value: this.value, readonlyValue: undefined, tooltip: !this.readonly && this.tooltip, displayCharacterLeft: undefined, characterLeftTemplate: undefined, maxlength: undefined, helpText: this.helpText, errorMessage: undefined, isFieldset: false },
+      h("button", { type: "button", role: "switch", "aria-checked": this.checked, "aria-readonly": this.disabled || this.readonly, id: this.identifier, class: "mg-input__button-toggle", disabled: this.disabled || this.readonly, onClick: this.toggleChecked },
         h("span", { "aria-hidden": "true", class: "mg-input__toggle-item-container" },
           h("slot", { name: "item-1" })),
         h("span", { "aria-hidden": "true", class: "mg-input__toggle-item-container" },
@@ -190,7 +198,7 @@ export class MgInputToggle {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Component value"
@@ -214,8 +222,11 @@ export class MgInputToggle {
       "required": true,
       "optional": false,
       "docs": {
-        "tags": [],
-        "text": "Items are the possible options to select\nRequired"
+        "tags": [{
+            "name": "returns",
+            "text": undefined
+          }],
+        "text": "Items are the possible options to select"
       }
     },
     "identifier": {
@@ -227,7 +238,7 @@ export class MgInputToggle {
         "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."
@@ -245,7 +256,7 @@ export class MgInputToggle {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Input name\nIf not set the value equals the identifier"
@@ -266,7 +277,7 @@ export class MgInputToggle {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Input label\nRequired"
+        "text": "Input label"
       },
       "attribute": "label",
       "reflect": false
@@ -315,7 +326,7 @@ export class MgInputToggle {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Define if toggle have on/off style"
@@ -333,7 +344,7 @@ export class MgInputToggle {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Define if toggle display icon"
@@ -426,16 +437,34 @@ export class MgInputToggle {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Emmited event when value change"
+        "text": "Emited event when value change"
       },
       "complexType": {
         "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 elementRef() { return "element"; }
   static get watchers() { return [{
+      "propName": "value",
+      "methodName": "handleValue"
+    }, {
       "propName": "items",
       "methodName": "validateItems"
     }, {

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

@@ -2,6 +2,7 @@ import { h } from '@stencil/core';
 export default {
   component: 'mg-input-toggle',
   title: 'Molecules/Inputs/mg-input-toggle',
+  parameters: { actions: { handles: ['value-change', 'input-valid'] } },
 };
 const args = {
   // Global
@@ -30,8 +31,12 @@ const args = {
 /**
  * 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) => {
   // Extract slot so it won't be render as an attribute
   const labelOnTop = args.labelOnTop;
   delete args.labelOnTop;

package/dist/collection/components/molecules/mg-form/mg-form.css

@@ -0,0 +1,15 @@
+.is-asterisk {
+  color: hsl(var(--color-danger));
+}
+
+.mg-form,
+.mg-form-group {
+  --mg-inputs-margin-bottom: 1.5rem;
+  --mg-inputs-title-horizontal-space: 3rem;
+  --mg-inputs-title-width: 15rem;
+  --mg-inputs-shrink: 0;
+}
+.mg-form.mg-form--all-required,
+.mg-form-group.mg-form--all-required {
+  --mg-input-title-display: none;
+}