@mgdis/mg-components 3.1.0 → 3.2.0

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

@@ -0,0 +1,269 @@
+import { Component, Element, Event, h, Method, Prop, State } from '@stencil/core';
+import { createID, ClassList } from '../../../utils/components.utils';
+import { messages } 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 = messages.form.allRequired;
+        this.classList.add('mg-form--all-required');
+      }
+      // Some fields are required
+      else if (requiredInputs.length > 0) {
+        this.requiredMessage = 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 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-form/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-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: "";

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

@@ -18,7 +18,7 @@ export class MgMessage {
     /**
      * Message variant
      */
-    this.variant = variants[0];
+    this.variant = variants[0]; // info
     /**
      * Define if message has a cross button
      * RG 01: https://jira.mgdis.fr/browse/PDA9-140
@@ -55,6 +55,8 @@ export class MgMessage {
     };
     /**
      * Get icon corresponding to variant
+     *
+     * @returns {string} icon
      */
     this.getIcon = () => {
       switch (this.variant) {
@@ -120,6 +122,11 @@ export class MgMessage {
     this.validateDelay(this.delay);
     this.validateHide(this.hide);
   }
+  /**
+   * Render
+   *
+   * @returns {HTMLElement} HTML Element
+   */
   render() {
     return (h("div", { id: this.identifier, class: this.classList.join(), role: this.variant === 'info' ? 'status' : 'alert' },
       h("span", { class: "mg-message__icon" },
@@ -198,7 +205,7 @@ export class MgMessage {
     },
     "closeButton": {
       "type": "boolean",
-      "mutable": false,
+      "mutable": true,
       "complexType": {
         "original": "boolean",
         "resolved": "boolean",
@@ -245,7 +252,7 @@ export class MgMessage {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Emmited event when message is diplayed"
+        "text": "Emited event when message is diplayed"
       },
       "complexType": {
         "original": "string",
@@ -260,7 +267,7 @@ export class MgMessage {
       "composed": true,
       "docs": {
         "tags": [],
-        "text": "Emmited event when message is hidden"
+        "text": "Emited event when message is hidden"
       },
       "complexType": {
         "original": "string",

package/dist/collection/components/molecules/mg-message/mg-message.stories.js

@@ -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-modal/mg-modal.css

@@ -0,0 +1,54 @@
+.mg-modal {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  position: fixed;
+  top: 0;
+  right: 0;
+  bottom: 0;
+  left: 0;
+  z-index: 1000;
+  padding: 2rem 0;
+  background-color: hsla(var(--color-dark), 50%);
+}
+.mg-modal__dialog {
+  display: flex;
+  flex-direction: column;
+  flex: none;
+  /* IE FIX */
+  align-self: center;
+  row-gap: 3rem;
+  padding: 1.5rem 2.5rem;
+  width: 60rem;
+  height: fit-content;
+  max-width: 100%;
+  max-height: 100%;
+  box-sizing: border-box;
+  background-color: hsl(var(--color-light));
+  box-shadow: var(--box-shadow);
+  border-radius: var(--mg-modal-border-radius);
+}
+.mg-modal__header {
+  margin-bottom: 0.5rem;
+}
+.mg-modal__title {
+  margin: 0;
+  font-family: var(--font-family-heading);
+  font-size: var(--mg-modal-title-font-size);
+  font-weight: 600;
+}
+.mg-modal__content {
+  overflow-y: auto;
+}
+.mg-modal__close-button {
+  float: right;
+  height: var(--mg-modal-title-font-size);
+  margin-top: calc((var(--default-size) - var(--mg-modal-title-font-size) * var(--line-height)) / 2 * -1);
+  margin-right: calc((var(--default-size) - var(--mg-icon-regular-size)) / 2 * -1);
+}
+.mg-modal .mg-modal__content ::slotted(*) {
+  font-size: var(--mg-modal-content-font-size);
+}
+.mg-modal.mg-modal--hide {
+  display: none;
+}

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

@@ -0,0 +1,233 @@
+import { Component, h, Prop, State, Watch, Element, Event, Listen } from '@stencil/core';
+import { createID, ClassList } from '../../../utils/components.utils';
+import { messages } from '../../../locales';
+export class MgModal {
+  constructor() {
+    /************
+     * Internal *
+     ************/
+    this.closeButtonId = '';
+    this.titleId = '';
+    /**
+     * 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-modal');
+    /**
+     * Define if modal has a cross button
+     */
+    this.closeButton = false;
+    /**
+     * Define if modal is hidden
+     */
+    this.hide = false;
+    /**
+     * Define if component is using actions slot
+     */
+    this.hasActions = false;
+    /**
+     * Define if component is using content slot
+     */
+    this.hasContent = false;
+    /**
+     * Component classes
+     */
+    this.classList = new ClassList(['mg-modal']);
+    /*************
+     * Handlers *
+     *************/
+    /**
+     * Handle close button
+     *
+     * @returns {void}
+     */
+    this.handleClose = () => {
+      this.hide = true;
+    };
+  }
+  validateHide(newValue) {
+    if (newValue) {
+      this.componentHide.emit();
+      this.classList.add('mg-modal--hide');
+    }
+    else {
+      this.componentShow.emit();
+      this.classList.delete('mg-modal--hide');
+    }
+  }
+  /**
+   * Handle 'escape' key down
+   *
+   * @param {KeyboardEvent} event keydown event
+   * @returns {void}
+   */
+  handleKeyDown(event) {
+    // we can use 'Escape button" when this not a blocking modal, induced by closeButton value.
+    if (this.closeButton && event.key === 'Escape') {
+      this.hide = true;
+    }
+  }
+  /*************
+   * Lifecycle *
+   *************/
+  /**
+   * Check if component props are well configured on init
+   *
+   * @returns {void}
+   */
+  componentWillLoad() {
+    this.hasActions = this.element.querySelector('[slot="actions"]') !== null;
+    this.hasContent = this.element.querySelector('[slot="content"]') !== null;
+    if (this.closeButton) {
+      this.closeButtonId = `${this.identifier}-close-button`;
+    }
+    this.titleId = `${this.identifier}-title`;
+    this.validateHide(this.hide);
+  }
+  /**
+   * Render
+   *
+   * @returns {HTMLElement} HTML Element
+   */
+  render() {
+    return (h("section", { role: "dialog", id: this.identifier, class: this.classList.join(), tabindex: "-1", "aria-labelledby": this.titleId, "aria-modal": "true", "aria-hidden": this.hide },
+      h("article", { class: "mg-modal__dialog" },
+        h("header", { class: "mg-modal__header" },
+          this.closeButton && (h("mg-button", { identifier: this.closeButtonId, "is-icon": true, variant: "flat", label: messages.modal.closeButton, onClick: this.handleClose, class: "mg-modal__close-button" },
+            h("mg-icon", { icon: "cross" }))),
+          h("h1", { class: "mg-modal__title", id: this.titleId }, this.modalTitle)),
+        this.hasContent && (h("article", { class: "mg-modal__content" },
+          h("slot", { name: "content" }))),
+        this.hasActions && (h("footer", { class: "mg-modal__footer" },
+          h("slot", { name: "actions" }))))));
+  }
+  static get is() { return "mg-modal"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["mg-modal.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["mg-modal.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-modal')"
+    },
+    "modalTitle": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": true,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Displayed modal title\nrequired"
+      },
+      "attribute": "modal-title",
+      "reflect": false
+    },
+    "closeButton": {
+      "type": "boolean",
+      "mutable": true,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define if modal has a cross button"
+      },
+      "attribute": "close-button",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "hide": {
+      "type": "boolean",
+      "mutable": true,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define if modal is hidden"
+      },
+      "attribute": "hide",
+      "reflect": false,
+      "defaultValue": "false"
+    }
+  }; }
+  static get states() { return {
+    "hasActions": {},
+    "hasContent": {},
+    "classList": {}
+  }; }
+  static get events() { return [{
+      "method": "componentShow",
+      "name": "component-show",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": "Emmited event when modal is diplayed"
+      },
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      }
+    }, {
+      "method": "componentHide",
+      "name": "component-hide",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": "Emmited event when modal is hidden"
+      },
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      }
+    }]; }
+  static get elementRef() { return "element"; }
+  static get watchers() { return [{
+      "propName": "hide",
+      "methodName": "validateHide"
+    }]; }
+  static get listeners() { return [{
+      "name": "keydown",
+      "method": "handleKeyDown",
+      "target": "window",
+      "capture": false,
+      "passive": false
+    }]; }
+}