@sme.up/ketchup 6.6.0 → 6.8.0

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

@@ -1,4 +1,4 @@
-import { Component, Element, Event, forceUpdate, h, Host, Method, Prop, State, } from '@stencil/core';
+import { forceUpdate, h, Host, } from '@stencil/core';
 import { kupManagerInstance, } from '../../managers/kup-manager/kup-manager';
 import { FButton } from '../../f-components/f-button/f-button';
 import { FButtonStyling, } from '../../f-components/f-button/f-button-declarations';
@@ -9,79 +9,24 @@ import { componentWrapperId } from '../../variables/GenericVariables';
 export class KupButton {
   constructor() {
     /*-------------------------------------------------*/
-    /*                   S t a t e s                   */
+    /*       I n t e r n a l   V a r i a b l e s       */
     /*-------------------------------------------------*/
     /**
-     * The value of the component.
-     * @default ""
+     * Instance of the KupManager class.
      */
+    this.kupManager = kupManagerInstance();
     this.value = '';
-    /*-------------------------------------------------*/
-    /*                    P r o p s                    */
-    /*-------------------------------------------------*/
-    /**
-     * Sets the type of the button.
-     * @default null
-     */
     this.buttonType = null;
-    /**
-     * When set to true, the icon button state will be on.
-     * @default false
-     */
     this.checked = false;
-    /**
-     * Custom style of the component.
-     * @default ""
-     * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-     */
     this.customStyle = '';
-    /**
-     * Defaults at false. When set to true, the component is disabled.
-     * @default false
-     */
     this.disabled = false;
-    /**
-     * When set, the button will show this icon.
-     * @default null
-     */
     this.icon = null;
-    /**
-     * When set, the icon button off state will show this icon. Otherwise, an outlined version of the icon prop will be displayed.
-     * @default null
-     */
     this.iconOff = null;
-    /**
-     * When set, the button will show this text.
-     * @default null
-     */
     this.label = null;
-    /**
-     * Defines the style of the button. Styles available: "flat", "outlined" and "raised" which is also the default.
-     * @default FButtonStyling.RAISED
-     */
     this.styling = FButtonStyling.RAISED;
-    /**
-     * When set to true, the button show a spinner received in slot.
-     * @default false
-     */
     this.showSpinner = false;
-    /**
-     * When set to true, the icon button will be toggable on/off.
-     * @default false
-     */
     this.toggable = false;
-    /**
-     * When set, the icon will be shown after the text.
-     * @default false
-     */
     this.trailingIcon = false;
-    /*-------------------------------------------------*/
-    /*       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();
   }
   onKupBlur() {
     this.kupBlur.emit({
@@ -222,405 +167,414 @@ export class KupButton {
       this.kupManager.debug.logMessage(this, 'Empty button.', KupDebugCategory.WARNING);
       return;
     }
-    return (h(Host, null,
-      h("style", null, this.kupManager.theme.setKupStyle(this.rootElement)),
-      h("div", { id: componentWrapperId },
-        h(FButton, Object.assign({}, props)))));
+    return (h(Host, null, h("style", null, this.kupManager.theme.setKupStyle(this.rootElement)), h("div", { id: componentWrapperId }, h(FButton, Object.assign({}, props)))));
   }
   disconnectedCallback() {
     this.kupManager.theme.unregister(this);
   }
   static get is() { return "kup-button"; }
   static get encapsulation() { return "shadow"; }
-  static get originalStyleUrls() { return {
-    "$": ["kup-button.scss"]
-  }; }
-  static get styleUrls() { return {
-    "$": ["kup-button.css"]
-  }; }
-  static get properties() { return {
-    "buttonType": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "null"
-          }],
-        "text": "Sets the type of the button."
-      },
-      "attribute": "button-type",
-      "reflect": false,
-      "defaultValue": "null"
-    },
-    "checked": {
-      "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 icon button state will be on."
-      },
-      "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": "Defaults at false. When set to true, the component is disabled."
+  static get originalStyleUrls() {
+    return {
+      "$": ["kup-button.scss"]
+    };
+  }
+  static get styleUrls() {
+    return {
+      "$": ["kup-button.css"]
+    };
+  }
+  static get properties() {
+    return {
+      "buttonType": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "null"
+            }],
+          "text": "Sets the type of the button."
+        },
+        "attribute": "button-type",
+        "reflect": false,
+        "defaultValue": "null"
       },
-      "attribute": "disabled",
-      "reflect": false,
-      "defaultValue": "false"
-    },
-    "icon": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
+      "checked": {
+        "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 icon button state will be on."
+        },
+        "attribute": "checked",
+        "reflect": false,
+        "defaultValue": "false"
       },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "null"
-          }],
-        "text": "When set, the button will show this icon."
+      "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": "icon",
-      "reflect": false,
-      "defaultValue": "null"
-    },
-    "iconOff": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
+      "disabled": {
+        "type": "boolean",
+        "mutable": false,
+        "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 is disabled."
+        },
+        "attribute": "disabled",
+        "reflect": false,
+        "defaultValue": "false"
       },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "null"
-          }],
-        "text": "When set, the icon button off state will show this icon. Otherwise, an outlined version of the icon prop will be displayed."
+      "icon": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "null"
+            }],
+          "text": "When set, the button will show this icon."
+        },
+        "attribute": "icon",
+        "reflect": false,
+        "defaultValue": "null"
       },
-      "attribute": "icon-off",
-      "reflect": false,
-      "defaultValue": "null"
-    },
-    "label": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "string",
-        "resolved": "string",
-        "references": {}
+      "iconOff": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "null"
+            }],
+          "text": "When set, the icon button off state will show this icon. Otherwise, an outlined version of the icon prop will be displayed."
+        },
+        "attribute": "icon-off",
+        "reflect": false,
+        "defaultValue": "null"
       },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "null"
-          }],
-        "text": "When set, the button will show this text."
+      "label": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "string",
+          "resolved": "string",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "null"
+            }],
+          "text": "When set, the button will show this text."
+        },
+        "attribute": "label",
+        "reflect": false,
+        "defaultValue": "null"
       },
-      "attribute": "label",
-      "reflect": false,
-      "defaultValue": "null"
-    },
-    "styling": {
-      "type": "string",
-      "mutable": false,
-      "complexType": {
-        "original": "FButtonStyling",
-        "resolved": "FButtonStyling.FLAT | FButtonStyling.FLOATING | FButtonStyling.ICON | FButtonStyling.OUTLINED | FButtonStyling.RAISED",
-        "references": {
-          "FButtonStyling": {
-            "location": "import",
-            "path": "../../f-components/f-button/f-button-declarations"
+      "styling": {
+        "type": "string",
+        "mutable": false,
+        "complexType": {
+          "original": "FButtonStyling",
+          "resolved": "FButtonStyling.FLAT | FButtonStyling.FLOATING | FButtonStyling.ICON | FButtonStyling.OUTLINED | FButtonStyling.RAISED",
+          "references": {
+            "FButtonStyling": {
+              "location": "import",
+              "path": "../../f-components/f-button/f-button-declarations"
+            }
           }
-        }
-      },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "FButtonStyling.RAISED"
-          }],
-        "text": "Defines the style of the button. Styles available: \"flat\", \"outlined\" and \"raised\" which is also the default."
-      },
-      "attribute": "styling",
-      "reflect": false,
-      "defaultValue": "FButtonStyling.RAISED"
-    },
-    "showSpinner": {
-      "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 button show a spinner received in slot."
-      },
-      "attribute": "show-spinner",
-      "reflect": false,
-      "defaultValue": "false"
-    },
-    "toggable": {
-      "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 icon button will be toggable on/off."
-      },
-      "attribute": "toggable",
-      "reflect": false,
-      "defaultValue": "false"
-    },
-    "trailingIcon": {
-      "type": "boolean",
-      "mutable": false,
-      "complexType": {
-        "original": "boolean",
-        "resolved": "boolean",
-        "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "FButtonStyling.RAISED"
+            }],
+          "text": "Defines the style of the button. Styles available: \"flat\", \"outlined\" and \"raised\" which is also the default."
+        },
+        "attribute": "styling",
+        "reflect": false,
+        "defaultValue": "FButtonStyling.RAISED"
       },
-      "required": false,
-      "optional": false,
-      "docs": {
-        "tags": [{
-            "name": "default",
-            "text": "false"
-          }],
-        "text": "When set, the icon will be shown after the text."
+      "showSpinner": {
+        "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 button show a spinner received in slot."
+        },
+        "attribute": "show-spinner",
+        "reflect": false,
+        "defaultValue": "false"
       },
-      "attribute": "trailing-icon",
-      "reflect": false,
-      "defaultValue": "false"
-    }
-  }; }
-  static get states() { return {
-    "value": {}
-  }; }
-  static get events() { return [{
-      "method": "kupBlur",
-      "name": "kup-button-blur",
-      "bubbles": true,
-      "cancelable": false,
-      "composed": true,
-      "docs": {
-        "tags": [],
-        "text": "Triggered when the button loses focus."
+      "toggable": {
+        "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 icon button will be toggable on/off."
+        },
+        "attribute": "toggable",
+        "reflect": false,
+        "defaultValue": "false"
       },
-      "complexType": {
-        "original": "KupButtonClickEventPayload",
-        "resolved": "KupButtonClickEventPayload",
-        "references": {
-          "KupButtonClickEventPayload": {
-            "location": "import",
-            "path": "./kup-button-declarations"
+      "trailingIcon": {
+        "type": "boolean",
+        "mutable": false,
+        "complexType": {
+          "original": "boolean",
+          "resolved": "boolean",
+          "references": {}
+        },
+        "required": false,
+        "optional": false,
+        "docs": {
+          "tags": [{
+              "name": "default",
+              "text": "false"
+            }],
+          "text": "When set, the icon will be shown after the text."
+        },
+        "attribute": "trailing-icon",
+        "reflect": false,
+        "defaultValue": "false"
+      }
+    };
+  }
+  static get states() {
+    return {
+      "value": {}
+    };
+  }
+  static get events() {
+    return [{
+        "method": "kupBlur",
+        "name": "kup-button-blur",
+        "bubbles": true,
+        "cancelable": false,
+        "composed": true,
+        "docs": {
+          "tags": [],
+          "text": "Triggered when the button loses focus."
+        },
+        "complexType": {
+          "original": "KupButtonClickEventPayload",
+          "resolved": "KupButtonClickEventPayload",
+          "references": {
+            "KupButtonClickEventPayload": {
+              "location": "import",
+              "path": "./kup-button-declarations"
+            }
           }
         }
-      }
-    }, {
-      "method": "kupClick",
-      "name": "kup-button-click",
-      "bubbles": true,
-      "cancelable": false,
-      "composed": true,
-      "docs": {
-        "tags": [],
-        "text": "Triggered when the button is clicked."
-      },
-      "complexType": {
-        "original": "KupButtonClickEventPayload",
-        "resolved": "KupButtonClickEventPayload",
-        "references": {
-          "KupButtonClickEventPayload": {
-            "location": "import",
-            "path": "./kup-button-declarations"
+      }, {
+        "method": "kupClick",
+        "name": "kup-button-click",
+        "bubbles": true,
+        "cancelable": false,
+        "composed": true,
+        "docs": {
+          "tags": [],
+          "text": "Triggered when the button is clicked."
+        },
+        "complexType": {
+          "original": "KupButtonClickEventPayload",
+          "resolved": "KupButtonClickEventPayload",
+          "references": {
+            "KupButtonClickEventPayload": {
+              "location": "import",
+              "path": "./kup-button-declarations"
+            }
           }
         }
-      }
-    }, {
-      "method": "kupFocus",
-      "name": "kup-button-focus",
-      "bubbles": true,
-      "cancelable": false,
-      "composed": true,
-      "docs": {
-        "tags": [],
-        "text": "Triggered when the button is focused."
-      },
-      "complexType": {
-        "original": "KupButtonClickEventPayload",
-        "resolved": "KupButtonClickEventPayload",
-        "references": {
-          "KupButtonClickEventPayload": {
-            "location": "import",
-            "path": "./kup-button-declarations"
+      }, {
+        "method": "kupFocus",
+        "name": "kup-button-focus",
+        "bubbles": true,
+        "cancelable": false,
+        "composed": true,
+        "docs": {
+          "tags": [],
+          "text": "Triggered when the button is focused."
+        },
+        "complexType": {
+          "original": "KupButtonClickEventPayload",
+          "resolved": "KupButtonClickEventPayload",
+          "references": {
+            "KupButtonClickEventPayload": {
+              "location": "import",
+              "path": "./kup-button-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"; }
 }