@mgdis/mg-components 3.1.0

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

@@ -0,0 +1,589 @@
+import { Component, Event, h, Prop, State, Element } from '@stencil/core';
+import { MgInput } from '../MgInput';
+import { createID, ClassList } from '../../../../utils/components.utils';
+import { messages } from '../../../../locales';
+import { InputClass } from '../MgInput.conf';
+export class MgInputText {
+  constructor() {
+    /************
+     * Internal *
+     ************/
+    // classes
+    this.classFocus = 'is-focused';
+    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-text');
+    /**
+     * Input name
+     * If not set the value equals the identifier
+     */
+    this.name = this.identifier;
+    /**
+     * Input type
+     */
+    this.type = 'text';
+    /**
+     * Define if label is visible
+     */
+    this.labelHide = false;
+    /**
+     * Input max length
+     */
+    this.maxlength = 400;
+    /**
+     * Define if input is required
+     */
+    this.required = false;
+    /**
+     * Define if input is readonly
+     */
+    this.readonly = false;
+    /**
+     * Define if input is disabled
+     */
+    this.disabled = false;
+    /**
+     * Define input width
+     */
+    this.width = 'full';
+    /**
+     * Define if component should display character left
+     */
+    this.displayCharacterLeft = true;
+    /**
+     * Component classes
+     */
+    this.classList = new ClassList(['mg-input--text']);
+    /**
+     * Handle input event
+     */
+    this.handleInput = () => {
+      this.checkValidity();
+      this.value = this.input.value;
+      this.valueChange.emit(this.value);
+    };
+    /**
+     * Handle focus event
+     */
+    this.handleFocus = () => {
+      this.classList.add(this.classFocus);
+      this.classList = new ClassList(this.classList.classes);
+    };
+    /**
+     * Handle blur event
+     */
+    this.handleBlur = () => {
+      // Manage focus
+      this.classList.delete(this.classFocus);
+      this.classList = new ClassList(this.classList.classes);
+      // Check validity
+      this.checkValidity();
+      this.checkError();
+    };
+    /**
+     * Validate patern configuration
+     */
+    this.validatePattern = () => {
+      if (this.pattern &&
+        typeof this.pattern === 'string' &&
+        this.pattern !== '' &&
+        (this.patternErrorMessage === undefined || typeof this.patternErrorMessage !== 'string' || this.patternErrorMessage === '')) {
+        throw new Error('<mg-input-text> prop "pattern" must be paired with the prop "patternErrorMessage"');
+      }
+    };
+  }
+  /**
+   * Check if input is valid
+   */
+  checkValidity() {
+    if (!this.readonly && this.input !== undefined) {
+      const validity = this.input.checkValidity();
+      // Set validity
+      this.valid = validity;
+      this.invalid = !validity;
+    }
+  }
+  /**
+   * Check input errors
+   */
+  checkError() {
+    // Set error message
+    this.errorMessage = undefined;
+    // Does not match pattern
+    if (!this.valid && this.input.validity.patternMismatch) {
+      this.errorMessage = this.patternErrorMessage;
+    }
+    // required
+    else 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);
+    }
+  }
+  /**
+   * Validate append slot
+   */
+  validateAppendSlot() {
+    const slotAppendInput = this.element.querySelector('[slot="append-input"]');
+    if (slotAppendInput !== null && slotAppendInput.querySelector('.mg-button') !== null) {
+      this.classList.add('mg-input--is-input-group-append');
+      this.classList = new ClassList(this.classList.classes);
+    }
+    else if (slotAppendInput !== null) {
+      this.classList.add('mg-input--is-append-input-slot-content');
+      this.classList = new ClassList(this.classList.classes);
+    }
+  }
+  /*************
+   * Lifecycle *
+   *************/
+  /**
+   * Check if component props are well configured on init
+   */
+  componentWillLoad() {
+    if (this.icon !== undefined) {
+      this.classList.add('mg-input--has-icon');
+    }
+    this.validatePattern();
+    // return a promise to process action only in the FIRST render().
+    // https://stenciljs.com/docs/component-lifecycle#componentwillload
+    return setTimeout(() => this.checkValidity(), 0);
+  }
+  componentDidLoad() {
+    this.validateAppendSlot();
+  }
+  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: this.displayCharacterLeft, characterLeftTemplate: this.characterLeftTemplate, maxlength: this.maxlength, helpText: this.helpText, errorMessage: this.errorMessage, isFieldset: false },
+      this.icon !== undefined && h("mg-icon", { icon: this.icon }),
+      h("input", { type: this.type, class: "mg-input__box", value: this.value, id: this.identifier, name: this.name, placeholder: this.placeholder, title: this.placeholder, maxlength: this.maxlength, disabled: this.disabled, required: this.required, pattern: this.pattern, onInput: this.handleInput, onFocus: this.handleFocus, onBlur: this.handleBlur, ref: el => (this.input = el) }),
+      h("slot", { name: "append-input" })));
+  }
+  static get is() { return "mg-input-text"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["mg-input-text.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["mg-input-text.css"]
+  }; }
+  static get properties() { return {
+    "value": {
+      "type": "string",
+      "mutable": true,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Component value"
+      },
+      "attribute": "value",
+      "reflect": true
+    },
+    "identifier": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "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-text')"
+    },
+    "name": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "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
+    },
+    "type": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "'text' | 'search'",
+        "resolved": "\"search\" | \"text\"",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Input type"
+      },
+      "attribute": "type",
+      "reflect": false,
+      "defaultValue": "'text'"
+    },
+    "icon": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Input icon"
+      },
+      "attribute": "icon",
+      "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
+    },
+    "maxlength": {
+      "type": "number",
+      "mutable": false,
+      "complexType": {
+        "original": "number",
+        "resolved": "number",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Input max length"
+      },
+      "attribute": "maxlength",
+      "reflect": false,
+      "defaultValue": "400"
+    },
+    "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,
+      "defaultValue": "'full'"
+    },
+    "pattern": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define input pattern to validate"
+      },
+      "attribute": "pattern",
+      "reflect": false
+    },
+    "patternErrorMessage": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define input pattern error message"
+      },
+      "attribute": "pattern-error-message",
+      "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
+    },
+    "displayCharacterLeft": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define if component should display character left"
+      },
+      "attribute": "display-character-left",
+      "reflect": false,
+      "defaultValue": "true"
+    },
+    "characterLeftTemplate": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Template to use for characters left sentence"
+      },
+      "attribute": "character-left-template",
+      "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 pattern to validate"
+      },
+      "attribute": "valid",
+      "reflect": false
+    },
+    "invalid": {
+      "type": "boolean",
+      "mutable": true,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Define input pattern error message"
+      },
+      "attribute": "invalid",
+      "reflect": false
+    }
+  }; }
+  static get states() { return {
+    "classList": {},
+    "errorMessage": {}
+  }; }
+  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 elementRef() { return "element"; }
+}

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

@@ -0,0 +1,115 @@
+import { h } from '@stencil/core';
+export default {
+  component: 'mg-input-text',
+  title: 'Molecules/Inputs/mg-input-text',
+};
+/**
+ * 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 patternErrorMessage = args.patternErrorMessage;
+  delete args.patternErrorMessage;
+  const displayCharacterLeft = args.displayCharacterLeft;
+  delete args.displayCharacterLeft;
+  const characterLeftTemplate = args.characterLeftTemplate;
+  delete args.characterLeftTemplate;
+  const helpText = args.helpText;
+  delete args.helpText;
+  // return element
+  return (h("mg-input-text", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "pattern-error-message": patternErrorMessage, "display-character-left": displayCharacterLeft, "character-left-template": characterLeftTemplate, "help-text": helpText })));
+};
+/**
+ * Global use
+ */
+export const MgInputText = Template.bind({});
+MgInputText.args = {
+  // Global
+  value: '',
+  identifier: 'identifier',
+  name: 'input-name',
+  // Label
+  label: 'Label',
+  labelOnTop: false,
+  labelHide: false,
+  // Input
+  placeholder: 'placeholder',
+  maxlength: 400,
+  required: true,
+  disabled: false,
+  readonly: false,
+  pattern: undefined,
+  patternErrorMessage: undefined,
+  // Tooltip
+  tooltip: 'This is a tooltip',
+  // Nb Char Left
+  displayCharacterLeft: true,
+  characterLeftTemplate: '{counter} characters left.',
+  // Help Text
+  helpText: 'Help text with html <strong>bold</strong>, <em>italic</em>.',
+};
+/**
+ * Email
+ */
+export const Email = Template.bind({});
+Email.args = Object.assign(Object.assign({}, MgInputText.args), { 
+  // remove feature to focus on pattern
+  tooltip: '', required: false, label: 'Adresse email', 
+  // Add pattern Email rules
+  maxlength: 100, pattern: '[a-z0-9._%+-]+@[a-z0-9.-]+.[a-z]{2,15}', patternErrorMessage: "L'information saisie est incorrecte (exemple : prenom.nom@exemple.fr)", 
+  // Help Text
+  helpText: 'exemple : prenom.nom@exemple.fr' });
+/**
+ * Emails
+ */
+export const Emails = Template.bind({});
+Emails.args = Object.assign(Object.assign({}, Email.args), { label: 'Adresses email', 
+  // Add pattern Emails rules
+  maxlength: 200, pattern: '([a-z0-9._%+-]+@[a-z0-9.-]+.[a-z]{2,15}(;)*)+', patternErrorMessage: "L'information saisie est incorrecte (exemple : prenom.nom@exemple.fr;prenom.nom.2@exemple.fr)", 
+  // Help Text
+  helpText: 'exemple : prenom.nom@exemple.fr;prenom.nom.2@exemple.fr' });
+/**
+ * RNA
+ */
+export const RNA = Template.bind({});
+RNA.args = Object.assign(Object.assign({}, Emails.args), { label: 'RNA', 
+  // Add pattern RNA rules
+  maxlength: 10, pattern: '(W[0-9]{1}[a-zA-Z0-9]{1}[0-9]{7})', patternErrorMessage: "Le numéro RNA n'est pas valide (exemple: W123456789)", 
+  // Help Text
+  helpText: 'exemple : W123456789' });
+/**
+ * URL
+ */
+export const URL = Template.bind({});
+URL.args = Object.assign(Object.assign({}, Emails.args), { label: 'URL', 
+  // Add pattern URL rules
+  maxlength: 200, pattern: 'https?://(?:www.)?([-a-zA-Z0-9@:%._+~#=]{2,256}.[a-z]{2,6}\b)*(/[/dw.-]*)*(?:[?])*(.+)*', patternErrorMessage: "Le format du champ n'est pas valide (exemple: https://www.exemple.fr)", 
+  // Help Text
+  helpText: 'Exemple: https://www.exemple.fr' });
+/**
+ * Search
+ */
+const SearchTemplate = args => {
+  const labelOnTop = args.labelOnTop;
+  delete args.labelOnTop;
+  const labelHide = args.labelHide;
+  delete args.labelHide;
+  const patternErrorMessage = args.patternErrorMessage;
+  delete args.patternErrorMessage;
+  const displayCharacterLeft = args.displayCharacterLeft;
+  delete args.displayCharacterLeft;
+  const characterLeftTemplate = args.characterLeftTemplate;
+  delete args.characterLeftTemplate;
+  // return element
+  return (h("form", { role: "search" },
+    h("mg-input-text", Object.assign({}, args, { "label-on-top": labelOnTop, "label-hide": labelHide, "pattern-error-message": patternErrorMessage, "display-character-left": displayCharacterLeft, "character-left-template": characterLeftTemplate }),
+      h("mg-button", { slot: "append-input", label: "search" },
+        h("mg-icon", { icon: "magnifying-glass" }),
+        " Search"))));
+};
+export const Search = SearchTemplate.bind({});
+Search.args = Object.assign(Object.assign({}, MgInputText.args), { type: 'search', icon: 'magnifying-glass' });