@mgdis/mg-components 3.1.0 → 4.0.0

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 {
@@ -16,6 +19,8 @@ export class MgInputToggle {
     this.classReadonly = 'mg-input--toggle-readonly';
     this.classDisabled = 'mg-input--toggle-disabled';
     this.classIsActive = 'mg-input--toggle-is-active';
+    this.classOnOff = 'mg-input--toggle-on-off';
+    this.classIcon = 'mg-input--toggle-icon';
     /**
      * Identifier is used for the element ID (id is a reserved prop in Stencil.js)
      * If not set, it will be created.
@@ -56,12 +61,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 +84,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.');
@@ -93,11 +108,15 @@ export class MgInputToggle {
   }
   handleIsOnOff(newValue) {
     if (newValue)
-      this.classList.add(`mg-input--toggle-on-off`);
+      this.classList.add(this.classOnOff);
+    else
+      this.classList.delete(this.classOnOff);
   }
   handleIsIcon(newValue) {
     if (newValue)
-      this.classList.add(`mg-input--toggle-icon`);
+      this.classList.add(this.classIcon);
+    else
+      this.classList.delete(this.classIcon);
   }
   handleReadonly(newValue) {
     if (newValue)
@@ -118,14 +137,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 +152,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 +163,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 +172,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, ariaDescribedbyIDs: [], label: this.label, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: undefined, readonly: undefined, mgWidth: undefined, disabled: this.disabled, value: this.value, readonlyValue: undefined, tooltip: !this.readonly && this.tooltip, helpText: this.helpText, errorMessage: undefined, isFieldset: false },
+      h("button", { type: "button", role: "switch", "aria-checked": this.checked.toString(), "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 +204,7 @@ export class MgInputToggle {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Component value"
@@ -214,8 +228,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 +244,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 +262,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 +283,7 @@ export class MgInputToggle {
       "optional": false,
       "docs": {
         "tags": [],
-        "text": "Input label\nRequired"
+        "text": "Input label"
       },
       "attribute": "label",
       "reflect": false
@@ -315,7 +332,7 @@ export class MgInputToggle {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Define if toggle have on/off style"
@@ -333,7 +350,7 @@ export class MgInputToggle {
         "references": {}
       },
       "required": false,
-      "optional": true,
+      "optional": false,
       "docs": {
         "tags": [],
         "text": "Define if toggle display icon"
@@ -426,16 +443,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/mg-form/doc/mg-form.stories.js

@@ -0,0 +1,58 @@
+import { h } from '@stencil/core';
+export default {
+  component: 'mg-form',
+  title: 'Molecules/mg-form',
+  parameters: { actions: { handles: ['form-valid'] } },
+};
+const args = {
+  identifier: 'identifier',
+  name: 'input-name',
+  readonly: false,
+  disabled: false,
+};
+/**
+ * 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
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const Template = (args) => {
+  let form;
+  let submit;
+  return (h("mg-form", Object.assign({}, args, { ref: el => {
+      form = el;
+      form.addEventListener('form-valid', e => {
+        submit.disabled = !e.detail;
+      });
+    } }),
+    h("mg-input-checkbox", { identifier: "mg-input-checkbox", label: "mg-input-checkbox label", value: [
+        { title: 'oui', value: false },
+        { title: 'non', value: false },
+      ] }),
+    h("mg-input-date", { required: true, identifier: "mg-input-date", label: "mg-input-date label" }),
+    h("mg-input-numeric", { identifier: "mg-input-numeric", label: "mg-input-numeric label" }),
+    h("mg-input-password", { identifier: "mg-input-password", label: "mg-input-password label" }),
+    h("mg-input-radio", { identifier: "mg-input-radio", label: "mg-input-radio label", items: ['blu', 'bli', 'bla', 'blo'] }),
+    h("mg-input-select", { identifier: "mg-input-select", label: "mg-input-select label", items: ['blu', 'bli', 'bla', 'blo'] }),
+    h("mg-input-text", { identifier: "mg-input-text", label: "mg-input-text label" }),
+    h("mg-input-textarea", { identifier: "mg-input-textarea", label: "mg-input-textarea label" }),
+    h("mg-input-toggle", { identifier: "mg-input-toggle", label: "mg-input-toggle label", items: [
+        { title: 'non', value: false },
+        { title: 'oui', value: true },
+      ] },
+      h("span", { slot: "item-1" }, "non"),
+      h("span", { slot: "item-2" }, "oui")),
+    h("div", { slot: "actions", class: "mg-group-elements mg-group-elements--align-right" },
+      h("mg-button", { id: "can-submit", disabled: true, ref: e => {
+          submit = e;
+        } }, "Submit"),
+      h("mg-button", { variant: "secondary", 
+        // eslint-disable-next-line react/jsx-no-bind
+        onClick: () => {
+          form.displayError();
+        } }, "Display errors"))));
+};
+export const MgForm = Template.bind({});
+MgForm.args = Object.assign({}, args);

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

@@ -0,0 +1,19 @@
+.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;
+}
+.mg-form > p,
+.mg-form-group > p {
+  font-size: 1.2rem;
+}

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

@@ -0,0 +1,271 @@
+import { Component, Element, Event, h, Method, Prop, State } from '@stencil/core';
+import { createID, ClassList } from '../../../utils/components.utils';
+import { initLocales } from '../../../locales';
+export class MgForm {
+  constructor() {
+    /**
+     * Identifier is used for the element ID (id is a reserved prop in Stencil.js)
+     * If not set, it will be created.
+     */
+    this.identifier = createID('mg-form');
+    /**
+     * Input name
+     * If not set the value equals the identifier
+     */
+    this.name = this.identifier;
+    /**
+     * Define if form is readonly
+     */
+    this.readonly = false;
+    /**
+     * Define if form is disabled
+     */
+    this.disabled = false;
+    /**
+     * Component classes
+     */
+    this.classList = new ClassList(['mg-form']);
+    /**
+     * Define required message based on mg-inputs required elements
+     * Also
+     *
+     * @returns {void}
+     */
+    this.setRequiredMessage = () => {
+      // Get required fields
+      const requiredInputs = this.mgInputs.filter(input => input.required && !input.disabled && !this.disabled);
+      // All fields are required
+      // mg-input-toggle can not be required
+      if (requiredInputs.length > 0 && requiredInputs.length === this.mgInputs.filter(input => input.nodeName !== 'MG-INPUT-TOGGLE').length) {
+        this.requiredMessage = this.messages.form.allRequired;
+        this.classList.add('mg-form--all-required');
+      }
+      // Some fields are required
+      else if (requiredInputs.length > 0) {
+        this.requiredMessage = this.messages.form.required;
+      }
+    };
+    /**
+     * Check if form is valid
+     *
+     * @returns {void}
+     */
+    this.checkValidity = () => {
+      const validity = !this.mgInputs.some(input => input.invalid);
+      this.valid = validity;
+      this.invalid = !validity;
+      this.formValid.emit(validity);
+    };
+  }
+  /**
+   * Public method to display errors
+   *
+   * @returns {Promise<void>}
+   */
+  async displayError() {
+    if (!this.readonly) {
+      this.mgInputs.forEach(input => {
+        input.displayError && input.displayError();
+      });
+      this.checkValidity();
+    }
+  }
+  /*************
+   * Lifecycle *
+   *************/
+  /**
+   * Check if component props are well configured on init
+   *
+   * @returns {void}
+   */
+  componentWillLoad() {
+    // Get locales
+    this.messages = initLocales(this.element).messages;
+    // Get slotted mgIputs
+    this.mgInputs = Array.from(this.element.querySelectorAll('*')).filter((node) => node.nodeName.startsWith('MG-INPUT-'));
+    // Define required message
+    this.setRequiredMessage();
+    // Check validity when slotted mgImputs are ready
+    Promise.all(this.mgInputs.map(async (input) => {
+      // Set inputs readonly or disabled based on form configuration
+      // Othewise listen to events
+      if (this.readonly)
+        input.readonly = true;
+      else if (this.disabled)
+        input.disabled = true;
+      else
+        input.addEventListener('input-valid', this.checkValidity);
+      await input.componentOnReady();
+    })).then(() => {
+      this.checkValidity();
+    });
+  }
+  /**
+   * Render
+   *
+   * @returns {HTMLElement} HTML Element
+   */
+  render() {
+    return (h("form", { class: this.classList.join(), id: this.identifier, name: this.name },
+      this.requiredMessage && h("p", { innerHTML: this.requiredMessage }),
+      h("slot", null),
+      !this.readonly && !this.disabled && h("slot", { name: "actions" })));
+  }
+  static get is() { return "mg-form"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["mg-form.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["mg-form.css"]
+  }; }
+  static get properties() { return {
+    "identifier": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "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."
+      },
+      "attribute": "identifier",
+      "reflect": false,
+      "defaultValue": "createID('mg-form')"
+    },
+    "name": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Input name\nIf not set the value equals the identifier"
+      },
+      "attribute": "name",
+      "reflect": false,
+      "defaultValue": "this.identifier"
+    },
+    "readonly": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define if form is readonly"
+      },
+      "attribute": "readonly",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "disabled": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define if form is disabled"
+      },
+      "attribute": "disabled",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "valid": {
+      "type": "boolean",
+      "mutable": true,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define form valid state"
+      },
+      "attribute": "valid",
+      "reflect": false
+    },
+    "invalid": {
+      "type": "boolean",
+      "mutable": true,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define form invalid state"
+      },
+      "attribute": "invalid",
+      "reflect": false
+    }
+  }; }
+  static get states() { return {
+    "classList": {}
+  }; }
+  static get events() { return [{
+      "method": "formValid",
+      "name": "form-valid",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": "Emitted event on form validity check\nTells if form is valid or not"
+      },
+      "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"; }
+}

package/dist/collection/components/molecules/mg-message/{mg-message.stories.js → doc/mg-message.stories.js}

@@ -1,5 +1,5 @@
 import { h } from '@stencil/core';
-import { variants } from './mg-message.conf';
+import { variants } from '../mg-message.conf';
 export default {
   component: 'mg-message',
   title: 'Molecules/mg-message',
@@ -7,8 +7,12 @@ export default {
     variant: {
       options: variants,
       control: { type: 'select' },
+      table: {
+        defaultValue: { summary: variants[0] },
+      },
     },
   },
+  parameters: { actions: { handles: ['component-show', 'component-hide'] } },
 };
 /**
  * 1. camelCase arguments must be written in the template, for exemple labelOnTop must be placed in the template as label-on-top={args.labelOnTop}
@@ -40,4 +44,4 @@ MgMessage.args = {
 export const WithCloseButton = Template.bind({});
 WithCloseButton.args = Object.assign(Object.assign({}, MgMessage.args), { variant: 'danger', closeButton: true });
 export const WithActions = Template.bind({});
-WithActions.args = Object.assign(Object.assign({}, MgMessage.args), { variant: 'warning', slotActions: `<div slot="actions" class="mg-group-elements mg-group-elements--align-right"><mg-button>Primary</mg-button><mg-button variant="secondary">Secondary</mg-button></div>` });
+WithActions.args = Object.assign(Object.assign({}, MgMessage.args), { variant: 'warning', slotActions: `<div class="mg-group-elements mg-group-elements--align-right"><mg-button>Primary</mg-button><mg-button variant="secondary">Secondary</mg-button></div>` });

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

@@ -6,7 +6,7 @@
   overflow: hidden;
   background-color: white;
   border-radius: var(--mg-message-border-radius);
-  box-shadow: 0 0.3rem 0.8rem 0 hsla(var(--color-dark), 0.1);
+  box-shadow: var(--box-shadow);
 }
 .mg-message::before {
   content: "";