@sme.up/ketchup 5.2.1-SNAPSHOT → 6.2.0-SNAPSHOT

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

@@ -0,0 +1,560 @@
+import { Component, Element, forceUpdate, h, Host, Method, Prop, State, Event, Watch, } from '@stencil/core';
+import { FButton } from '../../f-components/f-button/f-button';
+import { FCheckbox } from '../../f-components/f-checkbox/f-checkbox';
+import { FTextField } from '../../f-components/f-text-field/f-text-field';
+import { FTextFieldMDC } from '../../f-components/f-text-field/f-text-field-mdc';
+import { KupDebugCategory } from '../../managers/kup-debug/kup-debug-declarations';
+import { KupDragEffect } from '../../managers/kup-interact/kup-interact-declarations';
+import { KupLanguageDashboard, KupLanguageGeneric, } from '../../managers/kup-language/kup-language-declarations';
+import { kupManagerInstance, } from '../../managers/kup-manager/kup-manager';
+import { getProps, setProps } from '../../utils/utils';
+import { componentWrapperId } from '../../variables/GenericVariables';
+import { KupDashboardProps, } from './kup-dashboard-declarations';
+export class KupDashboard {
+  constructor() {
+    /*-------------------------------------------------*/
+    /*                   S t a t e s                   */
+    /*-------------------------------------------------*/
+    /**
+     * Force render component by internal event.
+     */
+    this.resetInternalData = false;
+    /*-------------------------------------------------*/
+    /*                    P r o p s                    */
+    /*-------------------------------------------------*/
+    /**
+     * Custom style of the component.
+     * @default ""
+     * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+     */
+    this.customStyle = '';
+    /**
+     * The data of the component.
+     * @default null
+     */
+    this.data = null;
+    /**
+     * Enable drag & drop of the section.
+     * @default false
+     */
+    this.enableDesign = 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();
+    /**
+     * Internal data of the component.
+     */
+    this.internalData = null;
+    /**
+     * Internal data backup of the component for refresh when changed content by drag&drop.
+     */
+    this.internalDataBackup = null;
+  }
+  onKupSave() {
+    this.kupSave.emit({
+      comp: this,
+      id: this.rootElement.id,
+      data: this.internalData,
+    });
+  }
+  /*-------------------------------------------------*/
+  /*                  W a t c h e r s                */
+  /*-------------------------------------------------*/
+  dataChanged() {
+    this.resetData();
+  }
+  /*-------------------------------------------------*/
+  /*           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, KupDashboardProps, 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, KupDashboardProps, props);
+  }
+  /*-------------------------------------------------*/
+  /*           P r i v a t e   M e t h o d s         */
+  /*-------------------------------------------------*/
+  buildGuid() {
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+      var r = (Math.random() * 16) | 0, v = c === 'x' ? r : (r & 0x3) | 0x8;
+      return v.toString(16);
+    });
+  }
+  buildHeader() {
+    const clearButtonProp = {
+      icon: 'cancel',
+      label: this.kupManager.language.translate(KupLanguageDashboard.RESET),
+      secondary: true,
+      onClick: () => {
+        this.resetData();
+      },
+    };
+    const saveButtonProp = {
+      icon: 'save',
+      label: this.kupManager.language.translate(KupLanguageDashboard.SAVE),
+      onClick: () => this.onKupSave(),
+    };
+    return (h("div", { class: "header" },
+      this.enableDesign ? (h(FButton, Object.assign({}, clearButtonProp))) : undefined,
+      this.enableDesign ? (h(FButton, Object.assign({}, saveButtonProp))) : undefined));
+  }
+  buildForm(form, parent) {
+    const classes = {
+      form: true,
+      'layout-column': form && form.layout == 'column',
+      'layout-row': form && form.layout == 'row',
+      'form-dropzone': this.enableDesign &&
+        form &&
+        form.sections != null &&
+        form.sections.length > 0,
+    };
+    return form ? (h("div", { class: classes, style: this.getGridStyle(form), ref: (el) => {
+        if (!el)
+          return;
+        const kel = el;
+        kel.kupData = { parent: parent, form: form };
+      } }, form.sections.map((section) => this.buildSection(section, form)))) : (h("div", null, this.kupManager.language.translate(KupLanguageGeneric.EMPTY_DATA)));
+  }
+  buildSectionHeader(section, parent) {
+    const dimTextFieldProp = {
+      value: section.dim,
+      label: this.kupManager.language.translate(KupLanguageDashboard.DIMENSION),
+      onChange: (e) => {
+        const { target } = e;
+        section.dim = target.value;
+      },
+    };
+    const addButtonProp = {
+      icon: 'add',
+      slim: true,
+      onClick: () => {
+        if (!section.sections) {
+          section.sections = [];
+        }
+        const newSec = {
+          id: section.id + (section.sections.length + 1),
+          loaded: section.loaded,
+          layout: section.layout,
+        };
+        section.sections.push(newSec);
+        this.resetData(this.internalData);
+      },
+    };
+    const removeButtonProp = {
+      icon: 'remove',
+      slim: true,
+      secondary: true,
+      onClick: () => {
+        const idx = parent.sections.indexOf(section);
+        parent.sections.splice(idx, 1);
+        this.resetData(this.internalData);
+      },
+    };
+    const loadedCheckBoxProp = {
+      checked: section.loaded,
+      label: this.kupManager.language.translate(KupLanguageDashboard.LOADED),
+      onChange: () => {
+        section.loaded = !section.loaded;
+        this.refresh();
+      },
+    };
+    const columnCheckBoxProp = {
+      checked: section.layout == 'column',
+      label: this.kupManager.language.translate(KupLanguageDashboard.VERTICAL),
+      onChange: () => {
+        section.layout = section.layout == 'column' ? 'row' : 'column';
+        this.refresh();
+      },
+    };
+    return (h("div", { class: "section-header" },
+      h("div", null,
+        section.id,
+        " - ",
+        section.layout),
+      h("div", null,
+        h("div", { class: "section-header-actions" },
+          h(FTextField, Object.assign({}, dimTextFieldProp)),
+          h(FCheckbox, Object.assign({}, loadedCheckBoxProp)),
+          h(FCheckbox, Object.assign({}, columnCheckBoxProp)),
+          h(FButton, Object.assign({}, addButtonProp)),
+          h(FButton, Object.assign({}, removeButtonProp))))));
+  }
+  buildSection(section, parent) {
+    const classes = {
+      section: true,
+      'section-draggable': this.enableDesign,
+      'section-dropzone': this.enableDesign,
+    };
+    const bodyClasses = {
+      'section-body': true,
+      'layout-column': section && section.layout == 'column',
+      'layout-row': section && section.layout == 'row',
+    };
+    return (h("div", { class: classes, ref: (el) => {
+        if (!el)
+          return;
+        const kel = el;
+        kel.kupData = { parent: parent, section: section };
+      } },
+      this.enableDesign
+        ? this.buildSectionHeader(section, parent)
+        : undefined,
+      h("div", { class: bodyClasses, style: this.getGridStyle(section) },
+        !this.enableDesign &&
+          section.loaded &&
+          (!section.sections || section.sections.length == 0) ? (h("slot", { name: section.id })) : undefined,
+        section.sections && (section.loaded || this.enableDesign)
+          ? section.sections.map((childSection) => this.buildSection(childSection, section))
+          : undefined)));
+  }
+  didRenderInteractables() {
+    try {
+      const items = [];
+      this.rootElement.shadowRoot
+        .querySelectorAll('.section-draggable')
+        .forEach((x) => items.push(x));
+      items.forEach((item) => {
+        this.kupManager.interact.draggable(item, null, null, KupDragEffect.CLONE);
+      });
+    }
+    catch (error) {
+      this.kupManager.debug.logMessage(this, error, KupDebugCategory.ERROR);
+    }
+    try {
+      const items = [];
+      this.rootElement.shadowRoot
+        .querySelectorAll('.section-dropzone')
+        .forEach((x) => items.push(x));
+      this.rootElement.shadowRoot
+        .querySelectorAll('.form-dropzone')
+        .forEach((x) => items.push(x));
+      items.forEach((item) => {
+        this.kupManager.interact.dropzone(item, null, null, {
+          drop: (ev) => {
+            this.dropped(ev.currentTarget, ev.relatedTarget);
+          },
+        });
+      });
+    }
+    catch (error) {
+      this.kupManager.debug.logMessage(this, error, KupDebugCategory.ERROR);
+    }
+  }
+  dropped(parent, child) {
+    const idx = child.kupData.parent.sections.indexOf(child.kupData.section);
+    child.kupData.parent.sections.splice(idx, 1);
+    if (parent.kupData.form) {
+      // form is the target of drop.
+      if (!parent.kupData.form.sections)
+        parent.kupData.form.sections = [];
+      parent.kupData.form.sections.push(child.kupData.section);
+      child.kupData.parent = parent.kupData.form;
+    }
+    else if (parent.kupData.section) {
+      // section is the target of drop.
+      if (!parent.kupData.section.sections ||
+        parent.kupData.section.sections.length == 0) {
+        // if the section target of drop doesn't contains other sections, i create a wrapper that will contain target section and dragged section.
+        const newSec = JSON.parse(JSON.stringify(parent.kupData.section));
+        newSec.dim = null;
+        child.kupData.section.dim = null;
+        parent.kupData.section.id = this.buildGuid();
+        parent.kupData.section.sections = [];
+        parent.kupData.section.sections.push(newSec);
+      }
+      parent.kupData.section.sections.push(child.kupData.section);
+      child.kupData.parent = parent.kupData.section;
+    }
+    this.resetData(this.internalData);
+  }
+  getGridStyle(entity) {
+    let bodyStyles = {};
+    if (!this.enableDesign && entity.sections) {
+      let gridTemplate = '';
+      entity.sections.forEach((childSection) => {
+        if (!childSection.dim)
+          gridTemplate += ' 1fr';
+        else
+          gridTemplate +=
+            childSection.dim.indexOf('%') < 0
+              ? ' ' + childSection.dim + 'px'
+              : ' ' + childSection.dim;
+      });
+      if (entity.layout == 'column')
+        bodyStyles['gridTemplateRows'] = gridTemplate;
+      if (entity.layout == 'row')
+        bodyStyles['gridTemplateColumns'] = gridTemplate;
+    }
+    return bodyStyles;
+  }
+  resetData(form = null) {
+    if (form)
+      this.internalDataBackup = form;
+    this.resetInternalData = true;
+    setTimeout(() => {
+      if (this.internalDataBackup) {
+        this.internalData = this.internalDataBackup;
+        this.internalDataBackup = null;
+      }
+      this.resetInternalData = false;
+    }, 250);
+  }
+  unregisterInteractables() {
+    this.kupManager.interact.unregister(Array.from(this.rootElement.shadowRoot.querySelectorAll('.section-dropzone')));
+    this.kupManager.interact.unregister(Array.from(this.rootElement.shadowRoot.querySelectorAll('.section-draggable')));
+    this.kupManager.interact.unregister(Array.from(this.rootElement.shadowRoot.querySelectorAll('.form-dropzone')));
+  }
+  /*-------------------------------------------------*/
+  /*          L i f e c y c l e   H o o k s          */
+  /*-------------------------------------------------*/
+  componentWillLoad() {
+    this.kupManager.dates.register(this);
+    this.kupManager.debug.logLoad(this, false);
+    this.kupManager.language.register(this);
+    this.kupManager.theme.register(this);
+  }
+  componentDidLoad() {
+    this.kupManager.debug.logLoad(this, true);
+  }
+  componentWillRender() {
+    this.kupManager.debug.logRender(this, false);
+    if (this.resetInternalData) {
+      this.internalData = null;
+      this.unregisterInteractables();
+    }
+    else if (!this.internalData)
+      this.internalData = JSON.parse(JSON.stringify(this.data));
+  }
+  componentDidRender() {
+    this.kupManager.debug.logRender(this, true);
+    const root = this.rootElement.shadowRoot;
+    if (root) {
+      const fields = root.querySelectorAll('.f-text-field');
+      if (fields)
+        fields.forEach((f) => {
+          FTextFieldMDC(f);
+        });
+    }
+    this.didRenderInteractables();
+  }
+  render() {
+    return (h(Host, null,
+      h("style", null, this.kupManager.theme.setKupStyle(this.rootElement)),
+      h("div", { id: componentWrapperId },
+        this.buildHeader(),
+        this.buildForm(this.internalData, null))));
+  }
+  disconnectedCallback() {
+    this.unregisterInteractables();
+    this.kupManager.dates.unregister(this);
+    this.kupManager.language.unregister(this);
+    this.kupManager.theme.unregister(this);
+  }
+  static get is() { return "kup-dashboard"; }
+  static get encapsulation() { return "shadow"; }
+  static get originalStyleUrls() { return {
+    "$": ["kup-dashboard.scss"]
+  }; }
+  static get styleUrls() { return {
+    "$": ["kup-dashboard.css"]
+  }; }
+  static get properties() { return {
+    "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": "''"
+    },
+    "data": {
+      "type": "unknown",
+      "mutable": false,
+      "complexType": {
+        "original": "KupDataDashboard",
+        "resolved": "KupDataDashboard",
+        "references": {
+          "KupDataDashboard": {
+            "location": "import",
+            "path": "./kup-dashboard-declarations"
+          }
+        }
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "default",
+            "text": "null"
+          }],
+        "text": "The data of the component."
+      },
+      "defaultValue": "null"
+    },
+    "enableDesign": {
+      "type": "boolean",
+      "mutable": false,
+      "complexType": {
+        "original": "boolean",
+        "resolved": "boolean",
+        "references": {}
+      },
+      "required": false,
+      "optional": false,
+      "docs": {
+        "tags": [{
+            "name": "default",
+            "text": "false"
+          }],
+        "text": "Enable drag & drop of the section."
+      },
+      "attribute": "enable-design",
+      "reflect": false,
+      "defaultValue": "false"
+    }
+  }; }
+  static get states() { return {
+    "resetInternalData": {}
+  }; }
+  static get events() { return [{
+      "method": "kupSave",
+      "name": "kup-dashboard-save",
+      "bubbles": true,
+      "cancelable": false,
+      "composed": true,
+      "docs": {
+        "tags": [],
+        "text": ""
+      },
+      "complexType": {
+        "original": "KupDashboardEventPayload",
+        "resolved": "KupDashboardEventPayload",
+        "references": {
+          "KupDashboardEventPayload": {
+            "location": "import",
+            "path": "./kup-dashboard-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"; }
+  static get watchers() { return [{
+      "propName": "data",
+      "methodName": "dataChanged"
+    }]; }
+}

package/dist/collection/components/kup-data-table/kup-data-table-declarations.js

@@ -47,7 +47,6 @@ export var KupDataTableProps;
   KupDataTableProps["showGroups"] = "When set to true enables the column grouping.";
   KupDataTableProps["showHeader"] = "Enables rendering of the table header.";
   KupDataTableProps["showLoadMore"] = "If set to true, displays the button to load more records.";
-  KupDataTableProps["showTooltipOnRightClick"] = "If set to true, displays tooltip on right click; if set to false, displays tooltip on mouseOver.";
   KupDataTableProps["sort"] = "Defines the current sorting options.";
   KupDataTableProps["stateId"] = "";
   KupDataTableProps["store"] = "";
@@ -55,9 +54,8 @@ export var KupDataTableProps;
   KupDataTableProps["sortEnabled"] = "When set to true enables the sorting of the columns by clicking on the column header.";
   KupDataTableProps["tableHeight"] = "Sets the height of the table.";
   KupDataTableProps["tableWidth"] = "Sets the width of the table.";
-  KupDataTableProps["tooltipDetailTimeout"] = "Defines the timeout for tooltip detail";
-  KupDataTableProps["tooltipEnabled"] = "Enable show tooltip";
   KupDataTableProps["totals"] = "Defines the current totals options.";
+  KupDataTableProps["transpose"] = "Transposes the data of the data table.";
 })(KupDataTableProps || (KupDataTableProps = {}));
 export var SortMode;
 (function (SortMode) {