@mgdis/mg-components 3.1.0 → 4.0.0

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

@@ -1,14 +1,13 @@
-import { Component, Element, Event, h, Prop, State, Watch } from '@stencil/core';
+import { Component, Element, Event, h, Prop, State, Watch, Method } from '@stencil/core';
 import { MgInput } from '../MgInput';
 import { types, InputError } from './mg-input-numeric.conf';
 import { createID, ClassList } from '../../../../utils/components.utils';
-import { messages } from '../../../../locales';
+import { initLocales } from '../../../../locales/';
 import { localeCurrency, localeNumber } from '../../../../utils/locale.utils';
-import { InputClass } from '../MgInput.conf';
 export class MgInputNumeric {
   constructor() {
-    // 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,6 +38,10 @@ export class MgInputNumeric {
      * Define numeric type
      */
     this.type = types[0];
+    /**
+     * Define currency
+     */
+    this.currency = 'USD';
     /**
      * Override integer length
      * integer is the number before the decimal point
@@ -53,33 +56,87 @@ export class MgInputNumeric {
      * Component classes
      */
     this.classList = new ClassList(['mg-input--numeric']);
+    /**
+     * Define if input has focus
+     */
+    this.hasFocus = false;
     /**
      * Handle input event
+     *
+     * @returns {void}
      */
     this.handleInput = () => {
       // Check validity
       this.checkValidity();
+      if (this.hasError) {
+        this.checkError();
+      }
       this.value = this.input.value;
     };
     /**
      * Handle focus event
+     *
+     * @returns {void}
      */
     this.handleFocus = () => {
-      this.displayValue = this.value;
+      this.hasFocus = true;
     };
     /**
      * Handle blur event
+     *
+     * @returns {void}
      */
     this.handleBlur = () => {
-      // Check validity
-      this.checkValidity();
-      this.checkError();
-      // Display readonly value
-      this.displayValue = this.readonlyValue;
+      // Display Error
+      this.displayError();
+      this.hasFocus = false;
+    };
+    /**
+     * Check if input is valid
+     *
+     * @returns {void}
+     */
+    this.checkValidity = () => {
+      if (!this.readonly) {
+        const validity = this.getInputError() === null;
+        // Set validity
+        this.valid = validity;
+        this.invalid = !validity;
+        //Send event
+        this.inputValid.emit(validity);
+      }
+    };
+    /**
+     * Set error message
+     *
+     * @returns {void}
+     */
+    this.setErrorMessage = () => {
+      const inputError = this.getInputError();
+      if (inputError === InputError.REQUIRED) {
+        this.errorMessage = this.messages.errors[inputError];
+      }
+      else {
+        this.errorMessage = this.messages.errors.numeric[inputError].replace('{min}', `${this.formatValue(this.min)}`).replace('{max}', `${this.formatValue(this.max)}`);
+      }
+    };
+    /**
+     * Check input errors
+     *
+     * @returns {void}
+     */
+    this.checkError = () => {
+      // Set error message
+      this.errorMessage = undefined;
+      // Update class
+      if (!this.valid) {
+        this.setErrorMessage();
+      }
     };
     /**
-     * get input error code
-     * @returns {null | InputError}
+     * Get input error code
+     *
+     * @returns {null | InputError} error code
      */
     this.getInputError = () => {
       let inputError = null;
@@ -90,7 +147,7 @@ export class MgInputNumeric {
         inputError = InputError.REQUIRED;
       }
       // Min & Max
-      if (this.min !== undefined && this.numericValue < this.min && this.max === undefined) {
+      else if (this.min !== undefined && this.numericValue < this.min && this.max === undefined) {
         // Only a min value is set
         inputError = InputError.MIN;
       }
@@ -106,10 +163,22 @@ export class MgInputNumeric {
     };
     /**
      * Format value based on type
-     * @param value {number}
+     *
+     * @param {number} value value to format
      * @returns {string} formated local value
      */
-    this.formatValue = (value) => (this.type === 'currency' ? localeCurrency(value) : localeNumber(value));
+    this.formatValue = (value) => (this.type === 'currency' ? localeCurrency(value, this.locale, this.currency) : localeNumber(value, this.locale));
+    /**
+     * Validate append slot
+     *
+     * @returns {void}
+     */
+    this.validateAppendSlot = () => {
+      const slotAppendInput = this.element.querySelector('[slot="append-input"]');
+      if (slotAppendInput !== null) {
+        this.classList.add(slotAppendInput.nodeName === 'MG-BUTTON' ? 'mg-input--is-input-group-append' : 'mg-input--is-append-input-slot-content');
+      }
+    };
   }
   validateValue(newValue) {
     if (newValue !== undefined && newValue !== null) {
@@ -134,7 +203,7 @@ export class MgInputNumeric {
       // emit numeric value
       this.numericValue = this.value !== '' && this.value !== null ? parseFloat(this.value.replace(',', '.')) : null;
       this.valueChange.emit(this.numericValue);
-      // Set readOnlyValue
+      // Set readonlyValue
       this.readonlyValue = this.numericValue !== null ? this.formatValue(this.numericValue) : '';
     }
   }
@@ -142,7 +211,6 @@ export class MgInputNumeric {
     if (!types.includes(newValue)) {
       throw new Error(`<mg-input-numeric> prop "type" must be one of : ${types.join(', ')}`);
     }
-    this.classList.add(`mg-input--numeric--${this.type}`);
   }
   validateIntegerLength(newValue) {
     if (newValue < 1) {
@@ -155,80 +223,58 @@ export class MgInputNumeric {
     }
   }
   /**
-   * Check if input is valid
-   */
-  checkValidity() {
-    if (!this.readonly) {
-      const validity = this.getInputError() === null;
-      // Set validity
-      this.valid = validity;
-      this.invalid = !validity;
-    }
-  }
-  /**
-   * Set error message
-   */
-  setErrorMessage() {
-    const inputError = this.getInputError();
-    if (inputError === InputError.REQUIRED) {
-      this.errorMessage = messages.errors[inputError];
-    }
-    else {
-      this.errorMessage = messages.errors.numeric[inputError].replace('{min}', `${this.formatValue(this.min)}`).replace('{max}', `${this.formatValue(this.max)}`);
-    }
-  }
-  /**
-   * Check input errors
+   * Public method to display errors
+   *
+   * @returns {Promise<void>}
    */
-  checkError() {
-    // Set error message
-    this.errorMessage = undefined;
-    // Update class
-    if (!this.valid) {
-      this.setErrorMessage();
-      this.classList.add(this.classError);
-    }
-    else {
-      this.classList.delete(this.classError);
-    }
+  async displayError() {
+    this.checkValidity();
+    this.checkError();
+    this.hasError = this.invalid;
   }
   /**
-   * Validate append slot
+   * Displayed value in input
+   * Change on focus/blur
+   *
+   * @returns {string} display value
    */
-  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);
-    }
+  displayValue() {
+    return this.hasFocus ? this.value : this.readonlyValue;
   }
   /*************
    * Lifecycle *
    *************/
+  /**
+   * Check if component props are well configured on init
+   *
+   * @returns {ReturnType<typeof setTimeout>} timeout
+   */
   componentWillLoad() {
+    // Get locales
+    const locales = initLocales(this.element);
+    this.locale = locales.locale;
+    this.messages = locales.messages;
+    // Validate
     this.validateValue(this.value);
-    // Set displayed value
-    this.displayValue = this.readonlyValue;
     this.validateType(this.type);
     this.validateIntegerLength(this.integerLength);
     this.validateDecimalLength(this.decimalLength);
+    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);
   }
   /**
-   * Check if component props are well configured on init
+   * 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.readonlyValue, tooltip: this.tooltip, displayCharacterLeft: undefined, characterLeftTemplate: undefined, maxlength: undefined, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: false },
-      h("input", { type: "text", class: "mg-input__box", value: this.displayValue, id: this.identifier, name: this.name, placeholder: this.placeholder, title: this.placeholder, 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: [], 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.readonlyValue, tooltip: this.tooltip, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: false },
+      h("input", { type: "text", class: "mg-input__box", value: this.displayValue(), id: this.identifier, name: this.name, placeholder: this.placeholder, title: this.placeholder, disabled: this.disabled, required: this.required, onInput: this.handleInput, onFocus: this.handleFocus, onBlur: this.handleBlur, ref: el => (this.input = el) }),
       h("slot", { name: "append-input" })));
   }
   static get is() { return "mg-input-numeric"; }
@@ -266,7 +312,7 @@ export class MgInputNumeric {
         "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."
@@ -284,7 +330,7 @@ export class MgInputNumeric {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Input name\nIf not set the value equals the identifier"
@@ -305,7 +351,7 @@ export class MgInputNumeric {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Input label\nRequired"
+        "text": "Input label"
       },
       "attribute": "label",
       "reflect": false
@@ -416,7 +462,7 @@ export class MgInputNumeric {
       "reflect": false,
       "defaultValue": "false"
     },
-    "width": {
+    "mgWidth": {
       "type": "any",
       "mutable": false,
       "complexType": {
@@ -435,7 +481,7 @@ export class MgInputNumeric {
         "tags": [],
         "text": "Define input width"
       },
-      "attribute": "width",
+      "attribute": "mg-width",
       "reflect": false
     },
     "tooltip": {
@@ -490,6 +536,24 @@ export class MgInputNumeric {
       "reflect": false,
       "defaultValue": "types[0]"
     },
+    "currency": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define currency"
+      },
+      "attribute": "currency",
+      "reflect": false,
+      "defaultValue": "'USD'"
+    },
     "max": {
       "type": "number",
       "mutable": false,
@@ -598,7 +662,7 @@ export class MgInputNumeric {
   static get states() { return {
     "classList": {},
     "errorMessage": {},
-    "displayValue": {}
+    "hasFocus": {}
   }; }
   static get events() { return [{
       "method": "valueChange",
@@ -608,14 +672,50 @@ export class MgInputNumeric {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Emmited event when value change"
+        "text": "Emited event when value change"
       },
       "complexType": {
         "original": "number",
         "resolved": "number",
         "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",

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

@@ -2,20 +2,33 @@ import { h } from '@stencil/core';
 export default {
   component: 'mg-input-password',
   title: 'Molecules/Inputs/mg-input-password',
+  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;
   delete args.labelHide;
   const helpText = args.helpText;
   delete args.helpText;
+  const mgWidth = args.mgWidth;
+  delete args.mgWidth;
   // return element
-  return h("mg-input-password", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "help-text": helpText }));
+  return h("mg-input-password", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "help-text": helpText, "mg-width": mgWidth }));
 };
 /**
  * Global use
@@ -36,6 +49,7 @@ MgInputPassword.args = {
   required: true,
   disabled: false,
   readonly: false,
+  mgWidth: 'full',
   // Tooltip
   tooltip: 'This is a tooltip',
   // Help Text

package/dist/collection/components/molecules/inputs/mg-input-password/mg-input-password.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);
 }