@sme.up/ketchup 6.6.0 → 6.8.0

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

@@ -1,4 +1,4 @@
-import { Component, Element, Event, forceUpdate, h, Host, Method, Prop, } from '@stencil/core';
+import { forceUpdate, h, Host, } from '@stencil/core';
 import { kupManagerInstance, } from '../../managers/kup-manager/kup-manager';
 import { imageCanvas } from './canvas/kup-image-canvas';
 import { FImage } from '../../f-components/f-image/f-image';
@@ -9,63 +9,23 @@ import { getProps, setProps } from '../../utils/utils';
 import { componentWrapperId } from '../../variables/GenericVariables';
 export class KupImage {
   constructor() {
-    /*-------------------------------------------------*/
-    /*                    P r o p s                    */
-    /*-------------------------------------------------*/
     /**
-     * Sets the data of badges.
-     * @default null
+     * True when the resource is an URL.
      */
-    this.badgeData = null;
+    this.isUrl = false;
     /**
-     * The color of the icon, defaults to the CSS variable KupThemeColorValues.ICON.
-     * @default KupThemeColorValues.ICON
+     * Instance of the KupManager class.
      */
+    this.kupManager = kupManagerInstance();
+    this.badgeData = null;
     this.color = `var(${KupThemeColorValues.ICON})`;
-    /**
-     * Custom style of the component.
-     * @default ""
-     * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-     */
     this.customStyle = '';
-    /**
-     * When present, the component will be drawn using CSS. Check the 'Drawing with CSS' section of the image showcase for more information.
-     * @default null
-     */
     this.data = null;
-    /**
-     * When set to true, a spinner will be displayed until the image finished loading. Not compatible with SVGs.
-     * @default false
-     */
     this.feedback = false;
-    /**
-     * The image component will create a canvas element on which it's possible to draw. It's a temporary feature that will be fully replaced by CSS drawing in the future.
-     * @default false
-     */
     this.isCanvas = false;
-    /**
-     * The resource used to fetch the image.
-     * @default null
-     */
     this.resource = null;
-    /**
-     * The width of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.).
-     * @default '100%'
-     */
     this.sizeX = '100%';
-    /**
-     * The height of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.).
-     * @default '100%'
-     */
     this.sizeY = '100%';
-    /**
-     * True when the resource is an URL.
-     */
-    this.isUrl = false;
-    /**
-     * Instance of the KupManager class.
-     */
-    this.kupManager = kupManagerInstance();
   }
   onKupClick(e) {
     this.kupClick.emit({
@@ -106,8 +66,7 @@ export class KupImage {
    * @todo should be handled inside f-image.
    */
   renderCanvas() {
-    return (h("div", { id: "kup-component", onClick: (e) => this.onKupClick(e), class: "is-canvas" },
-      h("canvas", { ref: (el) => (this.canvas = el) }, this.resource)));
+    return (h("div", { id: "kup-component", onClick: (e) => this.onKupClick(e), class: "is-canvas" }, h("canvas", { ref: (el) => (this.canvas = el) }, this.resource)));
   }
   /*-------------------------------------------------*/
   /*          L i f e c y c l e   H o o k s          */
@@ -163,8 +122,7 @@ export class KupImage {
     };
     if (this.feedback && this.isUrl) {
       spinnerLayout = 14;
-      feedback = (h("div", { id: "feedback", title: "Image not loaded yet..." },
-        h("kup-spinner", { dimensions: "3px", active: true, layout: spinnerLayout })));
+      feedback = (h("div", { id: "feedback", title: "Image not loaded yet..." }, h("kup-spinner", { dimensions: "3px", active: true, layout: spinnerLayout })));
     }
     if (this.isCanvas) {
       el = this.renderCanvas();
@@ -177,322 +135,329 @@ export class KupImage {
       this.kupManager.debug.logMessage(this, message, KupDebugCategory.WARNING);
       return;
     }
-    return (h(Host, { style: elStyle },
-      h("style", null, this.kupManager.theme.setKupStyle(this.rootElement)),
-      feedback,
-      h("div", { id: componentWrapperId }, el)));
+    return (h(Host, { style: elStyle }, h("style", null, this.kupManager.theme.setKupStyle(this.rootElement)), feedback, h("div", { id: componentWrapperId }, el)));
   }
   disconnectedCallback() {
     this.kupManager.theme.unregister(this);
   }
   static get is() { return "kup-image"; }
   static get encapsulation() { return "shadow"; }
-  static get originalStyleUrls() { return {
-    "$": ["kup-image.scss"]
-  }; }
-  static get styleUrls() { return {
-    "$": ["kup-image.css"]
-  }; }
+  static get originalStyleUrls() {
+    return {
+      "$": ["kup-image.scss"]
+    };
+  }
+  static get styleUrls() {
+    return {
+      "$": ["kup-image.css"]
+    };
+  }
   static get assetsDirs() { return ["assets/svg"]; }
-  static get properties() { return {
-    "badgeData": {
-      "type": "unknown",
-      "mutable": false,
-      "complexType": {
-        "original": "KupBadge[]",
-        "resolved": "KupBadge[]",
-        "references": {
-          "KupBadge": {
-            "location": "import",
-            "path": "../kup-badge/kup-badge"
+  static get properties() {
+    return {
+      "badgeData": {
+        "type": "unknown",
+        "mutable": false,
+        "complexType": {
+          "original": "KupBadge[]",
+          "resolved": "KupBadge[]",
+          "references": {
+            "KupBadge": {
+              "location": "import",
+              "path": "../kup-badge/kup-badge"
+            }
           }
-        }
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "null"
-          }],
-        "text": "Sets the data of badges."
-      },
-      "defaultValue": "null"
-    },
-    "color": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "KupThemeColorValues.ICON"
-          }],
-        "text": "The color of the icon, defaults to the CSS variable KupThemeColorValues.ICON."
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "null"
+            }],
+          "text": "Sets the data of badges."
+        },
+        "defaultValue": "null"
       },
-      "attribute": "color",
-      "reflect": false,
-      "defaultValue": "`var(${KupThemeColorValues.ICON})`"
-    },
-    "customStyle": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
+      "color": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "KupThemeColorValues.ICON"
+            }],
+          "text": "The color of the icon, defaults to the CSS variable KupThemeColorValues.ICON."
+        },
+        "attribute": "color",
+        "reflect": false,
+        "defaultValue": "`var(${KupThemeColorValues.ICON})`"
       },
-      "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."
+      "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": "''"
       },
-      "attribute": "custom-style",
-      "reflect": false,
-      "defaultValue": "''"
-    },
-    "data": {
-      "type": "unknown",
-      "mutable": false,
-      "complexType": {
-        "original": "FImageData[]",
-        "resolved": "FImageData[]",
-        "references": {
-          "FImageData": {
-            "location": "import",
-            "path": "../../f-components/f-image/f-image-declarations"
+      "data": {
+        "type": "unknown",
+        "mutable": false,
+        "complexType": {
+          "original": "FImageData[]",
+          "resolved": "FImageData[]",
+          "references": {
+            "FImageData": {
+              "location": "import",
+              "path": "../../f-components/f-image/f-image-declarations"
+            }
           }
-        }
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "null"
-          }],
-        "text": "When present, the component will be drawn using CSS. Check the 'Drawing with CSS' section of the image showcase for more information."
-      },
-      "defaultValue": "null"
-    },
-    "feedback": {
-      "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, a spinner will be displayed until the image finished loading. Not compatible with SVGs."
-      },
-      "attribute": "feedback",
-      "reflect": false,
-      "defaultValue": "false"
-    },
-    "isCanvas": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "false"
-          }],
-        "text": "The image component will create a canvas element on which it's possible to draw. It's a temporary feature that will be fully replaced by CSS drawing in the future."
-      },
-      "attribute": "is-canvas",
-      "reflect": false,
-      "defaultValue": "false"
-    },
-    "resource": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "null"
-          }],
-        "text": "The resource used to fetch the image."
-      },
-      "attribute": "resource",
-      "reflect": false,
-      "defaultValue": "null"
-    },
-    "sizeX": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "null"
+            }],
+          "text": "When present, the component will be drawn using CSS. Check the 'Drawing with CSS' section of the image showcase for more information."
+        },
+        "defaultValue": "null"
       },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "'100%'"
-          }],
-        "text": "The width of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.)."
+      "feedback": {
+        "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, a spinner will be displayed until the image finished loading. Not compatible with SVGs."
+        },
+        "attribute": "feedback",
+        "reflect": false,
+        "defaultValue": "false"
       },
-      "attribute": "size-x",
-      "reflect": false,
-      "defaultValue": "'100%'"
-    },
-    "sizeY": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
+      "isCanvas": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "false"
+            }],
+          "text": "The image component will create a canvas element on which it's possible to draw. It's a temporary feature that will be fully replaced by CSS drawing in the future."
+        },
+        "attribute": "is-canvas",
+        "reflect": false,
+        "defaultValue": "false"
       },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "'100%'"
-          }],
-        "text": "The height of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.)."
+      "resource": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "null"
+            }],
+          "text": "The resource used to fetch the image."
+        },
+        "attribute": "resource",
+        "reflect": false,
+        "defaultValue": "null"
       },
-      "attribute": "size-y",
-      "reflect": false,
-      "defaultValue": "'100%'"
-    }
-  }; }
-  static get events() { return [{
-      "method": "kupClick",
-      "name": "kup-image-click",
-      "bubbles": true,
-      "cancelable": false,
-      "composed": true,
-      "docs": {
-        "tags": [],
-        "text": ""
+      "sizeX": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "'100%'"
+            }],
+          "text": "The width of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.)."
+        },
+        "attribute": "size-x",
+        "reflect": false,
+        "defaultValue": "'100%'"
       },
-      "complexType": {
-        "original": "KupImageClickEventPayload",
-        "resolved": "KupImageClickEventPayload",
-        "references": {
-          "KupImageClickEventPayload": {
-            "location": "import",
-            "path": "./kup-image-declarations"
+      "sizeY": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "'100%'"
+            }],
+          "text": "The height of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.)."
+        },
+        "attribute": "size-y",
+        "reflect": false,
+        "defaultValue": "'100%'"
+      }
+    };
+  }
+  static get events() {
+    return [{
+        "method": "kupClick",
+        "name": "kup-image-click",
+        "bubbles": true,
+        "cancelable": false,
+        "composed": true,
+        "docs": {
+          "tags": [],
+          "text": ""
+        },
+        "complexType": {
+          "original": "KupImageClickEventPayload",
+          "resolved": "KupImageClickEventPayload",
+          "references": {
+            "KupImageClickEventPayload": {
+              "location": "import",
+              "path": "./kup-image-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"
+      }];
+  }
+  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"
+            }
           },
-          "GenericObject": {
-            "location": "import",
-            "path": "../../types/GenericTypes"
-          }
+          "return": "Promise<GenericObject>"
         },
-        "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."
+            }]
+        }
       },
-      "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"
-          }
+      "refresh": {
+        "complexType": {
+          "signature": "() => Promise<void>",
+          "parameters": [],
+          "references": {
+            "Promise": {
+              "location": "global"
+            }
+          },
+          "return": "Promise<void>"
         },
-        "return": "Promise<void>"
+        "docs": {
+          "text": "This method is used to trigger a new render of the component.",
+          "tags": []
+        }
       },
-      "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"
+      "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"
+            }
           },
-          "GenericObject": {
-            "location": "import",
-            "path": "../../types/GenericTypes"
-          }
+          "return": "Promise<void>"
         },
-        "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."
-          }]
+        "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"; }
 }