@sme.up/ketchup 8.0.2 → 8.1.0

package/dist/collection/components/kup-checkbox/kup-checkbox.js

@@ -1,433 +1,433 @@
-import { forceUpdate, h, Host, } from '@stencil/core';
-import { kupManagerInstance, } from '../../managers/kup-manager/kup-manager';
-import { FCheckbox } from '../../f-components/f-checkbox/f-checkbox';
-import { KupCheckboxProps, } from './kup-checkbox-declarations';
-import { getProps, setProps } from '../../utils/utils';
-import { componentWrapperId } from '../../variables/GenericVariables';
-export class KupCheckbox {
-  constructor() {
-    /*-------------------------------------------------*/
-    /*       I n t e r n a l   V a r i a b l e s       */
-    /*-------------------------------------------------*/
-    /**
-     * Instance of the KupManager class.
-     */
-    this.kupManager = kupManagerInstance();
-    this.value = '';
-    this.checked = false;
-    this.customStyle = '';
-    this.disabled = false;
-    this.indeterminate = false;
-    this.label = null;
-    this.leadingLabel = false;
-  }
-  onKupBlur() {
-    this.kupBlur.emit({
-      comp: this,
-      id: this.rootElement.id,
-      checked: this.checked == true ? true : false,
-      value: this.value,
-    });
-  }
-  onKupChange() {
-    if (this.indeterminate) {
-      this.checked = true;
-      this.indeterminate = false;
-      this.value = 'indeterminate';
-    }
-    else if (this.checked) {
-      this.checked = false;
-      this.value = 'off';
-    }
-    else {
-      this.checked = true;
-      this.value = 'on';
-    }
-    this.kupChange.emit({
-      comp: this,
-      id: this.rootElement.id,
-      checked: this.checked,
-      value: this.value,
-    });
-  }
-  onKupFocus() {
-    this.kupFocus.emit({
-      comp: this,
-      id: this.rootElement.id,
-      checked: this.checked == true ? true : false,
-      value: this.value,
-    });
-  }
-  /*-------------------------------------------------*/
-  /*           P u b l i c   M e t h o d s           */
-  /*-------------------------------------------------*/
-  /**
-   * Used to retrieve component's props values.
-   * @param {boolean} descriptions - When provided and true, the result will be the list of props with their description.
-   * @returns {Promise<GenericObject>} List of props as object, each key will be a prop.
-   */
-  async getProps(descriptions) {
-    return getProps(this, KupCheckboxProps, descriptions);
-  }
-  /**
-   * This method is used to trigger a new render of the component.
-   */
-  async refresh() {
-    forceUpdate(this);
-  }
-  /**
-   * Sets the props to the component.
-   * @param {GenericObject} props - Object containing props that will be set to the component.
-   */
-  async setProps(props) {
-    setProps(this, KupCheckboxProps, props);
-  }
-  /*-------------------------------------------------*/
-  /*          L i f e c y c l e   H o o k s          */
-  /*-------------------------------------------------*/
-  componentWillLoad() {
-    this.kupManager.debug.logLoad(this, false);
-    this.kupManager.theme.register(this);
-  }
-  componentDidLoad() {
-    this.kupManager.debug.logLoad(this, true);
-  }
-  componentWillRender() {
-    this.kupManager.debug.logRender(this, false);
-    if (this.checked) {
-      this.value = 'on';
-    }
-    else {
-      this.value = 'off';
-    }
-  }
-  componentDidRender() {
-    this.kupManager.debug.logRender(this, true);
-  }
-  render() {
-    const props = {
-      checked: this.checked,
-      danger: this.rootElement.classList.contains('kup-danger')
-        ? true
-        : false,
-      disabled: this.disabled,
-      indeterminate: this.indeterminate,
-      info: this.rootElement.classList.contains('kup-info')
-        ? true
-        : false,
-      label: this.label,
-      leadingLabel: this.leadingLabel,
-      secondary: this.rootElement.classList.contains('kup-secondary')
-        ? true
-        : false,
-      success: this.rootElement.classList.contains('kup-success')
-        ? true
-        : false,
-      warning: this.rootElement.classList.contains('kup-warning')
-        ? true
-        : false,
-      onBlur: () => this.onKupBlur(),
-      onChange: () => this.onKupChange(),
-      onFocus: () => this.onKupFocus(),
-    };
-    return (h(Host, null, h("style", null, this.kupManager.theme.setKupStyle(this.rootElement)), h("div", { id: componentWrapperId }, h(FCheckbox, Object.assign({}, props)))));
-  }
-  disconnectedCallback() {
-    this.kupManager.theme.unregister(this);
-  }
-  static get is() { return "kup-checkbox"; }
-  static get encapsulation() { return "shadow"; }
-  static get originalStyleUrls() {
-    return {
-      "$": ["kup-checkbox.scss"]
-    };
-  }
-  static get styleUrls() {
-    return {
-      "$": ["kup-checkbox.css"]
-    };
-  }
-  static get properties() {
-    return {
-      "checked": {
-        "type": "boolean",
-        "mutable": true,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [{
-              "name": "default",
-              "text": "false"
-            }],
-          "text": "Defaults at false. When set to true, the component will be set to 'checked'."
-        },
-        "attribute": "checked",
-        "reflect": false,
-        "defaultValue": "false"
-      },
-      "customStyle": {
-        "type": "string",
-        "mutable": false,
-        "complexType": {
-          "original": "string",
-          "resolved": "string",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [{
-              "name": "default",
-              "text": "\"\""
-            }, {
-              "name": "see",
-              "text": "https://ketchup.smeup.com/ketchup-showcase/#/customization"
-            }],
-          "text": "Custom style of the component."
-        },
-        "attribute": "custom-style",
-        "reflect": false,
-        "defaultValue": "''"
-      },
-      "disabled": {
-        "type": "boolean",
-        "mutable": false,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [{
-              "name": "default",
-              "text": "false"
-            }],
-          "text": "When set to true, the component is disabled."
-        },
-        "attribute": "disabled",
-        "reflect": false,
-        "defaultValue": "false"
-      },
-      "indeterminate": {
-        "type": "boolean",
-        "mutable": true,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [{
-              "name": "default",
-              "text": "false"
-            }],
-          "text": "When set to true, the component will be set to 'indeterminate'."
-        },
-        "attribute": "indeterminate",
-        "reflect": false,
-        "defaultValue": "false"
-      },
-      "label": {
-        "type": "string",
-        "mutable": false,
-        "complexType": {
-          "original": "string",
-          "resolved": "string",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [{
-              "name": "default",
-              "text": "null"
-            }],
-          "text": "When specified, its content will be shown as a label."
-        },
-        "attribute": "label",
-        "reflect": false,
-        "defaultValue": "null"
-      },
-      "leadingLabel": {
-        "type": "boolean",
-        "mutable": false,
-        "complexType": {
-          "original": "boolean",
-          "resolved": "boolean",
-          "references": {}
-        },
-        "required": false,
-        "optional": false,
-        "docs": {
-          "tags": [{
-              "name": "default",
-              "text": "false"
-            }],
-          "text": "When set to true, the label will be on the left of the component."
-        },
-        "attribute": "leading-label",
-        "reflect": false,
-        "defaultValue": "false"
-      }
-    };
-  }
-  static get states() {
-    return {
-      "value": {}
-    };
-  }
-  static get events() {
-    return [{
-        "method": "kupBlur",
-        "name": "kup-checkbox-blur",
-        "bubbles": true,
-        "cancelable": false,
-        "composed": true,
-        "docs": {
-          "tags": [],
-          "text": "Triggered when the input element loses focus."
-        },
-        "complexType": {
-          "original": "KupCheckboxEventPayload",
-          "resolved": "KupCheckboxEventPayload",
-          "references": {
-            "KupCheckboxEventPayload": {
-              "location": "import",
-              "path": "./kup-checkbox-declarations"
-            }
-          }
-        }
-      }, {
-        "method": "kupChange",
-        "name": "kup-checkbox-change",
-        "bubbles": true,
-        "cancelable": false,
-        "composed": true,
-        "docs": {
-          "tags": [],
-          "text": "Triggered when the input element's value changes."
-        },
-        "complexType": {
-          "original": "KupCheckboxEventPayload",
-          "resolved": "KupCheckboxEventPayload",
-          "references": {
-            "KupCheckboxEventPayload": {
-              "location": "import",
-              "path": "./kup-checkbox-declarations"
-            }
-          }
-        }
-      }, {
-        "method": "kupFocus",
-        "name": "kup-checkbox-focus",
-        "bubbles": true,
-        "cancelable": false,
-        "composed": true,
-        "docs": {
-          "tags": [],
-          "text": "Triggered when the input element gets focused."
-        },
-        "complexType": {
-          "original": "KupCheckboxEventPayload",
-          "resolved": "KupCheckboxEventPayload",
-          "references": {
-            "KupCheckboxEventPayload": {
-              "location": "import",
-              "path": "./kup-checkbox-declarations"
-            }
-          }
-        }
-      }];
-  }
-  static get methods() {
-    return {
-      "getProps": {
-        "complexType": {
-          "signature": "(descriptions?: boolean) => Promise<GenericObject>",
-          "parameters": [{
-              "tags": [{
-                  "name": "param",
-                  "text": "descriptions - When provided and true, the result will be the list of props with their description."
-                }],
-              "text": "- When provided and true, the result will be the list of props with their description."
-            }],
-          "references": {
-            "Promise": {
-              "location": "global"
-            },
-            "GenericObject": {
-              "location": "import",
-              "path": "../../types/GenericTypes"
-            }
-          },
-          "return": "Promise<GenericObject>"
-        },
-        "docs": {
-          "text": "Used to retrieve component's props values.",
-          "tags": [{
-              "name": "param",
-              "text": "descriptions - When provided and true, the result will be the list of props with their description."
-            }, {
-              "name": "returns",
-              "text": "List of props as object, each key will be a prop."
-            }]
-        }
-      },
-      "refresh": {
-        "complexType": {
-          "signature": "() => Promise<void>",
-          "parameters": [],
-          "references": {
-            "Promise": {
-              "location": "global"
-            }
-          },
-          "return": "Promise<void>"
-        },
-        "docs": {
-          "text": "This method is used to trigger a new render of the component.",
-          "tags": []
-        }
-      },
-      "setProps": {
-        "complexType": {
-          "signature": "(props: GenericObject) => Promise<void>",
-          "parameters": [{
-              "tags": [{
-                  "name": "param",
-                  "text": "props - Object containing props that will be set to the component."
-                }],
-              "text": "- Object containing props that will be set to the component."
-            }],
-          "references": {
-            "Promise": {
-              "location": "global"
-            },
-            "GenericObject": {
-              "location": "import",
-              "path": "../../types/GenericTypes"
-            }
-          },
-          "return": "Promise<void>"
-        },
-        "docs": {
-          "text": "Sets the props to the component.",
-          "tags": [{
-              "name": "param",
-              "text": "props - Object containing props that will be set to the component."
-            }]
-        }
-      }
-    };
-  }
-  static get elementRef() { return "rootElement"; }
-}
+import { forceUpdate, h, Host, } from '@stencil/core';
+import { kupManagerInstance, } from '../../managers/kup-manager/kup-manager';
+import { FCheckbox } from '../../f-components/f-checkbox/f-checkbox';
+import { KupCheckboxProps, } from './kup-checkbox-declarations';
+import { getProps, setProps } from '../../utils/utils';
+import { componentWrapperId } from '../../variables/GenericVariables';
+export class KupCheckbox {
+  constructor() {
+    /*-------------------------------------------------*/
+    /*       I n t e r n a l   V a r i a b l e s       */
+    /*-------------------------------------------------*/
+    /**
+     * Instance of the KupManager class.
+     */
+    this.kupManager = kupManagerInstance();
+    this.value = '';
+    this.checked = false;
+    this.customStyle = '';
+    this.disabled = false;
+    this.indeterminate = false;
+    this.label = null;
+    this.leadingLabel = false;
+  }
+  onKupBlur() {
+    this.kupBlur.emit({
+      comp: this,
+      id: this.rootElement.id,
+      checked: this.checked == true ? true : false,
+      value: this.value,
+    });
+  }
+  onKupChange() {
+    if (this.indeterminate) {
+      this.checked = true;
+      this.indeterminate = false;
+      this.value = 'indeterminate';
+    }
+    else if (this.checked) {
+      this.checked = false;
+      this.value = 'off';
+    }
+    else {
+      this.checked = true;
+      this.value = 'on';
+    }
+    this.kupChange.emit({
+      comp: this,
+      id: this.rootElement.id,
+      checked: this.checked,
+      value: this.value,
+    });
+  }
+  onKupFocus() {
+    this.kupFocus.emit({
+      comp: this,
+      id: this.rootElement.id,
+      checked: this.checked == true ? true : false,
+      value: this.value,
+    });
+  }
+  /*-------------------------------------------------*/
+  /*           P u b l i c   M e t h o d s           */
+  /*-------------------------------------------------*/
+  /**
+   * Used to retrieve component's props values.
+   * @param {boolean} descriptions - When provided and true, the result will be the list of props with their description.
+   * @returns {Promise<GenericObject>} List of props as object, each key will be a prop.
+   */
+  async getProps(descriptions) {
+    return getProps(this, KupCheckboxProps, descriptions);
+  }
+  /**
+   * This method is used to trigger a new render of the component.
+   */
+  async refresh() {
+    forceUpdate(this);
+  }
+  /**
+   * Sets the props to the component.
+   * @param {GenericObject} props - Object containing props that will be set to the component.
+   */
+  async setProps(props) {
+    setProps(this, KupCheckboxProps, props);
+  }
+  /*-------------------------------------------------*/
+  /*          L i f e c y c l e   H o o k s          */
+  /*-------------------------------------------------*/
+  componentWillLoad() {
+    this.kupManager.debug.logLoad(this, false);
+    this.kupManager.theme.register(this);
+  }
+  componentDidLoad() {
+    this.kupManager.debug.logLoad(this, true);
+  }
+  componentWillRender() {
+    this.kupManager.debug.logRender(this, false);
+    if (this.checked) {
+      this.value = 'on';
+    }
+    else {
+      this.value = 'off';
+    }
+  }
+  componentDidRender() {
+    this.kupManager.debug.logRender(this, true);
+  }
+  render() {
+    const props = {
+      checked: this.checked,
+      danger: this.rootElement.classList.contains('kup-danger')
+        ? true
+        : false,
+      disabled: this.disabled,
+      indeterminate: this.indeterminate,
+      info: this.rootElement.classList.contains('kup-info')
+        ? true
+        : false,
+      label: this.label,
+      leadingLabel: this.leadingLabel,
+      secondary: this.rootElement.classList.contains('kup-secondary')
+        ? true
+        : false,
+      success: this.rootElement.classList.contains('kup-success')
+        ? true
+        : false,
+      warning: this.rootElement.classList.contains('kup-warning')
+        ? true
+        : false,
+      onBlur: () => this.onKupBlur(),
+      onChange: () => this.onKupChange(),
+      onFocus: () => this.onKupFocus(),
+    };
+    return (h(Host, null, h("style", null, this.kupManager.theme.setKupStyle(this.rootElement)), h("div", { id: componentWrapperId }, h(FCheckbox, Object.assign({}, props)))));
+  }
+  disconnectedCallback() {
+    this.kupManager.theme.unregister(this);
+  }
+  static get is() { return "kup-checkbox"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() {
+    return {
+      "$": ["kup-checkbox.scss"]
+    };
+  }
+  static get styleUrls() {
+    return {
+      "$": ["kup-checkbox.css"]
+    };
+  }
+  static get properties() {
+    return {
+      "checked": {
+        "type": "boolean",
+        "mutable": true,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "false"
+            }],
+          "text": "Defaults at false. When set to true, the component will be set to 'checked'."
+        },
+        "attribute": "checked",
+        "reflect": false,
+        "defaultValue": "false"
+      },
+      "customStyle": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "\"\""
+            }, {
+              "name": "see",
+              "text": "https://ketchup.smeup.com/ketchup-showcase/#/customization"
+            }],
+          "text": "Custom style of the component."
+        },
+        "attribute": "custom-style",
+        "reflect": false,
+        "defaultValue": "''"
+      },
+      "disabled": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "false"
+            }],
+          "text": "When set to true, the component is disabled."
+        },
+        "attribute": "disabled",
+        "reflect": false,
+        "defaultValue": "false"
+      },
+      "indeterminate": {
+        "type": "boolean",
+        "mutable": true,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "false"
+            }],
+          "text": "When set to true, the component will be set to 'indeterminate'."
+        },
+        "attribute": "indeterminate",
+        "reflect": false,
+        "defaultValue": "false"
+      },
+      "label": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "null"
+            }],
+          "text": "When specified, its content will be shown as a label."
+        },
+        "attribute": "label",
+        "reflect": false,
+        "defaultValue": "null"
+      },
+      "leadingLabel": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "false"
+            }],
+          "text": "When set to true, the label will be on the left of the component."
+        },
+        "attribute": "leading-label",
+        "reflect": false,
+        "defaultValue": "false"
+      }
+    };
+  }
+  static get states() {
+    return {
+      "value": {}
+    };
+  }
+  static get events() {
+    return [{
+        "method": "kupBlur",
+        "name": "kup-checkbox-blur",
+        "bubbles": true,
+        "cancelable": false,
+        "composed": true,
+        "docs": {
+          "tags": [],
+          "text": "Triggered when the input element loses focus."
+        },
+        "complexType": {
+          "original": "KupCheckboxEventPayload",
+          "resolved": "KupCheckboxEventPayload",
+          "references": {
+            "KupCheckboxEventPayload": {
+              "location": "import",
+              "path": "./kup-checkbox-declarations"
+            }
+          }
+        }
+      }, {
+        "method": "kupChange",
+        "name": "kup-checkbox-change",
+        "bubbles": true,
+        "cancelable": false,
+        "composed": true,
+        "docs": {
+          "tags": [],
+          "text": "Triggered when the input element's value changes."
+        },
+        "complexType": {
+          "original": "KupCheckboxEventPayload",
+          "resolved": "KupCheckboxEventPayload",
+          "references": {
+            "KupCheckboxEventPayload": {
+              "location": "import",
+              "path": "./kup-checkbox-declarations"
+            }
+          }
+        }
+      }, {
+        "method": "kupFocus",
+        "name": "kup-checkbox-focus",
+        "bubbles": true,
+        "cancelable": false,
+        "composed": true,
+        "docs": {
+          "tags": [],
+          "text": "Triggered when the input element gets focused."
+        },
+        "complexType": {
+          "original": "KupCheckboxEventPayload",
+          "resolved": "KupCheckboxEventPayload",
+          "references": {
+            "KupCheckboxEventPayload": {
+              "location": "import",
+              "path": "./kup-checkbox-declarations"
+            }
+          }
+        }
+      }];
+  }
+  static get methods() {
+    return {
+      "getProps": {
+        "complexType": {
+          "signature": "(descriptions?: boolean) => Promise<GenericObject>",
+          "parameters": [{
+              "tags": [{
+                  "name": "param",
+                  "text": "descriptions - When provided and true, the result will be the list of props with their description."
+                }],
+              "text": "- When provided and true, the result will be the list of props with their description."
+            }],
+          "references": {
+            "Promise": {
+              "location": "global"
+            },
+            "GenericObject": {
+              "location": "import",
+              "path": "../../types/GenericTypes"
+            }
+          },
+          "return": "Promise<GenericObject>"
+        },
+        "docs": {
+          "text": "Used to retrieve component's props values.",
+          "tags": [{
+              "name": "param",
+              "text": "descriptions - When provided and true, the result will be the list of props with their description."
+            }, {
+              "name": "returns",
+              "text": "List of props as object, each key will be a prop."
+            }]
+        }
+      },
+      "refresh": {
+        "complexType": {
+          "signature": "() => Promise<void>",
+          "parameters": [],
+          "references": {
+            "Promise": {
+              "location": "global"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "This method is used to trigger a new render of the component.",
+          "tags": []
+        }
+      },
+      "setProps": {
+        "complexType": {
+          "signature": "(props: GenericObject) => Promise<void>",
+          "parameters": [{
+              "tags": [{
+                  "name": "param",
+                  "text": "props - Object containing props that will be set to the component."
+                }],
+              "text": "- Object containing props that will be set to the component."
+            }],
+          "references": {
+            "Promise": {
+              "location": "global"
+            },
+            "GenericObject": {
+              "location": "import",
+              "path": "../../types/GenericTypes"
+            }
+          },
+          "return": "Promise<void>"
+        },
+        "docs": {
+          "text": "Sets the props to the component.",
+          "tags": [{
+              "name": "param",
+              "text": "props - Object containing props that will be set to the component."
+            }]
+        }
+      }
+    };
+  }
+  static get elementRef() { return "rootElement"; }
+}