@mgdis/mg-components 3.1.0

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

@@ -0,0 +1,213 @@
+/**
+ * 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;
+}
+
+/**
+ * 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;
+}
+
+/**
+* Toogle
+*/
+.mg-input.mg-input.mg-input--toggle .mg-input__input-container {
+  flex: auto;
+  min-width: 0;
+}
+
+.mg-input__button-toggle {
+  display: flex;
+  padding: 0.2rem;
+  min-width: 0;
+  background-color: hsl(var(--color-light));
+  border-width: var(--mg-inputs-border-width);
+  border-style: solid;
+  border-color: var(--mg-inputs-color);
+  border-radius: calc((var(--font-size) * var(--line-height) + 2 * (0.7rem + var(--mg-inputs-border-width))) / var(--mg-input-toggle-border-radius-ratio));
+  font-size: inherit;
+  line-height: inherit;
+  cursor: pointer;
+}
+
+.mg-input__toggle-item-container {
+  padding: 0.5rem 0.9rem;
+  border: 0;
+  box-sizing: border-box;
+  border-radius: calc((var(--font-size) * var(--line-height) + 1rem) / var(--mg-input-toggle-border-radius-ratio));
+  background-color: unset;
+  font-weight: unset;
+  color: hsl(var(--color-dark));
+  white-space: nowrap;
+  overflow: hidden;
+  text-overflow: ellipsis;
+}
+.mg-input__toggle-item-container:first-of-type {
+  font-weight: 600;
+  color: hsl(var(--color-info));
+  background-color: hsl(var(--color-info-h), calc(var(--color-info-s) - 64%), calc(var(--color-info-l) + 55%));
+}
+
+.mg-input.mg-input--toggle-is-active .mg-input__toggle-item-container:first-of-type {
+  background-color: unset;
+  font-weight: unset;
+  color: hsl(var(--color-dark));
+}
+.mg-input.mg-input--toggle-is-active .mg-input__toggle-item-container:last-of-type {
+  font-weight: 600;
+  color: hsl(var(--color-info));
+  background-color: hsl(var(--color-info-h), calc(var(--color-info-s) - 64%), calc(var(--color-info-l) + 55%));
+}
+
+.mg-input.mg-input--toggle-icon .mg-input__toggle-item-container {
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  width: calc(var(--font-size) * var(--line-height) + 1rem);
+  height: calc(var(--font-size) * var(--line-height) + 1rem);
+  padding: 0;
+  visibility: hidden;
+}
+.mg-input.mg-input--toggle-icon .mg-input__toggle-item-container:first-of-type {
+  visibility: visible;
+}
+.mg-input.mg-input--toggle-icon .mg-input__toggle-item-container ::slotted(mg-icon) {
+  display: flex;
+}
+
+.mg-input.mg-input--toggle-icon.mg-input--toggle-is-active .mg-input__toggle-item-container:first-of-type {
+  visibility: hidden;
+}
+.mg-input.mg-input--toggle-icon.mg-input--toggle-is-active .mg-input__toggle-item-container:last-of-type {
+  visibility: visible;
+}
+
+.mg-input.mg-input--toggle-on-off .mg-input__toggle-item-container:first-of-type {
+  font-weight: 600;
+  color: hsl(var(--color-dark));
+  background-color: hsl(var(--color-dark-h), calc(var(--color-dark-s) - 30%), calc(var(--color-dark-l) + 75%));
+}
+.mg-input.mg-input--toggle-on-off.mg-input--toggle-is-active .mg-input__toggle-item-container:first-of-type {
+  background-color: unset;
+  font-weight: unset;
+  color: hsl(var(--color-dark));
+}
+
+.mg-input.mg-input--toggle-readonly .mg-input__button-toggle {
+  border-color: transparent;
+  background-color: transparent;
+  cursor: initial;
+}
+.mg-input.mg-input--toggle-readonly .mg-input__toggle-item-container:last-of-type {
+  display: none;
+}
+.mg-input.mg-input--toggle-readonly.mg-input--toggle-is-active .mg-input__toggle-item-container:first-of-type {
+  display: none;
+}
+.mg-input.mg-input--toggle-readonly.mg-input--toggle-is-active .mg-input__toggle-item-container:last-of-type {
+  display: flex;
+}
+
+.mg-input.mg-input--toggle-disabled .mg-input__button-toggle {
+  opacity: 0.3;
+  cursor: not-allowed;
+}

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

@@ -0,0 +1,457 @@
+import { Component, Event, h, Prop, State, Watch, Element } from '@stencil/core';
+import { MgInput } from '../MgInput';
+import { createID, ClassList, allItemsAreString } from '../../../../utils/components.utils';
+/**
+ * type Option validation function
+ * @param option
+ * @returns {boolean}
+ */
+const isOption = (option) => typeof option === 'object' && typeof option.title === 'string' && option.value !== undefined;
+export class MgInputToggle {
+  constructor() {
+    /************
+     * Internal *
+     ************/
+    // classes
+    this.classReadonly = 'mg-input--toggle-readonly';
+    this.classDisabled = 'mg-input--toggle-disabled';
+    this.classIsActive = 'mg-input--toggle-is-active';
+    /**
+     * 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-toggle');
+    /**
+     * Input name
+     * If not set the value equals the identifier
+     */
+    this.name = this.identifier;
+    /**
+     * Define if label is visible
+     */
+    this.labelHide = false;
+    /**
+     * Define if toggle have on/off style
+     */
+    this.isOnOff = false;
+    /**
+     * Define if toggle display icon
+     */
+    this.isIcon = 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--toggle']);
+    /**
+     * Checked internal value
+     */
+    this.checked = false;
+    /**
+     * Change checked value
+     */
+    this.toggleChecked = () => {
+      this.setChecked(!this.checked);
+    };
+    /**
+     * Slots validation
+     */
+    this.validateSlots = () => {
+      const slots = Array.from(this.element.children);
+      if (slots.length !== 2) {
+        throw new Error('<mg-input-toggle> 2 slots are required.');
+      }
+      else if (!this.isIcon) {
+        // Due to text-overflow set to ellipsis
+        // we need to ensure that slot element have title to display value on mouse over
+        slots.forEach(slot => slot.setAttribute('title', slot.textContent));
+      }
+    };
+  }
+  validateItems(newValue) {
+    if (typeof newValue === 'object' && this.items.length !== 2) {
+      throw new Error('<mg-input-toggle> prop "items" require 2 items.');
+    }
+    // String array
+    else if (allItemsAreString(newValue)) {
+      this.options = newValue.map(item => ({ title: item, value: item }));
+    }
+    // Object array
+    else if (newValue && newValue.every(item => isOption(item))) {
+      this.options = newValue;
+    }
+    else {
+      throw new Error('<mg-input-toggle> prop "items" is required and all items must be the same type: ToggleValue.');
+    }
+  }
+  handleIsOnOff(newValue) {
+    if (newValue)
+      this.classList.add(`mg-input--toggle-on-off`);
+  }
+  handleIsIcon(newValue) {
+    if (newValue)
+      this.classList.add(`mg-input--toggle-icon`);
+  }
+  handleReadonly(newValue) {
+    if (newValue)
+      this.classList.add(this.classReadonly);
+    else
+      this.classList.delete(this.classReadonly);
+  }
+  handleDisabled(newValue) {
+    if (newValue)
+      this.classList.add(this.classDisabled);
+    else
+      this.classList.delete(this.classDisabled);
+  }
+  handleChecked(newValue) {
+    // style
+    if (newValue)
+      this.classList.add(this.classIsActive);
+    else
+      this.classList.delete(this.classIsActive);
+    // update value
+    this.value = this.options[this.checked ? 1 : 0].value;
+    this.valueChange.emit(this.value);
+  }
+  /**
+   * set checked state
+   * @param newValue?
+   */
+  setChecked(newValue) {
+    // has "value" props type is not a boolean, it is bind/render as an attributes/props
+    // true props will be represent by "true" string so we convert it has boolean
+    // true attribute will be represent by "" string so we convert it has boolean
+    // https://stenciljs.com/docs/properties
+    if (['', 'true'].includes(this.value) && this.options.find(option => option.value) !== undefined) {
+      this.value = true;
+    }
+    if (newValue !== undefined) {
+      this.checked = newValue;
+    }
+    else if (this.value === this.options[1].value) {
+      this.checked = true;
+    }
+    else {
+      this.checked = false;
+    }
+  }
+  /*************
+   * Lifecycle *
+   *************/
+  /**
+   * Check if component props are well configured on init
+   */
+  componentWillLoad() {
+    // Check items format
+    this.validateItems(this.items);
+    // init checked value
+    this.setChecked();
+    // apply handler
+    this.handleIsOnOff(this.isOnOff);
+    this.handleIsIcon(this.isIcon);
+    this.handleReadonly(this.readonly);
+    this.handleDisabled(this.disabled);
+    this.validateSlots();
+  }
+  render() {
+    var _a;
+    return (h(MgInput, { identifier: this.identifier, classList: this.classList, label: this.label, labelOnTop: this.labelOnTop, labelHide: this.labelHide, required: undefined, readonly: undefined, width: undefined, disabled: this.disabled, value: (_a = this.value) === null || _a === void 0 ? void 0 : _a.toString(), readonlyValue: undefined, tooltip: !this.readonly && this.tooltip, displayCharacterLeft: undefined, characterLeftTemplate: undefined, maxlength: undefined, helpText: this.helpText, errorMessage: undefined, isFieldset: false },
+      h("button", { type: "button", role: "switch", "aria-checked": this.checked, "aria-readonly": this.disabled || this.readonly, id: this.identifier, class: "mg-input__button-toggle", disabled: this.disabled || this.readonly, 
+        // eslint-disable-next-line react/jsx-no-bind
+        onClick: () => this.toggleChecked() },
+        h("span", { "aria-hidden": "true", class: "mg-input__toggle-item-container" },
+          h("slot", { name: "item-1" })),
+        h("span", { "aria-hidden": "true", class: "mg-input__toggle-item-container" },
+          h("slot", { name: "item-2" })))));
+  }
+  static get is() { return "mg-input-toggle"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["mg-input-toggle.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["mg-input-toggle.css"]
+  }; }
+  static get properties() { return {
+    "value": {
+      "type": "any",
+      "mutable": true,
+      "complexType": {
+        "original": "any",
+        "resolved": "any",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "Component value"
+      },
+      "attribute": "value",
+      "reflect": false
+    },
+    "items": {
+      "type": "unknown",
+      "mutable": false,
+      "complexType": {
+        "original": "string[] | ToggleValue[]",
+        "resolved": "ToggleValue[] | string[]",
+        "references": {
+          "ToggleValue": {
+            "location": "import",
+            "path": "./mg-input-toggle.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": 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-toggle')"
+    },
+    "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
+    },
+    "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"
+    },
+    "isOnOff": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "Define if toggle have on/off style"
+      },
+      "attribute": "is-on-off",
+      "reflect": false,
+      "defaultValue": "false"
+    },
+    "isIcon": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": true,
+      "docs": {
+        "tags": [],
+        "text": "Define if toggle display icon"
+      },
+      "attribute": "is-icon",
+      "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
+    }
+  }; }
+  static get states() { return {
+    "classList": {},
+    "options": {},
+    "checked": {}
+  }; }
+  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": "any",
+        "resolved": "any",
+        "references": {}
+      }
+    }]; }
+  static get elementRef() { return "element"; }
+  static get watchers() { return [{
+      "propName": "items",
+      "methodName": "validateItems"
+    }, {
+      "propName": "isOnOff",
+      "methodName": "handleIsOnOff"
+    }, {
+      "propName": "isIcon",
+      "methodName": "handleIsIcon"
+    }, {
+      "propName": "readonly",
+      "methodName": "handleReadonly"
+    }, {
+      "propName": "disabled",
+      "methodName": "handleDisabled"
+    }, {
+      "propName": "checked",
+      "methodName": "handleChecked"
+    }]; }
+}