@sme.up/ketchup 8.0.2 → 8.2.0

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

@@ -1,18 +1,18 @@
-/**
- * Props of the kup-lazy component.
- * Used to export every prop in an object.
- */
-export declare enum KupLazyProps {
-  componentName = "Sets the tag name of the component to be lazy loaded.",
-  customStyle = "Custom style of the component.",
-  data = "Sets the data of the component to be lazy loaded.",
-  showPlaceholder = "Displays an animated SVG placeholder until the component is loaded."
-}
-/**
- * Decides when the sub component should be rendered.
- */
-export declare enum KupLazyRender {
-  VIEWPORT = "viewport",
-  PROPS = "props",
-  BOTH = "both"
-}
+/**
+ * Props of the kup-lazy component.
+ * Used to export every prop in an object.
+ */
+export declare enum KupLazyProps {
+  componentName = "Sets the tag name of the component to be lazy loaded.",
+  customStyle = "Custom style of the component.",
+  data = "Sets the data of the component to be lazy loaded.",
+  showPlaceholder = "Displays an animated SVG placeholder until the component is loaded."
+}
+/**
+ * Decides when the sub component should be rendered.
+ */
+export declare enum KupLazyRender {
+  VIEWPORT = "viewport",
+  PROPS = "props",
+  BOTH = "both"
+}

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

@@ -1,78 +1,78 @@
-import { EventEmitter } from '../../stencil-public-runtime';
-import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
-import { KupLazyRender } from './kup-lazy-declarations';
-export declare class KupLazy {
-  /**
-   * References the root HTML element of the component (<kup-lazy>).
-   */
-  rootElement: HTMLElement;
-  isInViewport: boolean;
-  /**
-   * Sets the tag name of the component to be lazy loaded.
-   * @default null
-   */
-  componentName: string;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * Sets the data of the component to be lazy loaded.
-   * @default null
-   */
-  data: GenericObject;
-  /**
-   * Decides when the sub-component should be rendered.
-   * By default when both the component props exist and the component is in the viewport.
-   * @default KupLazyRender.BOTH
-   */
-  renderMode: KupLazyRender;
-  /**
-   * Displays an animated SVG placeholder until the component is loaded.
-   * @default true
-   */
-  showPlaceholder: boolean;
-  /**
-   * Instance of the intersection observer.
-   */
-  private intObserver;
-  /**
-   * Instance of the KupManager class.
-   */
-  private kupManager;
-  private lazyComponent;
-  private lazyComponentLoaded;
-  /**
-   * Triggered when the component is loaded.
-   */
-  kupLazyLoaded: EventEmitter<KupEventPayload>;
-  /**
-   * 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>;
-  /**
-   * Returns the HTMLElement of the component to lazy load.
-   * @returns {HTMLElement} Lazy loaded component.
-   */
-  getComponent(): Promise<HTMLElement>;
-  /**
-   * This method is used to trigger a new render of the component.
-   */
-  refresh(): 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>;
-  setObserver(): void;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  render(): any;
-  disconnectedCallback(): void;
-}
+import { EventEmitter } from '../../stencil-public-runtime';
+import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
+import { KupLazyRender } from './kup-lazy-declarations';
+export declare class KupLazy {
+  /**
+   * References the root HTML element of the component (<kup-lazy>).
+   */
+  rootElement: HTMLElement;
+  isInViewport: boolean;
+  /**
+   * Sets the tag name of the component to be lazy loaded.
+   * @default null
+   */
+  componentName: string;
+  /**
+   * Custom style of the component.
+   * @default ""
+   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+   */
+  customStyle: string;
+  /**
+   * Sets the data of the component to be lazy loaded.
+   * @default null
+   */
+  data: GenericObject;
+  /**
+   * Decides when the sub-component should be rendered.
+   * By default when both the component props exist and the component is in the viewport.
+   * @default KupLazyRender.BOTH
+   */
+  renderMode: KupLazyRender;
+  /**
+   * Displays an animated SVG placeholder until the component is loaded.
+   * @default true
+   */
+  showPlaceholder: boolean;
+  /**
+   * Instance of the intersection observer.
+   */
+  private intObserver;
+  /**
+   * Instance of the KupManager class.
+   */
+  private kupManager;
+  private lazyComponent;
+  private lazyComponentLoaded;
+  /**
+   * Triggered when the component is loaded.
+   */
+  kupLazyLoaded: EventEmitter<KupEventPayload>;
+  /**
+   * 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>;
+  /**
+   * Returns the HTMLElement of the component to lazy load.
+   * @returns {HTMLElement} Lazy loaded component.
+   */
+  getComponent(): Promise<HTMLElement>;
+  /**
+   * This method is used to trigger a new render of the component.
+   */
+  refresh(): 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>;
+  setObserver(): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  componentDidRender(): void;
+  render(): any;
+  disconnectedCallback(): void;
+}

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

@@ -1,48 +1,48 @@
-import { KupEventPayload } from '../../types/GenericTypes';
-import { ValueDisplayedValue as vdv } from '../../utils/filters/filters-declarations';
-import { KupDataNode } from '../../managers/kup-data/kup-data-declarations';
-/**
- * Props of the kup-list component.
- * Used to export every prop in an object.
- */
-export declare enum KupListProps {
-  customStyle = "Custom style of the component.",
-  data = "The data of the list.",
-  displayMode = "Selects how the items must display their label and how they can be filtered for.",
-  filter = "Keeps string for filtering elements when filter mode is active",
-  hideText = "Hides rows' text, ideally to display a list of icons only.",
-  isMenu = "Defines whether the list is a menu or not.",
-  keyboardNavigation = "When true, enables items' navigation through arrow keys.",
-  menuVisible = "Sets the status of the menu, when false it's hidden otherwise it's visible.",
-  roleType = "Defines the type of selection. Values accepted: listbox, radiogroup or group.",
-  selectable = "Defines whether items are selectable or not.",
-  showIcons = "Displays the icons associated to each row when set to true.",
-  twoLine = "The list elements descriptions will be arranged in two lines."
-}
-/**
- * Data structure of a single list item.
- */
-export interface KupListNode extends KupDataNode {
-  secondaryText?: string;
-  selected?: boolean;
-  separator?: boolean;
-}
-/**
- * Available types of selection.
- */
-export declare enum KupListRole {
-  LISTBOX = "listbox",
-  RADIOGROUP = "radiogroup",
-  GROUP = "group"
-}
-export interface ValueDisplayedValue extends vdv {
-  exists: boolean;
-}
-export declare enum ItemsDisplayMode {
-  CODE = "code",
-  DESCRIPTION = "description",
-  DESCRIPTION_AND_CODE = "both"
-}
-export interface KupListEventPayload extends KupEventPayload {
-  selected: KupListNode;
-}
+import { KupEventPayload } from '../../types/GenericTypes';
+import { ValueDisplayedValue as vdv } from '../../utils/filters/filters-declarations';
+import { KupDataNode } from '../../managers/kup-data/kup-data-declarations';
+/**
+ * Props of the kup-list component.
+ * Used to export every prop in an object.
+ */
+export declare enum KupListProps {
+  customStyle = "Custom style of the component.",
+  data = "The data of the list.",
+  displayMode = "Selects how the items must display their label and how they can be filtered for.",
+  filter = "Keeps string for filtering elements when filter mode is active",
+  hideText = "Hides rows' text, ideally to display a list of icons only.",
+  isMenu = "Defines whether the list is a menu or not.",
+  keyboardNavigation = "When true, enables items' navigation through arrow keys.",
+  menuVisible = "Sets the status of the menu, when false it's hidden otherwise it's visible.",
+  roleType = "Defines the type of selection. Values accepted: listbox, radiogroup or group.",
+  selectable = "Defines whether items are selectable or not.",
+  showIcons = "Displays the icons associated to each row when set to true.",
+  twoLine = "The list elements descriptions will be arranged in two lines."
+}
+/**
+ * Data structure of a single list item.
+ */
+export interface KupListNode extends KupDataNode {
+  secondaryText?: string;
+  selected?: boolean;
+  separator?: boolean;
+}
+/**
+ * Available types of selection.
+ */
+export declare enum KupListRole {
+  LISTBOX = "listbox",
+  RADIOGROUP = "radiogroup",
+  GROUP = "group"
+}
+export interface ValueDisplayedValue extends vdv {
+  exists: boolean;
+}
+export declare enum ItemsDisplayMode {
+  CODE = "code",
+  DESCRIPTION = "description",
+  DESCRIPTION_AND_CODE = "both"
+}
+export interface KupListEventPayload extends KupEventPayload {
+  selected: KupListNode;
+}

package/dist/types/components/kup-list/kup-list-helper.d.ts

@@ -1,6 +1,6 @@
-import { ItemsDisplayMode, KupListNode, ValueDisplayedValue } from './kup-list-declarations';
-export declare function getIdOfItemByDisplayMode(item: KupListNode, mode: ItemsDisplayMode, separator: string): string;
-export declare function consistencyCheck(idIn: string, listData: Object, listEl: any, selectMode: ItemsDisplayMode, displayMode: ItemsDisplayMode, e?: CustomEvent): ValueDisplayedValue;
-export declare function getFirstItemSelected(listData: Object): KupListNode;
-export declare function getItemById(listData: Object, id: string, setSelected: boolean): KupListNode;
-export declare function getItemByDisplayMode(listData: Object, id: string, displayMode: ItemsDisplayMode, setSelected: boolean): KupListNode;
+import { ItemsDisplayMode, KupListNode, ValueDisplayedValue } from './kup-list-declarations';
+export declare function getIdOfItemByDisplayMode(item: KupListNode, mode: ItemsDisplayMode, separator: string): string;
+export declare function consistencyCheck(idIn: string, listData: Object, listEl: any, selectMode: ItemsDisplayMode, displayMode: ItemsDisplayMode, e?: CustomEvent): ValueDisplayedValue;
+export declare function getFirstItemSelected(listData: Object): KupListNode;
+export declare function getItemById(listData: Object, id: string, setSelected: boolean): KupListNode;
+export declare function getItemByDisplayMode(listData: Object, id: string, displayMode: ItemsDisplayMode, setSelected: boolean): KupListNode;

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

@@ -1,128 +1,128 @@
-import { EventEmitter } from '../../stencil-public-runtime';
-import { KupListNode, KupListEventPayload, KupListRole } from './kup-list-declarations';
-import { ItemsDisplayMode } from './kup-list-declarations';
-import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
-export declare class KupList {
-  #private;
-  /**
-   * References the root HTML element of the component (<kup-list>).
-   */
-  rootElement: HTMLElement;
-  /**
-   * The focused list item.
-   * @default null
-   */
-  focused: number;
-  /**
-   * The selected list items.
-   * @default []
-   */
-  selected: string[];
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * The data of the list.
-   * @default []
-   */
-  data: KupListNode[];
-  /**
-   * Selects how the items must display their label and how they can be filtered for.
-   * @default ItemsDisplayMode.DESCRIPTION
-   */
-  displayMode: ItemsDisplayMode;
-  /**
-   * Keeps string for filtering elements when filter mode is active
-   * @default ''
-   */
-  filter: string;
-  /**
-   * Hides rows' text, ideally to display a list of icons only.
-   * @default false
-   */
-  hideText: boolean;
-  /**
-   * Defines whether the list is a menu or not.
-   * @default false
-   */
-  isMenu: boolean;
-  /**
-   * When true, enables items' navigation through arrow keys.
-   * @default true
-   */
-  keyboardNavigation: boolean;
-  /**
-   * Sets the status of the menu, when false it's hidden otherwise it's visible.
-   * @default false
-   */
-  menuVisible: boolean;
-  /**
-   * Defines the type of selection. Values accepted: listbox, radiogroup or group.
-   * @default KupListRole.LISTBOX
-   */
-  roleType?: KupListRole;
-  /**
-   * Defines whether items are selectable or not.
-   * @default true
-   */
-  selectable: boolean;
-  /**
-   * Displays the icons associated to each row when set to true.
-   * @default false
-   */
-  showIcons: boolean;
-  /**
-   * The list elements descriptions will be arranged in two lines.
-   * @default false
-   */
-  twoLine: boolean;
-  kupBlur: EventEmitter<KupEventPayload>;
-  kupFocus: EventEmitter<KupEventPayload>;
-  kupClick: EventEmitter<KupListEventPayload>;
-  onKupBlur(): void;
-  onKupFocus(): void;
-  onKupClick(index: number): void;
-  listenKeydown(e: KeyboardEvent): void;
-  /**
-   * Focuses the next element of the list.
-   */
-  focusNext(): Promise<void>;
-  /**
-   * Focuses the previous element of the list.
-   */
-  focusPrevious(): Promise<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>;
-  /**
-   * Returns the selected node.
-   * @returns {Promise<KupListNode>} Selected node.
-   */
-  getSelectedNode(): Promise<KupListNode[]>;
-  /**
-   * This method is used to trigger a new render of the component.
-   */
-  refresh(): Promise<void>;
-  /**
-   * Calls handleSelection internal method to select the given item.
-   * @param {number} index - Based zero index of the item that must be selected, when not provided the list will attempt to select the focused element.
-   */
-  select(index?: number): 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>;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  render(): any;
-  disconnectedCallback(): void;
-}
+import { EventEmitter } from '../../stencil-public-runtime';
+import { KupListNode, KupListEventPayload, KupListRole } from './kup-list-declarations';
+import { ItemsDisplayMode } from './kup-list-declarations';
+import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
+export declare class KupList {
+  #private;
+  /**
+   * References the root HTML element of the component (<kup-list>).
+   */
+  rootElement: HTMLElement;
+  /**
+   * The focused list item.
+   * @default null
+   */
+  focused: number;
+  /**
+   * The selected list items.
+   * @default []
+   */
+  selected: string[];
+  /**
+   * Custom style of the component.
+   * @default ""
+   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+   */
+  customStyle: string;
+  /**
+   * The data of the list.
+   * @default []
+   */
+  data: KupListNode[];
+  /**
+   * Selects how the items must display their label and how they can be filtered for.
+   * @default ItemsDisplayMode.DESCRIPTION
+   */
+  displayMode: ItemsDisplayMode;
+  /**
+   * Keeps string for filtering elements when filter mode is active
+   * @default ''
+   */
+  filter: string;
+  /**
+   * Hides rows' text, ideally to display a list of icons only.
+   * @default false
+   */
+  hideText: boolean;
+  /**
+   * Defines whether the list is a menu or not.
+   * @default false
+   */
+  isMenu: boolean;
+  /**
+   * When true, enables items' navigation through arrow keys.
+   * @default true
+   */
+  keyboardNavigation: boolean;
+  /**
+   * Sets the status of the menu, when false it's hidden otherwise it's visible.
+   * @default false
+   */
+  menuVisible: boolean;
+  /**
+   * Defines the type of selection. Values accepted: listbox, radiogroup or group.
+   * @default KupListRole.LISTBOX
+   */
+  roleType?: KupListRole;
+  /**
+   * Defines whether items are selectable or not.
+   * @default true
+   */
+  selectable: boolean;
+  /**
+   * Displays the icons associated to each row when set to true.
+   * @default false
+   */
+  showIcons: boolean;
+  /**
+   * The list elements descriptions will be arranged in two lines.
+   * @default false
+   */
+  twoLine: boolean;
+  kupBlur: EventEmitter<KupEventPayload>;
+  kupFocus: EventEmitter<KupEventPayload>;
+  kupClick: EventEmitter<KupListEventPayload>;
+  onKupBlur(): void;
+  onKupFocus(): void;
+  onKupClick(index: number): void;
+  listenKeydown(e: KeyboardEvent): void;
+  /**
+   * Focuses the next element of the list.
+   */
+  focusNext(): Promise<void>;
+  /**
+   * Focuses the previous element of the list.
+   */
+  focusPrevious(): Promise<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>;
+  /**
+   * Returns the selected node.
+   * @returns {Promise<KupListNode>} Selected node.
+   */
+  getSelectedNode(): Promise<KupListNode[]>;
+  /**
+   * This method is used to trigger a new render of the component.
+   */
+  refresh(): Promise<void>;
+  /**
+   * Calls handleSelection internal method to select the given item.
+   * @param {number} index - Based zero index of the item that must be selected, when not provided the list will attempt to select the focused element.
+   */
+  select(index?: number): 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>;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  componentDidRender(): void;
+  render(): any;
+  disconnectedCallback(): void;
+}

package/dist/types/components/kup-magic-box/kup-magic-box-declarations.d.ts

@@ -1,21 +1,21 @@
-/**
- * Props of the kup-magic-box component.
- * Used to export every prop in an object.
- */
-export declare enum KupMagicBoxProps {
-  customStyle = "Custom style of the component.",
-  data = "Sets the data that will be used to display different components."
-}
-/**
- * Viable display modes selectable in kup-magic-box.
- */
-export declare enum KupMagicBoxDisplay {
-  BOX = "Box",
-  BUTTON_LIST = "Button List",
-  CHART = "Chart",
-  CHIP = "Chip",
-  ECHART = "Echart",
-  DATATABLE = "Datatable",
-  JSON = "JSON",
-  TREE = "Tree"
-}
+/**
+ * Props of the kup-magic-box component.
+ * Used to export every prop in an object.
+ */
+export declare enum KupMagicBoxProps {
+  customStyle = "Custom style of the component.",
+  data = "Sets the data that will be used to display different components."
+}
+/**
+ * Viable display modes selectable in kup-magic-box.
+ */
+export declare enum KupMagicBoxDisplay {
+  BOX = "Box",
+  BUTTON_LIST = "Button List",
+  CHART = "Chart",
+  CHIP = "Chip",
+  ECHART = "Echart",
+  DATATABLE = "Datatable",
+  JSON = "JSON",
+  TREE = "Tree"
+}