@mgdis/mg-components 3.1.0

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

@@ -0,0 +1,532 @@
+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';
+/**
+ * Check if item is a well configured option
+ * @param option
+ * @returns {boolean}
+ */
+const isOption = (option) => typeof option === 'object' && typeof option.title === 'string' && option.value !== undefined;
+/**
+ * Group options
+ * @param acc
+ * @param {SelectOption} item
+ * @param {string} item.group
+ * @param {string} item.title
+ * @param {any} item.value
+ * @param {boolean} item.disabled
+ * @returns {OptGroup} grouped options
+ */
+const groupOptions = (acc, { group, title, value, disabled }) => {
+  if (group !== undefined) {
+    // Check if group is already created
+    const optgroup = acc.find((grp) => grp.group === group);
+    // Add to group
+    if (optgroup) {
+      optgroup.options.push({ title, value, disabled });
+    }
+    // Create group
+    else {
+      acc.push({ group, options: [{ title, value, disabled }] });
+    }
+  }
+  else {
+    acc.push({ title, value, disabled });
+  }
+  return acc;
+};
+export class MgInputSelect {
+  constructor() {
+    /************
+     * Internal *
+     ************/
+    // classes
+    this.classError = InputClass.ERROR;
+    /**
+     * 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-select');
+    /**
+     * Input name
+     * If not set the value equals the identifier
+     */
+    this.name = this.identifier;
+    /**
+     * Define if label is visible
+     */
+    this.labelHide = false;
+    /**
+     * Input placeholder.
+     * It should be a word or short phrase that demonstrates the expected type of data, not a replacement for labels or help text.
+     */
+    this.placeholder = messages.input.select.placeholder;
+    /**
+     * Option to remove placeholder
+     */
+    this.placeholderHide = false;
+    /**
+     * Option to disable placeholder
+     */
+    this.placeholderDisabled = 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--select']);
+    /**
+     * Handle input event
+     */
+    this.handleInput = () => {
+      this.checkValidity();
+      this.value = this.input.value !== '' ? this.options[this.input.value].value : null;
+      this.valueChange.emit(this.value);
+    };
+    /**
+     * Handle blur event
+     */
+    this.handleBlur = () => {
+      this.checkValidity();
+      this.checkError();
+    };
+  }
+  validateItems(newValue) {
+    // String array
+    if (allItemsAreString(newValue)) {
+      this.valueExist = newValue.includes(this.value);
+      this.options = newValue.map(item => ({ title: item, value: item }));
+    }
+    // Object array
+    else if (newValue && newValue.every(item => isOption(item))) {
+      this.valueExist = newValue.map(item => item.value).includes(this.value);
+      // Grouped object options
+      if (newValue.some((item) => item.group !== undefined)) {
+        this.options = newValue.reduce(groupOptions, []);
+      }
+      // Standart object options
+      else {
+        this.options = newValue;
+      }
+    }
+    else {
+      throw new Error('<mg-input-select> prop "items" is required and all items must be the same type, string or Option.');
+    }
+  }
+  /**
+   * Check if input is valid
+   */
+  checkValidity() {
+    if (!this.readonly && this.input !== undefined) {
+      const validity = this.input.checkValidity && this.input.checkValidity();
+      // Set validity
+      this.valid = validity;
+      this.invalid = !validity;
+    }
+  }
+  /**
+   * Check input errors
+   */
+  checkError() {
+    // Set error message
+    this.errorMessage = undefined;
+    if (!this.valid && this.input.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, readonly: this.readonly, width: this.width, disabled: this.disabled, value: this.value, readonlyValue: undefined, tooltip: this.tooltip, displayCharacterLeft: undefined, characterLeftTemplate: undefined, maxlength: undefined, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: false },
+      h("select", { class: "mg-input__box", id: this.identifier, name: this.name, title: this.placeholder, disabled: this.disabled, required: this.required, onInput: this.handleInput, onBlur: this.handleBlur, ref: el => (this.input = el) },
+        (!this.placeholderHide || !this.valueExist) && ( // In case passed value does not match any option we display the placeholder
+        h("option", { value: "", disabled: this.placeholderDisabled && this.valueExist }, this.placeholder)),
+        this.options.map((option, optionIndex) => option.group !== undefined ? (h("optgroup", { label: option.group }, option.options.map((optgroup, optgroupIndex) => (h("option", { value: optgroupIndex, selected: JSON.stringify(this.value) === JSON.stringify(optgroup.value), disabled: optgroup.disabled }, optgroup.title))))) : (h("option", { value: optionIndex, selected: JSON.stringify(this.value) === JSON.stringify(option.value), disabled: option.disabled }, option.title))))));
+  }
+  static get is() { return "mg-input-select"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["mg-input-select.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["mg-input-select.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[] | SelectOption[]",
+        "resolved": "SelectOption[] | string[]",
+        "references": {
+          "SelectOption": {
+            "location": "import",
+            "path": "./mg-input-select.conf"
+          }
+        }
+      },
+      "required": true,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Items are the possible options to select"
+      }
+    },
+    "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-select')"
+    },
+    "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
+    },
+    "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"
+    },
+    "placeholder": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Input placeholder.\nIt should be a word or short phrase that demonstrates the expected type of data, not a replacement for labels or help text."
+      },
+      "attribute": "placeholder",
+      "reflect": false,
+      "defaultValue": "messages.input.select.placeholder"
+    },
+    "placeholderHide": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Option to remove placeholder"
+      },
+      "attribute": "placeholder-hide",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "placeholderDisabled": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Option to disable placeholder"
+      },
+      "attribute": "placeholder-disabled",
+      "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"
+    },
+    "width": {
+      "type": "any",
+      "mutable": false,
+      "complexType": {
+        "original": "Width",
+        "resolved": "\"full\" | 16 | 2 | 4",
+        "references": {
+          "Width": {
+            "location": "import",
+            "path": "../MgInput.conf"
+          }
+        }
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define input width"
+      },
+      "attribute": "width",
+      "reflect": 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": "Define input 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 input invalid state"
+      },
+      "attribute": "invalid",
+      "reflect": false
+    }
+  }; }
+  static get states() { return {
+    "classList": {},
+    "errorMessage": {},
+    "options": {},
+    "valueExist": {}
+  }; }
+  static get events() { return [{
+      "method": "valueChange",
+      "name": "value-change",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": "Emmited event when value change"
+      },
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      }
+    }]; }
+  static get watchers() { return [{
+      "propName": "items",
+      "methodName": "validateItems"
+    }]; }
+}

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

@@ -0,0 +1,70 @@
+import { h } from '@stencil/core';
+export default {
+  component: 'mg-input-select',
+  title: 'Molecules/Inputs/mg-input-select',
+};
+/**
+ * 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 labelHide = args.labelHide;
+  delete args.labelHide;
+  const helpText = args.helpText;
+  delete args.helpText;
+  const placeholderDisabled = args.placeholderDisabled;
+  delete args.placeholderDisabled;
+  const placeholderHide = args.placeholderHide;
+  delete args.placeholderHide;
+  // return element
+  return (h("mg-input-select", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "help-text": helpText, "placeholder-hide": placeholderHide, "placeholder-disabled": placeholderDisabled })));
+};
+export const MgInputSelect = Template.bind({});
+MgInputSelect.args = {
+  // Global
+  value: '',
+  identifier: 'identifier',
+  name: 'input-name',
+  // Label
+  label: 'Label',
+  labelOnTop: false,
+  labelHide: false,
+  // Input
+  required: true,
+  readonly: false,
+  disabled: false,
+  items: ['blu', 'bli', 'blo', 'bla'],
+  // Tooltip
+  tooltip: 'This is a tooltip',
+  // Help Text
+  helpText: 'Help text with html <strong>bold</strong>, <em>italic</em>.',
+  // Placeholder
+  placeholderHide: false,
+  placeholderDisabled: false,
+};
+/**
+ * Using object
+ */
+export const WithObjectItems = Template.bind({});
+WithObjectItems.args = Object.assign(Object.assign({}, MgInputSelect.args), { 
+  // remove feature to focus on pattern
+  tooltip: '', helpText: '', required: false, 
+  //
+  items: [
+    { title: 'blu', value: 'blublu' },
+    { title: 'bli', value: 'blibli' },
+    { title: 'blo', value: 'bloblo' },
+    { title: 'bla', value: 'blabla', disabled: true },
+  ] });
+/**
+ * Using group object
+ */
+export const WithGroups = Template.bind({});
+WithGroups.args = Object.assign(Object.assign({}, WithObjectItems.args), { items: [
+    { title: 'blu', value: 'blublu', group: '1st group' },
+    { title: 'bli', value: 'blibli', group: '2nd group' },
+    { title: 'blo', value: 'bloblo', group: '1st group' },
+    { title: 'bla', value: 'blabla' },
+  ] });