@mgdis/mg-components 3.1.0

package/dist/collection/components/molecules/inputs/mg-input-radio/mg-input-radio.css

@@ -0,0 +1,156 @@
+/**
+ * Common style for MGDIS inputs
+ */
+:host {
+  display: block;
+}
+
+.mg-input {
+  display: flex;
+  align-items: flex-start;
+  min-height: var(--default-size);
+  max-width: 100%;
+  /* Style when input is not valid */
+  /* 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);
+  margin-top: calc((var(--default-size) - var(--font-size) * var(--line-height)) / 2);
+  margin-right: var(--mg-inputs-title-horizontal-space, var(--mg-inputs-spacer));
+  text-align: right;
+}
+.mg-input.mg-input--label-on-top {
+  flex-direction: column;
+}
+.mg-input.mg-input--label-on-top .mg-input__input-container {
+  width: 100%;
+}
+
+/* Label-on-top */
+.mg-input__title {
+  display: flex;
+  align-items: baseline;
+  margin-bottom: 0.3rem;
+}
+.mg-input__title mg-input-title {
+  flex-shrink: 1;
+  width: auto;
+  margin-top: 0;
+  margin-right: var(--mg-inputs-spacer);
+  text-align: left;
+}
+.mg-input__title mg-tooltip {
+  margin-top: 0;
+}
+.mg-input__title mg-icon {
+  display: inline-flex;
+  vertical-align: text-bottom;
+}
+
+.mg-input__input-container {
+  min-height: var(--default-size);
+  /* Readonly */
+}
+.mg-input__input-container > strong {
+  display: inline-block;
+  margin-top: calc((var(--default-size) - var(--font-size) * var(--line-height)) / 2);
+  min-height: var(--font-size);
+}
+.mg-input__input-container mg-tooltip {
+  display: inline-flex;
+  width: var(--mg-icon-regular-size);
+  height: var(--mg-icon-regular-size);
+  margin-left: var(--mg-inputs-spacer);
+}
+.mg-input__input-container mg-icon {
+  display: flex;
+}
+
+.mg-input__input {
+  display: flex;
+  /* Manage space between input and first message */
+}
+.mg-input__input mg-tooltip {
+  margin-top: calc((var(--default-size) - var(--mg-icon-regular-size)) / 2);
+}
+.mg-input__input + * {
+  text-align: start;
+  margin-top: 0.5rem;
+}
+
+/**
+ * Manage style when input needs to be a fieldset, like checkbox and radio.
+ */
+fieldset.mg-input {
+  border: 0;
+  margin: 0;
+  padding: 0;
+}
+fieldset.mg-input input[type=radio],
+fieldset.mg-input input[type=checkbox] {
+  flex-shrink: 0;
+  /* Ensure checkbox won't resize in flex element */
+  width: var(--mg-input-check-size);
+  height: var(--mg-input-check-size);
+  margin-top: calc((var(--font-size) * var(--line-height) - var(--mg-input-check-size)) / 2);
+  margin-right: 0.6rem;
+  margin-bottom: 0;
+  margin-left: 0;
+}
+fieldset.mg-input.mg-input--label-on-top .mg-input__input-group-container {
+  margin-top: 0.7rem;
+}
+
+.mg-input__input-container mg-tooltip {
+  margin-left: 2rem;
+}
+
+/* input group container */
+.mg-input__input-group-container {
+  margin: 0;
+  padding: 0;
+  list-style: none;
+  display: flex;
+  flex-wrap: wrap;
+  column-gap: 2.3rem;
+  row-gap: 1rem;
+  margin-top: calc((var(--default-size) - var(--font-size) * var(--line-height)) / 2);
+}
+.mg-input__input-group-container--vertical {
+  flex-direction: column;
+}
+
+/* input group */
+.mg-input__input-group {
+  display: flex;
+  align-items: top;
+}
+
+/**
+ * A11Y
+ */
+.sr-only {
+  border: 0 !important;
+  clip: rect(1px, 1px, 1px, 1px) !important;
+  -webkit-clip-path: inset(50%) !important;
+  clip-path: inset(50%) !important;
+  height: 1px !important;
+  margin: -1px !important;
+  overflow: hidden !important;
+  padding: 0 !important;
+  position: absolute !important;
+  width: 1px !important;
+  white-space: nowrap !important;
+}
+
+*:focus:not(:focus-visible) {
+  outline: none;
+}

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

@@ -0,0 +1,443 @@
+import { Component, Event, h, Prop, State, Watch } from '@stencil/core';
+import { MgInput } from '../MgInput';
+import { createID, ClassList, allItemsAreString } from '../../../../utils/components.utils';
+import { messages } from '../../../../locales';
+import { InputClass } from '../MgInput.conf';
+/**
+ * type Option validation function
+ * @param option
+ * @returns {boolean}
+ */
+const isOption = (option) => typeof option === 'object' && typeof option.title === 'string' && option.value !== undefined;
+export class MgInputRadio {
+  constructor() {
+    /************
+     * Internal *
+     ************/
+    // classes
+    this.classError = InputClass.ERROR;
+    // HTML selector
+    this.inputs = [];
+    /**
+     * 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-input-radio');
+    /**
+     * Input name
+     * If not set the value equals the identifier
+     */
+    this.name = this.identifier;
+    /**
+     * Define if label is displayed on top
+     */
+    this.labelOnTop = false;
+    /**
+     * Define if label is visible
+     */
+    this.labelHide = false;
+    /**
+     * Define if inputs are display verticaly
+     */
+    this.inputVerticalList = false;
+    /**
+     * Define if input is required
+     */
+    this.required = false;
+    /**
+     * Define if input is readonly
+     */
+    this.readonly = false;
+    /**
+     * Define if input is disabled
+     */
+    this.disabled = false;
+    /**
+     * Component classes
+     */
+    this.classList = new ClassList(['mg-input--radio']);
+    /**
+     * Handle input event
+     */
+    this.handleInput = (event) => {
+      this.checkValidity();
+      this.value = this.options[event.target.value].value;
+      this.valueChange.emit(this.value);
+    };
+    /**
+     * Handle blur event
+     */
+    this.handleBlur = () => {
+      this.checkValidity();
+      this.checkError();
+    };
+    /**
+     * get invalid element
+     * @returns element: HTMLInputElement
+     */
+    this.getInvalidElement = () => this.inputs.find((element) => !element.disabled && !element.checkValidity());
+  }
+  validateItems(newValue) {
+    // Validate if items have required min length
+    if (typeof newValue === 'object' && newValue.length < 2) {
+      throw new Error('<mg-input-radio> prop "items" require at least 2 items.');
+    }
+    // String array
+    else if (allItemsAreString(newValue)) {
+      this.options = newValue.map(item => ({ title: item, value: item, disabled: this.disabled }));
+    }
+    // Object array
+    else if (newValue && newValue.every(item => isOption(item))) {
+      this.options = newValue;
+    }
+    else {
+      throw new Error('<mg-input-radio> prop "items" is required and all items must be the same type, string or RadioOption.');
+    }
+  }
+  /**
+   * Check if input is valid
+   */
+  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);
+    }
+  }
+  /*************
+   * Lifecycle *
+   *************/
+  componentWillLoad() {
+    // Check items format
+    this.validateItems(this.items);
+    // return a promise to process action only in the FIRST render().
+    // https://stenciljs.com/docs/component-lifecycle#componentwillload
+    return setTimeout(() => this.checkValidity(), 0);
+  }
+  render() {
+    return (h(MgInput, { identifier: this.identifier, classList: this.classList, label: this.label, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: this.required, disabled: this.disabled, readonly: this.readonly, width: undefined, value: this.value && this.value.toString(), readonlyValue: this.value && this.value.toString(), tooltip: 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.options.map((input, index) => (h("li", { class: "mg-input__input-group" },
+        h("input", { type: "radio", id: this.identifier + '_' + index, name: this.identifier, value: index, checked: JSON.stringify(this.value) === JSON.stringify(this.options[index].value), disabled: this.disabled || input.disabled, required: this.required, onBlur: this.handleBlur, onInput: this.handleInput, ref: el => this.inputs.push(el) }),
+        h("label", { htmlFor: this.identifier + '_' + index }, input.title)))))));
+  }
+  static get is() { return "mg-input-radio"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["mg-input-radio.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["mg-input-radio.css"]
+  }; }
+  static get properties() { return {
+    "value": {
+      "type": "any",
+      "mutable": true,
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Component value"
+      },
+      "attribute": "value",
+      "reflect": false
+    },
+    "items": {
+      "type": "unknown",
+      "mutable": false,
+      "complexType": {
+        "original": "string[] | RadioOption[]",
+        "resolved": "RadioOption[] | string[]",
+        "references": {
+          "RadioOption": {
+            "location": "import",
+            "path": "./mg-input-radio.conf"
+          }
+        }
+      },
+      "required": true,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Items are the possible options to select\nRequired"
+      }
+    },
+    "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-input-radio')"
+    },
+    "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"
+    },
+    "label": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": true,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Input label\nRequired"
+      },
+      "attribute": "label",
+      "reflect": false
+    },
+    "labelOnTop": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define if label is displayed on top"
+      },
+      "attribute": "label-on-top",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "labelHide": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define if label is visible"
+      },
+      "attribute": "label-hide",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "inputVerticalList": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define if inputs are display verticaly"
+      },
+      "attribute": "input-vertical-list",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "required": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define if input is required"
+      },
+      "attribute": "required",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "readonly": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define if input 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 input is disabled"
+      },
+      "attribute": "disabled",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "tooltip": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Add a tooltip message next to the input"
+      },
+      "attribute": "tooltip",
+      "reflect": false
+    },
+    "helpText": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Add a help text under the input, usually expected data format and example"
+      },
+      "attribute": "help-text",
+      "reflect": false
+    },
+    "valid": {
+      "type": "boolean",
+      "mutable": true,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Force valid component"
+      },
+      "attribute": "valid",
+      "reflect": false
+    },
+    "invalid": {
+      "type": "boolean",
+      "mutable": true,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Force invalid component"
+      },
+      "attribute": "invalid",
+      "reflect": false
+    }
+  }; }
+  static get states() { return {
+    "classList": {},
+    "errorMessage": {},
+    "options": {}
+  }; }
+  static get events() { return [{
+      "method": "valueChange",
+      "name": "value-change",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": "Emitted event when value change"
+      },
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      }
+    }]; }
+  static get watchers() { return [{
+      "propName": "items",
+      "methodName": "validateItems"
+    }]; }
+}

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

@@ -0,0 +1,65 @@
+import { h } from '@stencil/core';
+export default {
+  component: 'mg-input-radio',
+  title: 'Molecules/Inputs/mg-input-radio',
+  argTypes: {
+    value: {
+      options: [null, 'ht', 'ttc', 'mixte'],
+      control: { type: 'radio' },
+    },
+  },
+};
+/**
+ * 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'}
+ */
+const Template = args => {
+  const labelOnTop = args.labelOnTop;
+  delete args.labelOnTop;
+  const helpText = args.helpText;
+  delete args.helpText;
+  const inputVerticalList = args.inputVerticalList;
+  delete args.inputVerticalList;
+  const labelHide = args.labelHide;
+  delete args.labelHide;
+  // return element
+  return h("mg-input-radio", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "help-text": helpText, "input-vertical-list": inputVerticalList }));
+};
+export const MgInputRadio = Template.bind({});
+MgInputRadio.args = {
+  // Global
+  value: null,
+  items: ['ht', 'ttc', 'mixte'],
+  identifier: 'identifier',
+  name: 'input-name',
+  // Label
+  label: 'Option',
+  labelOnTop: false,
+  labelHide: false,
+  // placement
+  inputVerticalList: false,
+  // Input
+  required: false,
+  disabled: false,
+  readonly: false,
+  // Tooltip
+  tooltip: 'This is a tooltip',
+  // Help Text
+  helpText: 'Help text with html <strong>bold</strong>, <em>italic</em>.',
+};
+export const ItemsWithOptions = Template.bind({});
+ItemsWithOptions.args = Object.assign(Object.assign({}, MgInputRadio.args), { required: true, items: [
+    {
+      title: 'HT',
+      value: 'ht',
+    },
+    {
+      title: 'TTC',
+      value: 'ttc',
+      disabled: true,
+    },
+    {
+      title: 'Mixte (HT/TTC)',
+      value: 'mixte',
+    },
+  ] });

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

@@ -0,0 +1 @@
+export {};