@mgdis/mg-components 3.1.0 → 4.0.0

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

@@ -1,8 +1,7 @@
-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 MgInputTextarea {
   constructor() {
     /************
@@ -10,7 +9,9 @@ export class MgInputTextarea {
      ************/
     // classes
     this.classFocus = 'is-focused';
-    this.classError = InputClass.ERROR;
+    this.classHasDisplayCharacterLeft = 'mg-input--has-display-character-left';
+    // 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.
@@ -44,15 +45,19 @@ export class MgInputTextarea {
     /**
      * Define input width
      */
-    this.width = 'full';
+    this.mgWidth = 'full';
     /**
-     * Define input pattern error message
+     * Define the number of visible text lines for the control
      */
     this.rows = 3;
     /**
      * Define if component should display character left
      */
     this.displayCharacterLeft = true;
+    /**
+     * Define if input is resizable
+     */
+    this.resizable = 'none';
     /**
      * Component classes
      */
@@ -61,9 +66,11 @@ export class MgInputTextarea {
      * Handle input event
      */
     this.handleInput = () => {
-      this.checkValidity();
+      if (this.hasError) {
+        this.checkValidity();
+        this.checkError();
+      }
       this.value = this.input.value;
-      this.valueChange.emit(this.value);
     };
     /**
      * Handle focus event
@@ -79,16 +86,44 @@ export class MgInputTextarea {
       // Manage focus
       this.classList.delete(this.classFocus);
       this.classList = new ClassList(this.classList.classes);
-      // Check validity
-      this.checkValidity();
-      this.checkError();
+      // Display Error
+      this.displayError();
     };
     /**
      * 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 = this.messages.errors.required;
+      }
+    };
     /**
      * Validate pattern configuration
      */
@@ -101,52 +136,65 @@ 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
-   */
-  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);
+  validateDisplayCharacterLeft(newValue) {
+    if (newValue) {
+      this.classList.add(this.classHasDisplayCharacterLeft);
     }
     else {
-      this.classList.add(this.classError);
+      this.classList.delete(this.classHasDisplayCharacterLeft);
     }
   }
+  /**
+   * Public method to display errors
+   *
+   * @returns {Promise<void>}
+   */
+  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;
+    this.characterLeftId = `${this.identifier}-character-left`;
+    // Validate
+    this.validateDisplayCharacterLeft(this.displayCharacterLeft);
     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) })));
+    return (h(MgInput, { identifier: this.identifier, classList: this.classList, ariaDescribedbyIDs: [this.characterLeftId], 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: undefined, tooltip: this.tooltip, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: false },
+      h("div", { class: "mg-input__with-character-left" },
+        h("textarea", { class: {
+            'mg-input__box': true,
+            'mg-input__box--resizable': this.resizable === 'both',
+            'mg-input__box--resizable-horizontal': this.resizable === 'horizontal',
+            'mg-input__box--resizable-vertical': this.resizable === 'vertical',
+          }, 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) }),
+        this.displayCharacterLeft && this.maxlength && (h("mg-character-left", { identifier: this.characterLeftId, characters: this.value, maxlength: this.maxlength })))));
   }
   static get is() { return "mg-input-textarea"; }
   static get encapsulation() { return "shadow"; }
@@ -183,7 +231,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 +249,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 +270,7 @@ export class MgInputTextarea {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Input label\nRequired"
+        "text": "Input label"
       },
       "attribute": "label",
       "reflect": false
@@ -351,7 +399,7 @@ export class MgInputTextarea {
       "reflect": false,
       "defaultValue": "false"
     },
-    "width": {
+    "mgWidth": {
       "type": "any",
       "mutable": false,
       "complexType": {
@@ -370,7 +418,7 @@ export class MgInputTextarea {
         "tags": [],
         "text": "Define input width"
       },
-      "attribute": "width",
+      "attribute": "mg-width",
       "reflect": false,
       "defaultValue": "'full'"
     },
@@ -420,7 +468,7 @@ export class MgInputTextarea {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define input pattern error message"
+        "text": "Define the number of visible text lines for the control"
       },
       "attribute": "rows",
       "reflect": false,
@@ -461,23 +509,6 @@ export class MgInputTextarea {
       "reflect": false,
       "defaultValue": "true"
     },
-    "characterLeftTemplate": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [],
-        "text": "Template to use for characters left sentence"
-      },
-      "attribute": "character-left-template",
-      "reflect": false
-    },
     "helpText": {
       "type": "string",
       "mutable": false,
@@ -507,7 +538,7 @@ export class MgInputTextarea {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define input pattern to validate"
+        "text": "Define input valid state"
       },
       "attribute": "valid",
       "reflect": false
@@ -524,10 +555,28 @@ export class MgInputTextarea {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Define input pattern error message"
+        "text": "Define input invalid state"
       },
       "attribute": "invalid",
       "reflect": false
+    },
+    "resizable": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "'none' | 'both' | 'horizontal' | 'vertical'",
+        "resolved": "\"both\" | \"horizontal\" | \"none\" | \"vertical\"",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define if input is resizable"
+      },
+      "attribute": "resizable",
+      "reflect": false,
+      "defaultValue": "'none'"
     }
   }; }
   static get states() { return {
@@ -542,12 +591,56 @@ 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 elementRef() { return "element"; }
+  static get watchers() { return [{
+      "propName": "value",
+      "methodName": "handleValue"
+    }, {
+      "propName": "displayCharacterLeft",
+      "methodName": "validateDisplayCharacterLeft"
     }]; }
 }

package/dist/collection/components/molecules/inputs/mg-input-toggle/{mg-input-toggle.stories.js → doc/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/inputs/mg-input-toggle/mg-input-toggle.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,11 +80,22 @@
 .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));
+}
+
 /**
  * A11Y
  */
@@ -128,6 +138,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 +222,4 @@
 
 .mg-input.mg-input--toggle-disabled .mg-input__button-toggle {
   opacity: 0.3;
-  cursor: not-allowed;
 }