@sme.up/ketchup 8.0.1 → 8.1.0

package/dist/types/components/kup-card/kup-card.d.ts

@@ -1,159 +1,159 @@
-import { EventEmitter, VNode } from '../../stencil-public-runtime';
-import type { GenericObject, KupEventPayload } from '../../types/GenericTypes';
-import { KupCardData, KupCardFamily, KupCardEventPayload, KupCardClickPayload } from './kup-card-declarations';
-export declare class KupCard {
-  /**
-   * References the root HTML element of the component (<kup-card>).
-   */
-  rootElement: HTMLElement;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * The actual data of the card.
-   * @default null
-   */
-  data: KupCardData;
-  /**
-   * Defines whether the card is a menu or not.
-   * Works together with menuVisible.
-   * @default false
-   */
-  isMenu: boolean;
-  /**
-   * Sets the type of the card.
-   * @default KupCardFamily.STANDARD
-   */
-  layoutFamily: KupCardFamily;
-  /**
-   * Sets the number of the layout.
-   * @default 1
-   */
-  layoutNumber: number;
-  /**
-   * Sets the status of the card as menu, when false it's hidden otherwise it's visible.
-   * Works together with isMenu.
-   * @default false
-   */
-  menuVisible: boolean;
-  /**
-   * The width of the card, defaults to 100%. Accepts any valid CSS format (px, %, vw, etc.).
-   * @default "100%"
-   */
-  sizeX: string;
-  /**
-   * The height of the card, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.).
-   * @default "100%"
-   */
-  sizeY: string;
-  /**
-   * kup-card-event callback.
-   */
-  private cardEvent;
-  /**
-   * Instance of the KupManager class.
-   */
-  private kupManager;
-  /**
-   * Previous height of the component, tested when the card is collapsible.
-   */
-  oldSizeY: string;
-  /**
-   * Used to prevent too many resizes callbacks at once.
-   */
-  private resizeTimeout;
-  /**
-   * Prevents multiple scaling callbacks when the card is scalable.
-   */
-  private scalingActive;
-  private componentWrapper;
-  private colorPicker;
-  private firstColorPickerChange;
-  /**
-   * Triggered when the card is clicked.
-   */
-  kupClick: EventEmitter<KupCardClickPayload>;
-  /**
-   * Triggered when a dialog card is closed with the "X".
-   */
-  kupClose: EventEmitter<KupEventPayload>;
-  /**
-   * Triggered when a sub-component of the card emits an event.
-   */
-  kupEvent: EventEmitter<KupCardEventPayload>;
-  /**
-   * Triggered when the component is ready.
-   */
-  kupReady: EventEmitter<KupEventPayload>;
-  onKupClick(id: string, value: string): void;
-  onKupClose(id: string): void;
-  onKupEvent(e: CustomEvent): void;
-  /**
-   * 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.
-   */
-  getProps(descriptions?: boolean): Promise<GenericObject>;
-  /**
-   * This method is used to trigger a new render of the component.
-   */
-  refresh(): Promise<void>;
-  /**
-   * This method is invoked by KupManager whenever the component changes size.
-   */
-  resizeCallback(): Promise<void>;
-  /**
-   * Sets the props to the component.
-   * @param {GenericObject} props - Object containing props that will be set to the component.
-   */
-  setProps(props: GenericObject): Promise<void>;
-  /**
-   * Set the events of the component.
-   */
-  private setEvents;
-  /**
-   * This method is invoked by the layout manager when the layout family is collapsible.
-   * When the card is not expanded and the collapsible content fits the wrapper, the bottom bar won't be displayed.
-   */
-  collapsible(): void;
-  /**
-   * This method will return the virtual node of the card, selecting the correct layout through layoutFamily and layoutNumber.
-   * @returns {VNode} Virtual node of the card for the specified family layout and number.
-   */
-  getLayout(): VNode;
-  /**
-   * This method is invoked by the layout manager when the layout family is dialog.
-   * It will "dialogify" the card.
-   */
-  dialog(): void;
-  /**
-   * This method is invoked by the layout manager when the layout family is built-in.
-   */
-  builtIn(): void;
-  /**
-   * This method will trigger whenever the card's render() hook occurs or when the size changes (through KupManager), in order to manage the more complex layout families.
-   * It will also update any dynamic color handled by the selected layout.
-   */
-  layoutManager(): void;
-  /**
-   * Sets the event listeners on the sub-components, in order to properly emit the generic kup-card-event.
-   */
-  registerListeners(): void;
-  /**
-   * This method is invoked by the layout manager when the layout family is scalable.
-   * The content of the card (.scalable-element) will be resized to fit the wrapper (.scalable-card).
-   * The scaling is performed by using a CSS variable (--kup_card_multiplier) which will impact the card's font-size.
-   * When there is empty space, the multiplier will be increased, as will the content.
-   * Viceversa, when the content exceeds the boundaries, the multiplier will be decreased.
-   */
-  scalable(): void;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  render(): any;
-  disconnectedCallback(): void;
-}
+import { EventEmitter, VNode } from '../../stencil-public-runtime';
+import type { GenericObject, KupEventPayload } from '../../types/GenericTypes';
+import { KupCardData, KupCardFamily, KupCardEventPayload, KupCardClickPayload } from './kup-card-declarations';
+export declare class KupCard {
+  /**
+   * References the root HTML element of the component (<kup-card>).
+   */
+  rootElement: HTMLElement;
+  /**
+   * Custom style of the component.
+   * @default ""
+   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+   */
+  customStyle: string;
+  /**
+   * The actual data of the card.
+   * @default null
+   */
+  data: KupCardData;
+  /**
+   * Defines whether the card is a menu or not.
+   * Works together with menuVisible.
+   * @default false
+   */
+  isMenu: boolean;
+  /**
+   * Sets the type of the card.
+   * @default KupCardFamily.STANDARD
+   */
+  layoutFamily: KupCardFamily;
+  /**
+   * Sets the number of the layout.
+   * @default 1
+   */
+  layoutNumber: number;
+  /**
+   * Sets the status of the card as menu, when false it's hidden otherwise it's visible.
+   * Works together with isMenu.
+   * @default false
+   */
+  menuVisible: boolean;
+  /**
+   * The width of the card, defaults to 100%. Accepts any valid CSS format (px, %, vw, etc.).
+   * @default "100%"
+   */
+  sizeX: string;
+  /**
+   * The height of the card, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.).
+   * @default "100%"
+   */
+  sizeY: string;
+  /**
+   * kup-card-event callback.
+   */
+  private cardEvent;
+  /**
+   * Instance of the KupManager class.
+   */
+  private kupManager;
+  /**
+   * Previous height of the component, tested when the card is collapsible.
+   */
+  oldSizeY: string;
+  /**
+   * Used to prevent too many resizes callbacks at once.
+   */
+  private resizeTimeout;
+  /**
+   * Prevents multiple scaling callbacks when the card is scalable.
+   */
+  private scalingActive;
+  private componentWrapper;
+  private colorPicker;
+  private firstColorPickerChange;
+  /**
+   * Triggered when the card is clicked.
+   */
+  kupClick: EventEmitter<KupCardClickPayload>;
+  /**
+   * Triggered when a dialog card is closed with the "X".
+   */
+  kupClose: EventEmitter<KupEventPayload>;
+  /**
+   * Triggered when a sub-component of the card emits an event.
+   */
+  kupEvent: EventEmitter<KupCardEventPayload>;
+  /**
+   * Triggered when the component is ready.
+   */
+  kupReady: EventEmitter<KupEventPayload>;
+  onKupClick(id: string, value: string): void;
+  onKupClose(id: string): void;
+  onKupEvent(e: CustomEvent): void;
+  /**
+   * 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.
+   */
+  getProps(descriptions?: boolean): Promise<GenericObject>;
+  /**
+   * This method is used to trigger a new render of the component.
+   */
+  refresh(): Promise<void>;
+  /**
+   * This method is invoked by KupManager whenever the component changes size.
+   */
+  resizeCallback(): Promise<void>;
+  /**
+   * Sets the props to the component.
+   * @param {GenericObject} props - Object containing props that will be set to the component.
+   */
+  setProps(props: GenericObject): Promise<void>;
+  /**
+   * Set the events of the component.
+   */
+  private setEvents;
+  /**
+   * This method is invoked by the layout manager when the layout family is collapsible.
+   * When the card is not expanded and the collapsible content fits the wrapper, the bottom bar won't be displayed.
+   */
+  collapsible(): void;
+  /**
+   * This method will return the virtual node of the card, selecting the correct layout through layoutFamily and layoutNumber.
+   * @returns {VNode} Virtual node of the card for the specified family layout and number.
+   */
+  getLayout(): VNode;
+  /**
+   * This method is invoked by the layout manager when the layout family is dialog.
+   * It will "dialogify" the card.
+   */
+  dialog(): void;
+  /**
+   * This method is invoked by the layout manager when the layout family is built-in.
+   */
+  builtIn(): void;
+  /**
+   * This method will trigger whenever the card's render() hook occurs or when the size changes (through KupManager), in order to manage the more complex layout families.
+   * It will also update any dynamic color handled by the selected layout.
+   */
+  layoutManager(): void;
+  /**
+   * Sets the event listeners on the sub-components, in order to properly emit the generic kup-card-event.
+   */
+  registerListeners(): void;
+  /**
+   * This method is invoked by the layout manager when the layout family is scalable.
+   * The content of the card (.scalable-element) will be resized to fit the wrapper (.scalable-card).
+   * The scaling is performed by using a CSS variable (--kup_card_multiplier) which will impact the card's font-size.
+   * When there is empty space, the multiplier will be increased, as will the content.
+   * Viceversa, when the content exceeds the boundaries, the multiplier will be decreased.
+   */
+  scalable(): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  componentDidRender(): void;
+  render(): any;
+  disconnectedCallback(): void;
+}

package/dist/types/components/kup-card/scalable/kup-card-scalable.d.ts

@@ -1,56 +1,56 @@
-import { VNode } from '../../../stencil-public-runtime';
-import type { KupCard } from '../kup-card';
-/**
- * 1st scalable card layout, column of 2 texts.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 1st scalable layout virtual node.
- */
-export declare function create1(component: KupCard): VNode;
-/**
- * 2nd scalable card layout, used to display numerical values.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 2nd scalable layout virtual node.
- */
-export declare function create2(component: KupCard): VNode;
-/**
- * 3rd scalable card layout, column of 2 texts.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 3rd scalable layout virtual node.
- */
-export declare function create3(component: KupCard): VNode;
-/**
- * 4th scalable card layout, used to display numerical values with subtitle.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 4th scalable layout virtual node.
- */
-export declare function create4(component: KupCard): VNode;
-/**
- * 5th scalable card layout, icon with title and subtitle.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 5th scalable layout virtual node.
- */
-export declare function create5(component: KupCard): VNode;
-/**
- * 6th scalable card layout, icon with title and subtitle.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 6th scalable layout virtual node.
- */
-export declare function create6(component: KupCard): VNode;
-/**
- * 7th scalable card layout, icon with title and subtitle.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 7th scalable layout virtual node.
- */
-export declare function create7(component: KupCard): VNode;
-/**
- * 8th scalable card layout, icon with title and subtitle.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 8th scalable layout virtual node.
- */
-export declare function create8(component: KupCard): VNode;
-/**
- * 9th scalable card layout, tile view.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 8th scalable layout virtual node.
- */
-export declare function create9(component: KupCard): VNode;
+import { VNode } from '../../../stencil-public-runtime';
+import type { KupCard } from '../kup-card';
+/**
+ * 1st scalable card layout, column of 2 texts.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 1st scalable layout virtual node.
+ */
+export declare function create1(component: KupCard): VNode;
+/**
+ * 2nd scalable card layout, used to display numerical values.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 2nd scalable layout virtual node.
+ */
+export declare function create2(component: KupCard): VNode;
+/**
+ * 3rd scalable card layout, column of 2 texts.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 3rd scalable layout virtual node.
+ */
+export declare function create3(component: KupCard): VNode;
+/**
+ * 4th scalable card layout, used to display numerical values with subtitle.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 4th scalable layout virtual node.
+ */
+export declare function create4(component: KupCard): VNode;
+/**
+ * 5th scalable card layout, icon with title and subtitle.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 5th scalable layout virtual node.
+ */
+export declare function create5(component: KupCard): VNode;
+/**
+ * 6th scalable card layout, icon with title and subtitle.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 6th scalable layout virtual node.
+ */
+export declare function create6(component: KupCard): VNode;
+/**
+ * 7th scalable card layout, icon with title and subtitle.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 7th scalable layout virtual node.
+ */
+export declare function create7(component: KupCard): VNode;
+/**
+ * 8th scalable card layout, icon with title and subtitle.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 8th scalable layout virtual node.
+ */
+export declare function create8(component: KupCard): VNode;
+/**
+ * 9th scalable card layout, tile view.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 8th scalable layout virtual node.
+ */
+export declare function create9(component: KupCard): VNode;

package/dist/types/components/kup-card/standard/kup-card-standard.d.ts

@@ -1,92 +1,92 @@
-import { VNode } from '../../../stencil-public-runtime';
-import type { KupCard } from '../kup-card';
-/**
- * 1st standard card layout, inspired by Material Design.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 1st standard layout virtual node.
- */
-export declare function create1(component: KupCard): VNode;
-/**
- * 2nd standard card layout, inspired by Material Design.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 2nd standard layout virtual node.
- */
-export declare function create2(component: KupCard): VNode;
-/**
- * 3rd standard card layout, inspired by Material Design.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 3rd standard layout virtual node.
- */
-export declare function create3(component: KupCard): VNode;
-/**
- * 4th standard card layout, inspired by Material Design.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 4th standard layout virtual node.
- */
-export declare function create4(component: KupCard): VNode;
-/**
- * 5th standard card layout, useful to display TODOs with extensive information.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 5th standard layout virtual node.
- */
-export declare function create5(component: KupCard): VNode;
-/**
- * 6th standard card layout, useful to display TODOs in a compact view.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 6th standard layout virtual node.
- */
-export declare function create6(component: KupCard): VNode;
-/**
- * 7th standard card layout, centered image and text.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 7th standard layout virtual node.
- */
-export declare function create7(component: KupCard): VNode;
-/**
- * 8th standard card layout, useful to display a list of chips.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 8th standard layout virtual node.
- */
-export declare function create8(component: KupCard): VNode;
-/**
- * 9th standard card layout, chart displayed on the right with some info on the left.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 9th standard layout virtual node.
- */
-export declare function create9(component: KupCard): VNode;
-/**
- * 10th standard card layout, chart displayed on the left with some info on the right.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 10th standard layout virtual node.
- */
-export declare function create10(component: KupCard): VNode;
-/**
- * 11th standard card layout, chart displayed on the right with some info on the left, visible when hovering on the colored bar.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 11th standard layout virtual node.
- */
-export declare function create11(component: KupCard): VNode;
-/**
- * 12th standard card layout, used for column menus in tree and data table.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 12th standard layout virtual node.
- */
-export declare function create12(component: KupCard): VNode;
-/**
- * 13th standard card layout, buttons and text lines, used for debug window.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 13th standard layout virtual node.
- */
-export declare function create13(component: KupCard): VNode;
-/**
- * 14th standard card layout, used for column menus in tree and data table (with tabs). This is a very specifically-designed layout, so correct ids are a must.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 14th standard layout virtual node.
- */
-export declare function create14(component: KupCard): VNode;
-/**
- * 15th standard card layout, it can be used as a tooltip.
- * @param {KupCard} component - Card component.
- * @returns {VNode} 15th standard layout virtual node.
- */
-export declare function create15(component: KupCard): VNode;
+import { VNode } from '../../../stencil-public-runtime';
+import type { KupCard } from '../kup-card';
+/**
+ * 1st standard card layout, inspired by Material Design.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 1st standard layout virtual node.
+ */
+export declare function create1(component: KupCard): VNode;
+/**
+ * 2nd standard card layout, inspired by Material Design.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 2nd standard layout virtual node.
+ */
+export declare function create2(component: KupCard): VNode;
+/**
+ * 3rd standard card layout, inspired by Material Design.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 3rd standard layout virtual node.
+ */
+export declare function create3(component: KupCard): VNode;
+/**
+ * 4th standard card layout, inspired by Material Design.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 4th standard layout virtual node.
+ */
+export declare function create4(component: KupCard): VNode;
+/**
+ * 5th standard card layout, useful to display TODOs with extensive information.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 5th standard layout virtual node.
+ */
+export declare function create5(component: KupCard): VNode;
+/**
+ * 6th standard card layout, useful to display TODOs in a compact view.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 6th standard layout virtual node.
+ */
+export declare function create6(component: KupCard): VNode;
+/**
+ * 7th standard card layout, centered image and text.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 7th standard layout virtual node.
+ */
+export declare function create7(component: KupCard): VNode;
+/**
+ * 8th standard card layout, useful to display a list of chips.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 8th standard layout virtual node.
+ */
+export declare function create8(component: KupCard): VNode;
+/**
+ * 9th standard card layout, chart displayed on the right with some info on the left.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 9th standard layout virtual node.
+ */
+export declare function create9(component: KupCard): VNode;
+/**
+ * 10th standard card layout, chart displayed on the left with some info on the right.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 10th standard layout virtual node.
+ */
+export declare function create10(component: KupCard): VNode;
+/**
+ * 11th standard card layout, chart displayed on the right with some info on the left, visible when hovering on the colored bar.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 11th standard layout virtual node.
+ */
+export declare function create11(component: KupCard): VNode;
+/**
+ * 12th standard card layout, used for column menus in tree and data table.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 12th standard layout virtual node.
+ */
+export declare function create12(component: KupCard): VNode;
+/**
+ * 13th standard card layout, buttons and text lines, used for debug window.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 13th standard layout virtual node.
+ */
+export declare function create13(component: KupCard): VNode;
+/**
+ * 14th standard card layout, used for column menus in tree and data table (with tabs). This is a very specifically-designed layout, so correct ids are a must.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 14th standard layout virtual node.
+ */
+export declare function create14(component: KupCard): VNode;
+/**
+ * 15th standard card layout, it can be used as a tooltip.
+ * @param {KupCard} component - Card component.
+ * @returns {VNode} 15th standard layout virtual node.
+ */
+export declare function create15(component: KupCard): VNode;

package/dist/types/components/kup-cell/kup-cell-declarations.d.ts

@@ -1,10 +1,10 @@
-/**
- * Props of the kup-cell component.
- * Used to export every prop in an object.
- */
-export declare enum KupCellProps {
-  customStyle = "Custom style of the component.",
-  data = "The data of the cell.",
-  density = "The density of the cell, defaults at 'dense' and can be also set to 'wide' or 'medium'.",
-  dragEnabled = "When set to true, the component is draggable."
-}
+/**
+ * Props of the kup-cell component.
+ * Used to export every prop in an object.
+ */
+export declare enum KupCellProps {
+  customStyle = "Custom style of the component.",
+  data = "The data of the cell.",
+  density = "The density of the cell, defaults at 'dense' and can be also set to 'wide' or 'medium'.",
+  dragEnabled = "When set to true, the component is draggable."
+}