@everymatrix/general-input 0.0.1

package/dist/collection/components/email-input/email-input.js

@@ -0,0 +1,382 @@
+import { Component, h, Prop, State, Watch, Event, Listen } from '@stencil/core';
+import { translate } from '../../utils/locale.utils';
+import tooltipIcon from '../../utils/tooltipIcon.svg';
+export class EmailInput {
+  constructor() {
+    /**
+     * Client custom styling via inline style
+     */
+    this.clientStyling = '';
+    this.limitStylingAppends = false;
+    this.showTooltip = false;
+    this.validationPattern = '';
+    this.setClientStyling = () => {
+      let sheet = document.createElement('style');
+      sheet.innerHTML = this.clientStyling;
+      this.stylingContainer.prepend(sheet);
+    };
+  }
+  validityChanged() {
+    this.validityStateHandler({ valid: this.isValid, name: this.name });
+    if (this.emitValue == true) {
+      this.valueHandler({ name: this.name, value: this.value });
+    }
+  }
+  emitValueHandler(newValue) {
+    if (newValue == true && this.isValid) {
+      this.valueHandler({ name: this.name, value: this.value });
+    }
+  }
+  validityStateHandler(inputStateEvent) {
+    this.sendValidityState.emit(inputStateEvent);
+  }
+  valueHandler(inputValueEvent) {
+    this.sendInputValue.emit(inputValueEvent);
+  }
+  handleClickOutside(event) {
+    if (event.composedPath()[0] === this.tooltipIconReference)
+      return;
+    if (event.composedPath()[0] !== this.tooltipReference)
+      this.showTooltip = false;
+  }
+  valueChangedHandler(event) {
+    if (this.isDuplicateInput) {
+      if (this.name === event.detail.name + 'Duplicate') {
+        this.duplicateInputValue = event.detail.value;
+      }
+    }
+  }
+  connectedCallback() {
+    this.validationPattern = this.setPattern();
+  }
+  componentDidRender() {
+    // start custom styling area
+    if (!this.limitStylingAppends && this.stylingContainer) {
+      if (this.clientStyling)
+        this.setClientStyling();
+      this.limitStylingAppends = true;
+    }
+    // end custom styling area
+    if (this.defaultValue) {
+      this.value = this.defaultValue;
+      this.valueHandler({ name: this.name, value: this.value });
+    }
+  }
+  handleInput(event) {
+    this.value = event.target.value;
+    this.errorMessage = this.setErrorMessage();
+    this.isValid = this.setValidity();
+    this.validityStateHandler({ valid: this.isValid, name: this.name });
+    this.emitValueHandler(true);
+  }
+  setValidity() {
+    return this.inputReference.validity.valid;
+  }
+  setPattern() {
+    var _a, _b;
+    if (((_a = this.validation.custom) === null || _a === void 0 ? void 0 : _a.length) > 0) {
+      return (_b = this.validation.custom.find(customValidation => customValidation.rule === 'regex')) === null || _b === void 0 ? void 0 : _b.pattern;
+    }
+  }
+  setErrorMessage() {
+    var _a;
+    if (this.inputReference.validity.patternMismatch) {
+      return (_a = this.validation.custom.find(customValidation => customValidation.rule === 'regex')) === null || _a === void 0 ? void 0 : _a.errorMessage;
+    }
+    if (this.inputReference.validity.tooShort || this.inputReference.validity.tooLong) {
+      return translate('lengthError', this.language, { values: { minLength: this.validation.minLength, maxLength: this.validation.maxLength } });
+    }
+    if (this.inputReference.validity.valueMissing) {
+      return translate('requiredError', this.language);
+    }
+    if (this.isDuplicateInput && this.duplicateInputValue !== this.value) {
+      return this.validation.custom.find(customRule => customRule.rule === 'duplicate-input').errorMessage;
+    }
+  }
+  renderTooltip() {
+    if (this.showTooltip) {
+      return (h("div", { class: `email__tooltip ${this.showTooltip ? 'visible' : ''}`, ref: (el) => this.tooltipReference = el, innerHTML: this.tooltip }));
+    }
+    return null;
+  }
+  render() {
+    const invalidClass = this.isValid == true || this.isValid == undefined ? '' : 'email__input--invalid';
+    return h("div", { class: 'email__wrapper', ref: el => this.stylingContainer = el },
+      h("div", { class: 'email__wrapper--flex' },
+        h("label", { class: `email__label ${this.validation.mandatory ? 'email__label--required' : ''}`, htmlFor: `${this.name}__input` }, this.displayName),
+        h("div", { class: 'email__wrapper--relative' },
+          this.tooltip &&
+            h("img", { class: 'email__tooltip-icon', src: tooltipIcon, alt: "", ref: (el) => this.tooltipIconReference = el, onClick: () => this.showTooltip = !this.showTooltip }),
+          this.renderTooltip())),
+      h("input", { id: `${this.name}__input`, type: 'email', class: `email__input ${invalidClass}`, value: this.defaultValue, readOnly: this.autofilled, placeholder: `${this.placeholder} ${this.placeholder && this.validation.mandatory ? '*' : ''}`, ref: (el) => this.inputReference = el, pattern: this.validationPattern, required: this.validation.mandatory, minlength: this.validation.minLength, maxlength: this.validation.maxLength, onBlur: (e) => this.handleInput(e) }),
+      h("small", { class: 'email__error-message' }, this.errorMessage));
+  }
+  static get is() { return "email-input"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["email-input.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["email-input.css"]
+  }; }
+  static get properties() { return {
+    "name": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Name of the input."
+      },
+      "attribute": "name",
+      "reflect": true
+    },
+    "displayName": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Name of input to be shown to the user."
+      },
+      "attribute": "display-name",
+      "reflect": true
+    },
+    "placeholder": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Placeholder text to be shown."
+      },
+      "attribute": "placeholder",
+      "reflect": true
+    },
+    "validation": {
+      "type": "unknown",
+      "mutable": false,
+      "complexType": {
+        "original": "ValidationSchema",
+        "resolved": "ValidationSchema",
+        "references": {
+          "ValidationSchema": {
+            "location": "import",
+            "path": "../../utils/types"
+          }
+        }
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Object of validation rules for the input."
+      }
+    },
+    "defaultValue": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Default value for the input."
+      },
+      "attribute": "default-value",
+      "reflect": true
+    },
+    "autofilled": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Boolean. Determines if input should be readonly."
+      },
+      "attribute": "autofilled",
+      "reflect": true
+    },
+    "tooltip": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Tooltip text."
+      },
+      "attribute": "tooltip",
+      "reflect": true
+    },
+    "language": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Currently selected language."
+      },
+      "attribute": "language",
+      "reflect": true
+    },
+    "emitValue": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "State passed down from the parent element. Will trigger the input to send it's value through an event."
+      },
+      "attribute": "emit-value",
+      "reflect": true
+    },
+    "isDuplicateInput": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Flag for duplicate inputs, it sets up the input for certain validation rules."
+      },
+      "attribute": "is-duplicate-input",
+      "reflect": true
+    },
+    "clientStyling": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Client custom styling via inline style"
+      },
+      "attribute": "client-styling",
+      "reflect": true,
+      "defaultValue": "''"
+    }
+  }; }
+  static get states() { return {
+    "errorMessage": {},
+    "isValid": {},
+    "limitStylingAppends": {},
+    "showTooltip": {}
+  }; }
+  static get events() { return [{
+      "method": "sendValidityState",
+      "name": "sendValidityState",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "complexType": {
+        "original": "InputStateEvent",
+        "resolved": "InputStateEvent",
+        "references": {
+          "InputStateEvent": {
+            "location": "import",
+            "path": "../../utils/types"
+          }
+        }
+      }
+    }, {
+      "method": "sendInputValue",
+      "name": "sendInputValue",
+      "bubbles": true,
+      "cancelable": true,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "complexType": {
+        "original": "InputValueEvent",
+        "resolved": "InputValueEvent",
+        "references": {
+          "InputValueEvent": {
+            "location": "import",
+            "path": "../../utils/types"
+          }
+        }
+      }
+    }]; }
+  static get watchers() { return [{
+      "propName": "isValid",
+      "methodName": "validityChanged"
+    }, {
+      "propName": "emitValue",
+      "methodName": "emitValueHandler"
+    }]; }
+  static get listeners() { return [{
+      "name": "click",
+      "method": "handleClickOutside",
+      "target": "document",
+      "capture": false,
+      "passive": false
+    }, {
+      "name": "sendInputValue",
+      "method": "valueChangedHandler",
+      "target": "body",
+      "capture": false,
+      "passive": false
+    }]; }
+}

package/dist/collection/components/general-input/general-input.css

@@ -0,0 +1,3 @@
+:host {
+  display: block;
+}

package/dist/collection/components/general-input/general-input.js

@@ -0,0 +1,296 @@
+import { Component, h, Prop } from '@stencil/core';
+export class GeneralInput {
+  constructor() {
+    /**
+     * Type the general-input should take. Can take the default HTML input values.
+     */
+    this.type = 'text';
+    /**
+     * Client custom styling via inline style
+     */
+    this.clientStyling = '';
+  }
+  render() {
+    var _a;
+    switch ((_a = this.type) === null || _a === void 0 ? void 0 : _a.toLowerCase()) {
+      case 'text':
+        return h("text-input", { name: this.name, displayName: this.displayName, validation: this.validation, defaultValue: this.defaultValue, autofilled: this.autofilled, emitValue: this.emitValue, language: this.language, isDuplicateInput: this.isDuplicateInput, "client-styling": this.clientStyling, tooltip: this.tooltip, placeholder: this.placeholder });
+      case 'email':
+        return h("email-input", { name: this.name, displayName: this.displayName, validation: this.validation, defaultValue: this.defaultValue, autofilled: this.autofilled, emitValue: this.emitValue, language: this.language, isDuplicateInput: this.isDuplicateInput, "client-styling": this.clientStyling, tooltip: this.tooltip, placeholder: this.placeholder });
+      case 'number':
+        return h("number-input", { name: this.name, displayName: this.displayName, validation: this.validation, defaultValue: this.defaultValue, autofilled: this.autofilled, emitValue: this.emitValue, language: this.language, "client-styling": this.clientStyling, tooltip: this.tooltip, placeholder: this.placeholder });
+      case 'checkbox':
+        return h("checkbox-input", { name: this.name, displayName: this.displayName, validation: this.validation, emitValue: this.emitValue, defaultValue: this.defaultValue, autofilled: this.autofilled, language: this.language, "client-styling": this.clientStyling, tooltip: this.tooltip });
+      case 'checkboxgroup':
+        return h("checkbox-group-input", { name: this.name, displayName: this.displayName, validation: this.validation, defaultValue: this.defaultValue, autofilled: this.autofilled, emitValue: this.emitValue, language: this.language, "client-styling": this.clientStyling, tooltip: this.tooltip, options: this.options });
+      case 'datetime':
+        return h("date-input", { name: this.name, displayName: this.displayName, validation: this.validation, defaultValue: this.defaultValue, autofilled: this.autofilled, emitValue: this.emitValue, language: this.language, "client-styling": this.clientStyling, tooltip: this.tooltip, placeholder: this.placeholder });
+      case 'password':
+        return h("password-input", { name: this.name, displayName: this.displayName, validation: this.validation, defaultValue: this.defaultValue, autofilled: this.autofilled, emitValue: this.emitValue, language: this.language, isDuplicateInput: this.isDuplicateInput, "client-styling": this.clientStyling, tooltip: this.tooltip, placeholder: this.placeholder });
+      case 'radio':
+        return h("radio-input", { name: this.name, displayName: this.displayName, optionsGroup: this.options, validation: this.validation, emitValue: this.emitValue, language: this.language, "client-styling": this.clientStyling });
+      case 'tel':
+        return h("tel-input", { name: this.name, action: this.action, displayName: this.displayName, validation: this.validation, defaultValue: this.defaultValue, emitValue: this.emitValue, language: this.language, autofilled: this.autofilled, "client-styling": this.clientStyling, tooltip: this.tooltip, placeholder: this.placeholder });
+      case 'dropdown':
+        return h("select-input", { name: this.name, action: this.action, defaultValue: this.defaultValue, displayName: this.displayName, options: this.options, validation: this.validation, emitValue: this.emitValue, autofilled: this.autofilled, language: this.language, "client-styling": this.clientStyling, tooltip: this.tooltip, placeholder: this.placeholder });
+      default:
+        return h("p", null,
+          "The ",
+          this.type,
+          " input type is not valid");
+    }
+  }
+  static get is() { return "general-input"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["general-input.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["general-input.css"]
+  }; }
+  static get properties() { return {
+    "type": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Type the general-input should take. Can take the default HTML input values."
+      },
+      "attribute": "type",
+      "reflect": true,
+      "defaultValue": "'text'"
+    },
+    "name": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Name of the input."
+      },
+      "attribute": "name",
+      "reflect": true
+    },
+    "displayName": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Name of input to be shown to the user."
+      },
+      "attribute": "display-name",
+      "reflect": true
+    },
+    "placeholder": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Placeholder text to be shown."
+      },
+      "attribute": "placeholder",
+      "reflect": true
+    },
+    "action": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Special behaviour an input should have. Can be fetching for data."
+      },
+      "attribute": "action",
+      "reflect": true
+    },
+    "validation": {
+      "type": "unknown",
+      "mutable": false,
+      "complexType": {
+        "original": "ValidationSchema",
+        "resolved": "ValidationSchema",
+        "references": {
+          "ValidationSchema": {
+            "location": "import",
+            "path": "../../utils/types"
+          }
+        }
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Object of validation rules for the input."
+      }
+    },
+    "options": {
+      "type": "any",
+      "mutable": false,
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "For input elements that have multiple options or choises."
+      },
+      "attribute": "options",
+      "reflect": true
+    },
+    "language": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Currently selected language."
+      },
+      "attribute": "language",
+      "reflect": true
+    },
+    "autofilled": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Boolean. Determines if input should be readonly."
+      },
+      "attribute": "autofilled",
+      "reflect": true
+    },
+    "tooltip": {
+      "type": "string",
+      "mutable": false,
+      "complexType": {
+        "original": "string",
+        "resolved": "string",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Tooltip text."
+      },
+      "attribute": "tooltip",
+      "reflect": true
+    },
+    "defaultValue": {
+      "type": "any",
+      "mutable": false,
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Default value for the input."
+      },
+      "attribute": "default-value",
+      "reflect": true
+    },
+    "emitValue": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "State passed down from the parent element. Will trigger the child specialised input to send it's value through an event."
+      },
+      "attribute": "emit-value",
+      "reflect": true
+    },
+    "isDuplicateInput": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Boolean that triggers certain validation rules, for duplicated inputs."
+      },
+      "attribute": "is-duplicate-input",
+      "reflect": true
+    },
+    "clientStyling": {
+      "type": "any",
+      "mutable": false,
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [],
+        "text": "Client custom styling via inline style"
+      },
+      "attribute": "client-styling",
+      "reflect": true,
+      "defaultValue": "''"
+    }
+  }; }
+}