@mgdis/mg-components 3.1.0 → 4.0.0

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

@@ -1,8 +1,7 @@
-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 { createID, ClassList } from '../../../../utils/components.utils';
-import { messages } from '../../../../locales';
-import { InputClass } from '../MgInput.conf';
+import { initLocales } from '../../../../locales';
 export class MgInputText {
   constructor() {
     /************
@@ -10,7 +9,10 @@ export class MgInputText {
      ************/
     // classes
     this.classFocus = 'is-focused';
-    this.classError = InputClass.ERROR;
+    this.classIsInputGroupAppend = 'mg-input--is-input-group-append';
+    this.classHasIcon = 'mg-input--has-icon';
+    // 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.
@@ -48,7 +50,7 @@ export class MgInputText {
     /**
      * Define input width
      */
-    this.width = 'full';
+    this.mgWidth = 'full';
     /**
      * Define if component should display character left
      */
@@ -59,14 +61,20 @@ export class MgInputText {
     this.classList = new ClassList(['mg-input--text']);
     /**
      * Handle input event
+     *
+     * @returns {void}
      */
     this.handleInput = () => {
       this.checkValidity();
+      if (this.hasError) {
+        this.checkError();
+      }
       this.value = this.input.value;
-      this.valueChange.emit(this.value);
     };
     /**
      * Handle focus event
+     *
+     * @returns {void}
      */
     this.handleFocus = () => {
       this.classList.add(this.classFocus);
@@ -74,17 +82,52 @@ export class MgInputText {
     };
     /**
      * Handle blur event
+     *
+     * @returns {void}
      */
     this.handleBlur = () => {
       // Manage focus
       this.classList.delete(this.classFocus);
       this.classList = new ClassList(this.classList.classes);
-      // Check validity
-      this.checkValidity();
-      this.checkError();
+      // Display Error
+      this.displayError();
+    };
+    /**
+     * 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 = this.messages.errors.required;
+      }
     };
     /**
      * Validate patern configuration
+     *
+     * @returns {void}
      */
     this.validatePattern = () => {
       if (this.pattern &&
@@ -94,76 +137,89 @@ 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.classIsInputGroupAppend : 'mg-input--is-append-input-slot-content');
+      }
+      else if (slotAppendInput.filter(slot => slot.nodeName === 'MG-BUTTON').length > 1) {
+        this.classList.add(this.classIsInputGroupAppend);
+        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
-   */
-  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);
+  validateIcon(newValue) {
+    if (newValue !== undefined) {
+      this.classList.add(this.classHasIcon);
     }
     else {
-      this.classList.add(this.classError);
+      this.classList.delete(this.classHasIcon);
     }
   }
   /**
-   * Validate append slot
+   * Public method to play input focus
+   *
+   * @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 setFocus() {
+    this.input.focus();
+  }
+  /**
+   * 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() {
-    if (this.icon !== undefined) {
-      this.classList.add('mg-input--has-icon');
-    }
+    // Get locales
+    this.messages = initLocales(this.element).messages;
+    this.characterLeftId = `${this.identifier}-character-left`;
+    // Validate
+    this.validateIcon(this.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 }),
-      h("input", { type: this.type, class: "mg-input__box", value: this.value, id: this.identifier, name: this.name, placeholder: this.placeholder, title: this.placeholder, maxlength: this.maxlength, disabled: this.disabled, required: this.required, pattern: this.pattern, 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", style: {
+          '--mg-character-left-message-length': (this.displayCharacterLeft
+            ? (this.maxlength - (this.value || '').length).toString().length + this.maxlength.toString().length + 1
+            : 0).toString(),
+        } },
+        this.icon !== undefined && h("mg-icon", { icon: this.icon }),
+        h("input", { type: this.type, class: "mg-input__box", value: this.value, id: this.identifier, name: this.name, placeholder: this.placeholder, title: this.placeholder, maxlength: this.maxlength, disabled: this.disabled, required: this.required, pattern: this.pattern, 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 }))),
       h("slot", { name: "append-input" })));
   }
   static get is() { return "mg-input-text"; }
@@ -201,7 +257,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 +275,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 +296,7 @@ export class MgInputText {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Input label\nRequired"
+        "text": "Input label"
       },
       "attribute": "label",
       "reflect": false
@@ -404,7 +460,7 @@ export class MgInputText {
       "reflect": false,
       "defaultValue": "false"
     },
-    "width": {
+    "mgWidth": {
       "type": "any",
       "mutable": false,
       "complexType": {
@@ -423,7 +479,7 @@ export class MgInputText {
         "tags": [],
         "text": "Define input width"
       },
-      "attribute": "width",
+      "attribute": "mg-width",
       "reflect": false,
       "defaultValue": "'full'"
     },
@@ -496,23 +552,6 @@ export class MgInputText {
       "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,
@@ -542,7 +581,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 +598,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 +616,75 @@ 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"
+    }, {
+      "propName": "icon",
+      "methodName": "validateIcon"
+    }]; }
 }

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

@@ -2,12 +2,23 @@ import { h } from '@stencil/core';
 export default {
   component: 'mg-input-textarea',
   title: 'Molecules/Inputs/mg-input-textarea',
+  argTypes: {
+    mgWidth: {
+      options: [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;
@@ -16,12 +27,12 @@ const Template = args => {
   delete args.patternErrorMessage;
   const displayCharacterLeft = args.displayCharacterLeft;
   delete args.displayCharacterLeft;
-  const characterLeftTemplate = args.characterLeftTemplate;
-  delete args.characterLeftTemplate;
   const helpText = args.helpText;
   delete args.helpText;
+  const mgWidth = args.mgWidth;
+  delete args.mgWidth;
   // 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', "help-text": helpText, "mg-width": mgWidth })));
 };
 export const MgInputTextarea = Template.bind({});
 MgInputTextarea.args = {
@@ -42,11 +53,11 @@ MgInputTextarea.args = {
   pattern: undefined,
   patternErrorMessage: undefined,
   rows: 3,
+  mgWidth: 'full',
   // Tooltip
   tooltip: 'This is a tooltip',
   // Nb Char Left
   displayCharacterLeft: true,
-  characterLeftTemplate: '{counter} characters left.',
   // Help Text
   helpText: 'Help text with html <strong>bold</strong>, <em>italic</em>.',
 };

package/dist/collection/components/molecules/inputs/mg-input-textarea/mg-input-textarea.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));
+}
+
 /**
  * Style for input "box":
  * - input[type="text"]
@@ -106,6 +116,7 @@
   font-family: inherit;
   color: hsl(var(--color-dark));
   font-size: var(--font-size);
+  text-align: var(--mg-inputs-text-align, left);
 }
 .mg-input__box::placeholder {
   color: var(--mg-inputs-color);
@@ -145,6 +156,23 @@
   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-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-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);
 }
@@ -174,13 +202,14 @@
 }
 
 /**
- * Manage display mg-character-left on focus
+ * Set mg-character-left with inputs
  */
 .mg-input mg-character-left {
-  display: none;
+  opacity: 0.6;
+  font-size: 1.1rem;
 }
-.mg-input.is-focused mg-character-left {
-  display: block;
+.mg-input.mg-input--has-display-character-left .mg-input__input + .mg-input__help-text, .mg-input.mg-input--has-display-character-left .mg-input__input + .mg-input__error {
+  margin-top: 0;
 }
 
 /**
@@ -206,7 +235,34 @@
 
 /* Component Custom Style */
 .mg-input .mg-input__box {
+  display: block;
   height: auto;
+  resize: none;
+}
+.mg-input .mg-input__box.mg-input__box--resizable {
+  resize: both;
+}
+.mg-input .mg-input__box.mg-input__box--resizable-horizontal {
+  resize: horizontal;
+}
+.mg-input .mg-input__box.mg-input__box--resizable-vertical {
+  resize: vertical;
+}
+
+/**
+  * Character left
+  */
+.mg-input__with-character-left {
+  width: 100%;
+}
+.mg-input__with-character-left mg-character-left {
+  display: block;
+  visibility: hidden;
+  margin-top: 0.2rem;
+  text-align: end;
+}
+.mg-input.is-focused .mg-input__with-character-left mg-character-left {
+  visibility: visible;
 }
 
 /* Firefox selector */