@mgdis/mg-components 3.1.0 → 4.0.0

package/dist/collection/components/molecules/inputs/MgInput.js

@@ -1,11 +1,11 @@
 import { h } from '@stencil/core';
-import { InputClass } from './MgInput.conf';
 /**
  * Apply in all input child node the aria-describedby attribute
- * @param children
- * @param ariaDescribedbyIDs
- * @param utils
- * @returns {VNode[]}
+ *
+ * @param {VNode[]} children Represent scoped elements
+ * @param {Set<string>} ariaDescribedbyIDs List of IDs
+ * @param {FunctionalUtilities} utils Stencil.js utils
+ * @returns {VNode[]} Children with aria-describedby attribute
  */
 const applyAriadescribedBy = (children, ariaDescribedbyIDs, utils) => utils.map(children, child => {
   if (['input', 'select', 'textarea'].includes(child.vtag)) {
@@ -18,7 +18,8 @@ const applyAriadescribedBy = (children, ariaDescribedbyIDs, utils) => utils.map(
 });
 /**
  * Add classes based on props
- * @param props
+ *
+ * @param {MgInputProps} props MgInput Interface Props
  */
 const manageClasses = (props) => {
   props.classList.add('mg-input');
@@ -26,24 +27,23 @@ const manageClasses = (props) => {
     props.classList.add('mg-input--label-on-top');
   if (props.readonly)
     props.classList.add('mg-input--readonly');
-  if (props.width !== undefined)
-    props.classList.add(`mg-input--width-${props.width}`);
-  if (props.readonly || props.disabled) {
-    props.classList.delete(InputClass.ERROR);
-  }
+  if (props.mgWidth !== undefined)
+    props.classList.add(`mg-input--width-${props.mgWidth}`);
 };
 /**
- * Define tagname based on props
- * @param isFieldset
+ * Get tagname
+ *
+ * @param {boolean} isFieldset is fieldset
  * @returns {string} tag name
  */
 const getTagName = (isFieldset) => (isFieldset ? 'fieldset' : 'div');
 /**
  * Get input template
- * @param props MgInput Interface Props
- * @param children Represent scoped elements
- * @param utils Stencil.js utils
- * @returns JSX template
+ *
+ * @param {MgInputProps} props MgInput Interface Props
+ * @param {VNode[]} children Represent scoped elements
+ * @param {FunctionalUtilities} utils Stencil.js utils
+ * @returns {VNode[]} input template
  */
 export const MgInput = (props, children, utils) => {
   /**
@@ -62,12 +62,7 @@ export const MgInput = (props, children, utils) => {
   /**
    * a11y IDs
    */
-  const ariaDescribedbyIDs = new Set();
-  // Character Left
-  const characterLeftId = `${props.identifier}-character-left`;
-  if (props.classList.has('is-focused') && props.displayCharacterLeft) {
-    ariaDescribedbyIDs.add(characterLeftId);
-  }
+  const ariaDescribedbyIDs = new Set(props.ariaDescribedbyIDs);
   // Help text
   const helpTextId = `${props.identifier}-help-text`;
   if (typeof props.helpText === 'string' && props.helpText !== '') {
@@ -105,15 +100,17 @@ export const MgInput = (props, children, utils) => {
   const TagName = getTagName(props.isFieldset);
   /**
    * Get tooltip node
-   * @returns mg-tooltip
+   *
+   * @returns {VNode[]} mg-tooltip
    */
   const getTooltip = () => (h("mg-tooltip", { identifier: `${props.identifier}-tooltip`, message: props.tooltip },
     h("mg-icon", { icon: "info-circle" })));
   /**
    * Get input title (label) node
-   * @returns mg-input-title
+   *
+   * @returns {VNode[]} mg-input-title
    */
-  const getInputTitle = () => (h("mg-input-title", { identifier: props.identifier, class: props.labelHide ? 'sr-only' : undefined, required: props.required, "is-legend": props.isFieldset }, props.label));
+  const getInputTitle = () => (h("mg-input-title", { identifier: props.identifier, class: props.labelHide ? 'sr-only' : undefined, required: props.required && !props.disabled, "is-legend": props.isFieldset }, props.label));
   return (h(TagName, { class: props.classList.join() },
     props.labelOnTop ? (h("div", { class: "mg-input__title" },
       getInputTitle(),
@@ -121,10 +118,9 @@ export const MgInput = (props, children, utils) => {
     props.readonly ? (h("div", { class: "mg-input__input-container" },
       h("strong", null, props.readonlyValue || props.value),
       children)) : (h("div", { class: "mg-input__input-container" },
-      h("div", { class: "mg-input__input" },
+      h("div", { class: { 'mg-input__input': true, 'mg-input__input--has-error': props.errorMessage !== undefined } },
         children,
         !props.labelOnTop && props.tooltip && getTooltip()),
-      props.displayCharacterLeft && props.maxlength && props.classList.has('is-focused') && (h("mg-character-left", { identifier: characterLeftId, characters: props.value, maxlength: props.maxlength, template: props.characterLeftTemplate })),
       props.helpText && h("div", { id: helpTextId, class: "mg-input__help-text", innerHTML: props.helpText }),
-      props.errorMessage && h("div", { id: helpTextErrorId, class: "mg-input__error", innerHTML: props.errorMessage, "aria-live": "assertive" })))));
+      props.errorMessage && !props.readonly && !props.disabled && (h("div", { id: helpTextErrorId, class: "mg-input__error", innerHTML: props.errorMessage, "aria-live": "assertive" }))))));
 };

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

@@ -2,12 +2,17 @@ import { h } from '@stencil/core';
 export default {
   component: 'mg-input-checkbox',
   title: 'Molecules/Inputs/mg-input-checkbox',
+  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) => {
   // 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-checkbox/mg-input-checkbox.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-checkbox/mg-input-checkbox.js

@@ -1,12 +1,12 @@
-import { Component, 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 { createID, ClassList } from '../../../../utils/components.utils';
-import { messages } from '../../../../locales';
-import { InputClass } from '../MgInput.conf';
+import { initLocales } from '../../../../locales';
 /**
  * type CheckboxItem validation function
- * @param CheckboxItem
- * @returns {boolean}
+ *
+ * @param {CheckboxItem} item Checkbox item
+ * @returns {boolean} match item expectations
  */
 const isCheckboxItem = (item) => typeof item === 'object' && typeof item.title === 'string' && (item.value === null || typeof item.value === 'boolean') && item.value !== undefined;
 export class MgInputCheckbox {
@@ -14,8 +14,6 @@ export class MgInputCheckbox {
     /************
      * Internal *
      ************/
-    // classes
-    this.classError = InputClass.ERROR;
     // HTML selector
     this.inputs = [];
     /**
@@ -58,7 +56,8 @@ export class MgInputCheckbox {
     this.checkboxItems = [];
     /**
      * Handle input event
-     * @param event
+     *
+     * @param {InputEvent} event input event
      */
     this.handleInput = (event) => {
       this.checkboxItems = this.checkboxItems.map(item => {
@@ -69,7 +68,6 @@ export class MgInputCheckbox {
       });
       this.value = this.checkboxItems.map(o => ({ value: o.value, title: o.title, disabled: o.disabled }));
       this.checkValidity();
-      this.valueChange.emit(this.value);
     };
     /**
      * Handle blur event
@@ -79,9 +77,34 @@ export class MgInputCheckbox {
       this.checkValidity();
       this.checkError();
     };
+    /**
+     * Check if input is valid
+     */
+    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
+     */
+    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());
   }
@@ -93,60 +116,53 @@ export class MgInputCheckbox {
         value: item.value,
         disabled: item.disabled,
       }));
+      this.valueChange.emit(newValue);
     }
     else {
       throw new Error('<mg-input-checkbox> prop "value" is required and all values must be the same type, CheckboxItem.');
     }
   }
-  handleReadOnly() {
-    this.classList.delete(this.classError);
-  }
   /**
-   * 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 values format
+    // Get locales
+    this.messages = initLocales(this.element).messages;
+    // Validate
     this.validateValue(this.value);
+    // 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: undefined, width: undefined, disabled: this.disabled, value: this.value && this.value.toString(), readonlyValue: undefined, tooltip: !this.readonly && 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.checkboxItems
+    return (h(MgInput, { identifier: this.identifier, classList: this.classList, ariaDescribedbyIDs: [], label: this.label, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: this.required, readonly: undefined, mgWidth: undefined, disabled: this.disabled, value: this.value && this.value.toString(), readonlyValue: undefined, tooltip: !this.readonly && 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.checkboxItems
         .filter(item => {
         return !this.readonly || item.value;
       })
-        .map(input => (h("li", { class: "mg-input__input-group" },
+        .map(input => (h("li", { class: { 'mg-input__input-group': true, 'mg-input__input-group--disabled': this.disabled || input.disabled } },
         h("input", { type: "checkbox", id: input.id, name: this.identifier, value: input.value && input.value.toString(), checked: Boolean(input.value), disabled: this.readonly || this.disabled || input.disabled, required: this.required, indeterminate: input.value === null, onInput: this.handleInput, onBlur: this.handleBlur, ref: el => this.inputs.push(el) }),
         h("label", { htmlFor: input.id }, input.title)))))));
   }
@@ -188,7 +204,7 @@ export class MgInputCheckbox {
         "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."
@@ -206,7 +222,7 @@ export class MgInputCheckbox {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Input name\nIf not set the value equals the identifier"
@@ -227,7 +243,7 @@ export class MgInputCheckbox {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Input label\nRequired"
+        "text": "Input label"
       },
       "attribute": "label",
       "reflect": false
@@ -385,7 +401,7 @@ export class MgInputCheckbox {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Force valid component"
+        "text": "Define input valid state"
       },
       "attribute": "valid",
       "reflect": false
@@ -402,7 +418,7 @@ export class MgInputCheckbox {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Force invalid component"
+        "text": "Define input invalid state"
       },
       "attribute": "invalid",
       "reflect": false
@@ -433,12 +449,46 @@ export class MgInputCheckbox {
           }
         }
       }
+    }, {
+      "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": "validateValue"
-    }, {
-      "propName": "readonly",
-      "methodName": "handleReadOnly"
     }]; }
 }

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

@@ -2,12 +2,17 @@ import { h } from '@stencil/core';
 export default {
   component: 'mg-input-date',
   title: 'Molecules/Inputs/mg-input-date',
+  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;

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