@sme.up/ketchup 9.2.0 → 9.3.0

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

@@ -4,100 +4,100 @@ import { KupBadge } from '../kup-badge/kup-badge';
 import { FImageData } from '../../f-components/f-image/f-image-declarations';
 import { KupImageClickEventPayload } from './kup-image-declarations';
 export declare class KupImage {
-  /**
-   * References the root HTML element of the component (<kup-image>).
-   */
-  rootElement: HTMLElement;
-  /**
-   * Sets the data of badges.
-   * @default null
-   */
-  badgeData: KupBadge[];
-  /**
-   * The color of the icon, defaults to the CSS variable KupThemeColorValues.ICON.
-   * @default KupThemeColorValues.ICON
-   */
-  color: string;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * When present, the component will be drawn using CSS. Check the 'Drawing with CSS' section of the image showcase for more information.
-   * @default null
-   */
-  data: FImageData[];
-  /**
-   * When set to true, a spinner will be displayed until the image finished loading. Not compatible with SVGs.
-   * @default false
-   */
-  feedback: boolean;
-  /**
-   * 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
-   */
-  isCanvas: boolean;
-  /**
-   * The resource used to fetch the image.
-   * @default null
-   */
-  resource: string;
-  /**
-   * The width of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.).
-   * @default '100%'
-   */
-  sizeX: string;
-  /**
-   * The height of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.).
-   * @default '100%'
-   */
-  sizeY: string;
-  /**
-   * Reference to the canvas element.
-   */
-  private canvas;
-  /**
-   * Instance of the imageCanvas class.
-   */
-  private imageCanvas;
-  /**
-   * True when the resource is an URL.
-   */
-  private isUrl;
-  /**
-   * Instance of the KupManager class.
-   */
-  private kupManager;
-  kupClick: EventEmitter<KupImageClickEventPayload>;
-  onKupClick(e: Event): void;
-  kupLoad: EventEmitter<KupImageClickEventPayload>;
-  onKupLoad(e: Event): 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>;
-  /**
-   * Sets the props to the component.
-   * @param {GenericObject} props - Object containing props that will be set to the component.
-   */
-  setProps(props: GenericObject): Promise<void>;
-  /**
-   * Render the canvas variant of kup-image.
-   * @todo should be handled inside f-image.
-   */
-  private renderCanvas;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  render(): any;
-  disconnectedCallback(): void;
+    /**
+     * References the root HTML element of the component (<kup-image>).
+     */
+    rootElement: HTMLElement;
+    /**
+     * Sets the data of badges.
+     * @default null
+     */
+    badgeData: KupBadge[];
+    /**
+     * The color of the icon, defaults to the CSS variable KupThemeColorValues.ICON.
+     * @default KupThemeColorValues.ICON
+     */
+    color: string;
+    /**
+     * Custom style of the component.
+     * @default ""
+     * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+     */
+    customStyle: string;
+    /**
+     * When present, the component will be drawn using CSS. Check the 'Drawing with CSS' section of the image showcase for more information.
+     * @default null
+     */
+    data: FImageData[];
+    /**
+     * When set to true, a spinner will be displayed until the image finished loading. Not compatible with SVGs.
+     * @default false
+     */
+    feedback: boolean;
+    /**
+     * 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
+     */
+    isCanvas: boolean;
+    /**
+     * The resource used to fetch the image.
+     * @default null
+     */
+    resource: string;
+    /**
+     * The width of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.).
+     * @default '100%'
+     */
+    sizeX: string;
+    /**
+     * The height of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.).
+     * @default '100%'
+     */
+    sizeY: string;
+    /**
+     * Reference to the canvas element.
+     */
+    private canvas;
+    /**
+     * Instance of the imageCanvas class.
+     */
+    private imageCanvas;
+    /**
+     * True when the resource is an URL.
+     */
+    private isUrl;
+    /**
+     * Instance of the KupManager class.
+     */
+    private kupManager;
+    kupClick: EventEmitter<KupImageClickEventPayload>;
+    onKupClick(e: Event): void;
+    kupLoad: EventEmitter<KupImageClickEventPayload>;
+    onKupLoad(e: Event): 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>;
+    /**
+     * Sets the props to the component.
+     * @param {GenericObject} props - Object containing props that will be set to the component.
+     */
+    setProps(props: GenericObject): Promise<void>;
+    /**
+     * Render the canvas variant of kup-image.
+     * @todo should be handled inside f-image.
+     */
+    private renderCanvas;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentWillRender(): void;
+    componentDidRender(): void;
+    render(): any;
+    disconnectedCallback(): void;
 }

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

@@ -5,10 +5,10 @@ import { KupEventPayload } from '../../types/GenericTypes';
  * Used to export every prop in an object.
  */
 export declare enum KupImageListProps {
-  customStyle = "Custom style of the component.",
-  data = "Actual data of the component",
-  ripple = "When enabled displays Material's ripple effect on clicked items."
+    customStyle = "Custom style of the component.",
+    data = "Actual data of the component",
+    ripple = "When enabled displays Material's ripple effect on clicked items."
 }
 export interface KupImageListEventPayload extends KupEventPayload {
-  node: KupDataNode;
+    node: KupDataNode;
 }

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

@@ -1,6 +1,6 @@
 import { KupState } from '../kup-state/kup-state';
 export declare class KupImageListState implements KupState {
-  selectedTreeNodePath: string;
-  load: boolean;
-  toDebugString(): string;
+    selectedTreeNodePath: string;
+    load: boolean;
+    toDebugString(): string;
 }

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

@@ -6,68 +6,68 @@ import { KupStore } from '../kup-state/kup-store';
 import { KupImageListState } from './kup-image-list-state';
 import { TreeNodePath } from '../kup-tree/kup-tree-declarations';
 export declare class KupImageList {
-  #private;
-  /**
-   * References the root HTML element of the component (<kup-image-list>).
-   */
-  rootElement: HTMLElement;
-  state: KupImageListState;
-  currentNode: KupDataNode;
-  navigationBarToggled: boolean;
-  initWithPersistedState(): void;
-  persistState(): void;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * Actual data of the component.
-   * @default []
-   */
-  data: KupDataNode[];
-  /**
-   * When enabled displays Material's ripple effect on clicked items.
-   * @default true
-   */
-  ripple: boolean;
-  /**
-   * An array of integers containing the path to a selected child.\
-   */
-  selectedNode: TreeNodePath;
-  stateId: string;
-  store: KupStore;
-  /**
-   * Instance of the KupManager class.
-   */
-  private kupManager;
-  kupClick: EventEmitter<KupImageListEventPayload>;
-  onKupClick(node: KupDataNode): void;
-  kupContextMenu: EventEmitter<KupImageListEventPayload>;
-  onKupContextMenu(e: MouseEvent, node: KupDataNode): void;
-  kupDblClick: EventEmitter<KupImageListEventPayload>;
-  onKupDblClick(node: KupDataNode): void;
-  selectNode(newData: TreeNodePath): 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>;
-  /**
-   * 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;
+    #private;
+    /**
+     * References the root HTML element of the component (<kup-image-list>).
+     */
+    rootElement: HTMLElement;
+    state: KupImageListState;
+    currentNode: KupDataNode;
+    navigationBarToggled: boolean;
+    initWithPersistedState(): void;
+    persistState(): void;
+    /**
+     * Custom style of the component.
+     * @default ""
+     * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+     */
+    customStyle: string;
+    /**
+     * Actual data of the component.
+     * @default []
+     */
+    data: KupDataNode[];
+    /**
+     * When enabled displays Material's ripple effect on clicked items.
+     * @default true
+     */
+    ripple: boolean;
+    /**
+     * An array of integers containing the path to a selected child.\
+     */
+    selectedNode: TreeNodePath;
+    stateId: string;
+    store: KupStore;
+    /**
+     * Instance of the KupManager class.
+     */
+    private kupManager;
+    kupClick: EventEmitter<KupImageListEventPayload>;
+    onKupClick(node: KupDataNode): void;
+    kupContextMenu: EventEmitter<KupImageListEventPayload>;
+    onKupContextMenu(e: MouseEvent, node: KupDataNode): void;
+    kupDblClick: EventEmitter<KupImageListEventPayload>;
+    onKupDblClick(node: KupDataNode): void;
+    selectNode(newData: TreeNodePath): 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>;
+    /**
+     * 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-lazy/kup-lazy-declarations.d.ts

@@ -3,16 +3,16 @@
  * 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."
+    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"
+    VIEWPORT = "viewport",
+    PROPS = "props",
+    BOTH = "both"
 }

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

@@ -2,77 +2,77 @@ 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;
+    /**
+     * 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

@@ -6,43 +6,43 @@ import { KupDataNode } from '../../managers/kup-data/kup-data-declarations';
  * 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."
+    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;
+    secondaryText?: string;
+    selected?: boolean;
+    separator?: boolean;
 }
 /**
  * Available types of selection.
  */
 export declare enum KupListRole {
-  LISTBOX = "listbox",
-  RADIOGROUP = "radiogroup",
-  GROUP = "group"
+    LISTBOX = "listbox",
+    RADIOGROUP = "radiogroup",
+    GROUP = "group"
 }
 export interface ValueDisplayedValue extends vdv {
-  exists: boolean;
+    exists: boolean;
 }
 export declare enum ItemsDisplayMode {
-  CODE = "code",
-  DESCRIPTION = "description",
-  DESCRIPTION_AND_CODE = "both"
+    CODE = "code",
+    DESCRIPTION = "description",
+    DESCRIPTION_AND_CODE = "both"
 }
 export interface KupListEventPayload extends KupEventPayload {
-  selected: KupListNode;
+    selected: KupListNode;
 }