@sme.up/ketchup 9.2.0 → 9.3.0

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

@@ -1,147 +1,147 @@
 import { GenericObject } from '../../types/GenericTypes';
 export declare class KupGauge {
-  /**
-   * References the root HTML element of the component (<kup-gauge>).
-   */
-  rootElement: HTMLElement;
-  /**
-   * Sets how much the arc of the gauge should be thick.
-   * @namespace kup-gauge.arcThickness
-   * @see kup-gauge.size
-   */
-  arcThickness: number;
-  /**
-   * Array of three elements to specify the color of the arcs.
-   */
-  colors: string[];
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * The first threshold, establishing the length of the first and second arc.
-   */
-  firstThreshold?: number;
-  /**
-   * The distance the label and the value has from the gauge graph.
-   */
-  labelDistance: number;
-  /**
-   * The maximum value reachable in the current graph.
-   */
-  maxValue: number;
-  /**
-   * A string which will be appended to the displayed values of the component.
-   */
-  measurementUnit: string;
-  /**
-   * The minimum value reachable in the current graph.
-   */
-  minValue: number;
-  /**
-   * When true, shows a rounded needle.
-   */
-  needleCircle: boolean;
-  /**
-   * When true, ignore thresholds in gauge and show colored value's arc.
-   */
-  onlyValue: boolean;
-  /**
-   * When true, the colors inside the colors array are used in the reversed order.
-   */
-  reverseColors: boolean;
-  /**
-   * The second threshold, establishing the length of the second and third arc.
-   */
-  secondThreshold?: number;
-  /**
-   * If set to false, threshold values of the gauge are not displayed.
-   */
-  showLabels: boolean;
-  /**
-   * If set to false, the maximum and minimum values of the gauge are not displayed.
-   */
-  showMaxmin: boolean;
-  /**
-   * If set to false, the current value of the gauge is not displayed.
-   */
-  showValue: boolean;
-  /**
-   * Con be used change the viewbox of the SVG.
-   * By manipulating this value, some customizations of the aspect of the gauge is achievable.
-   * @namespace kup-gauge.size
-   * @see kup-gauge.arcThickness
-   */
-  size: number;
-  /**
-   * The current value of the gauge.
-   * The gauge's needle points to the percentage based on this prop.
-   */
-  value: number;
-  /**
-   * The current size of gauge's value.
-   * Correct values are: 0,1,2 or 3.
-   */
-  valueSize: number;
-  /**
-   * Set Width gauge.
-   */
-  widthComponent: string;
-  /**
-   * Instance of the KupManager class.
-   */
-  private kupManager;
-  private arcGenerator;
-  /**
-   * Holds the maximum positive interval.
-   * Percentages are calculated as it follows:
-   * MIN = 0 = the value the prop minValue gets transformed to\
-   * MAX = ABSOLUTE(minValue - maxValue) = the maxValuePositive holds this value
-   * TVALUE = value - minValue = any value, which needs to be represented on the chart
-   * @namespace kup-gauge.maxValuePositive
-   */
-  private maxValuePositive;
-  /**
-   * 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>;
-  percToDeg(perc: any): number;
-  degToRad(deg: any): number;
-  percToRad(perc: any): number;
-  /**
-   * Given a valid value, minValue <= value <= maxValue, calculates this value as a percentage of the interval [minValue, maxValue]
-   * @param {number} valueToPercentage - The value to be calculated as a percentage
-   * @see kup-gauge.maxValuePositive
-   */
-  calculateValuePercentage(valueToPercentage?: number): number;
-  calculateValueFontSize(): string;
-  /**
-   * Provided all the necessary data, returns the string necessary for a <path/> element to build the gauge needle.
-   * @param needleLength - A pure number of viewbox units indicating the needle lenght.
-   * @param needleBaseRadius - Sets the needle radius in viewbox units.
-   * @param centerX - X coordinate of the center of the base needle.
-   * @param centerY - Y coordinate of the center of the base needle.
-   * @param rotationPercentage {number} - A percentage number setting the current rotation of the needle. (0 < rotationPercentage < 1)
-   * @returns {string}
-   */
-  paintNeedle(needleLength: number, needleBaseRadius: number, centerX: number, centerY: number, rotationPercentage?: number): string;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  render(): any;
-  disconnectedCallback(): void;
+    /**
+     * References the root HTML element of the component (<kup-gauge>).
+     */
+    rootElement: HTMLElement;
+    /**
+     * Sets how much the arc of the gauge should be thick.
+     * @namespace kup-gauge.arcThickness
+     * @see kup-gauge.size
+     */
+    arcThickness: number;
+    /**
+     * Array of three elements to specify the color of the arcs.
+     */
+    colors: string[];
+    /**
+     * Custom style of the component.
+     * @default ""
+     * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+     */
+    customStyle: string;
+    /**
+     * The first threshold, establishing the length of the first and second arc.
+     */
+    firstThreshold?: number;
+    /**
+     * The distance the label and the value has from the gauge graph.
+     */
+    labelDistance: number;
+    /**
+     * The maximum value reachable in the current graph.
+     */
+    maxValue: number;
+    /**
+     * A string which will be appended to the displayed values of the component.
+     */
+    measurementUnit: string;
+    /**
+     * The minimum value reachable in the current graph.
+     */
+    minValue: number;
+    /**
+     * When true, shows a rounded needle.
+     */
+    needleCircle: boolean;
+    /**
+     * When true, ignore thresholds in gauge and show colored value's arc.
+     */
+    onlyValue: boolean;
+    /**
+     * When true, the colors inside the colors array are used in the reversed order.
+     */
+    reverseColors: boolean;
+    /**
+     * The second threshold, establishing the length of the second and third arc.
+     */
+    secondThreshold?: number;
+    /**
+     * If set to false, threshold values of the gauge are not displayed.
+     */
+    showLabels: boolean;
+    /**
+     * If set to false, the maximum and minimum values of the gauge are not displayed.
+     */
+    showMaxmin: boolean;
+    /**
+     * If set to false, the current value of the gauge is not displayed.
+     */
+    showValue: boolean;
+    /**
+     * Con be used change the viewbox of the SVG.
+     * By manipulating this value, some customizations of the aspect of the gauge is achievable.
+     * @namespace kup-gauge.size
+     * @see kup-gauge.arcThickness
+     */
+    size: number;
+    /**
+     * The current value of the gauge.
+     * The gauge's needle points to the percentage based on this prop.
+     */
+    value: number;
+    /**
+     * The current size of gauge's value.
+     * Correct values are: 0,1,2 or 3.
+     */
+    valueSize: number;
+    /**
+     * Set Width gauge.
+     */
+    widthComponent: string;
+    /**
+     * Instance of the KupManager class.
+     */
+    private kupManager;
+    private arcGenerator;
+    /**
+     * Holds the maximum positive interval.
+     * Percentages are calculated as it follows:
+     * MIN = 0 = the value the prop minValue gets transformed to\
+     * MAX = ABSOLUTE(minValue - maxValue) = the maxValuePositive holds this value
+     * TVALUE = value - minValue = any value, which needs to be represented on the chart
+     * @namespace kup-gauge.maxValuePositive
+     */
+    private maxValuePositive;
+    /**
+     * 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>;
+    percToDeg(perc: any): number;
+    degToRad(deg: any): number;
+    percToRad(perc: any): number;
+    /**
+     * Given a valid value, minValue <= value <= maxValue, calculates this value as a percentage of the interval [minValue, maxValue]
+     * @param {number} valueToPercentage - The value to be calculated as a percentage
+     * @see kup-gauge.maxValuePositive
+     */
+    calculateValuePercentage(valueToPercentage?: number): number;
+    calculateValueFontSize(): string;
+    /**
+     * Provided all the necessary data, returns the string necessary for a <path/> element to build the gauge needle.
+     * @param needleLength - A pure number of viewbox units indicating the needle lenght.
+     * @param needleBaseRadius - Sets the needle radius in viewbox units.
+     * @param centerX - X coordinate of the center of the base needle.
+     * @param centerY - Y coordinate of the center of the base needle.
+     * @param rotationPercentage {number} - A percentage number setting the current rotation of the needle. (0 < rotationPercentage < 1)
+     * @returns {string}
+     */
+    paintNeedle(needleLength: number, needleBaseRadius: number, centerX: number, centerY: number, rotationPercentage?: number): string;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentWillRender(): void;
+    componentDidRender(): void;
+    render(): any;
+    disconnectedCallback(): void;
 }

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

@@ -3,7 +3,7 @@
  * Used to export every prop in an object.
  */
 export declare enum KupGridProps {
-  columns = "The number of columns displayed by the grid, the default behavior is 12.",
-  customStyle = "Custom style of the component. For more information: https://ketchup.smeup.com/ketchup-showcase/#/customization",
-  singleLine = "When set to true, forces the content on a single line."
+    columns = "The number of columns displayed by the grid, the default behavior is 12.",
+    customStyle = "Custom style of the component. For more information: https://ketchup.smeup.com/ketchup-showcase/#/customization",
+    singleLine = "When set to true, forces the content on a single line."
 }

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

@@ -1,48 +1,48 @@
 import type { GenericObject } from '../../types/GenericTypes';
 export declare class KupGrid {
-  /**
-   * References the root HTML element of the component (<kup-grid>).
-   */
-  rootElement: HTMLElement;
-  /**
-   * The number of columns displayed by the grid, the default behavior is 12.
-   * @default 12
-   */
-  columns: number;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * When set to true, forces the content on a single line.
-   * @default false
-   */
-  singleLine: boolean;
-  /**
-   * Instance of the KupManager class.
-   */
-  private kupManager;
-  /**
-   * 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;
+    /**
+     * References the root HTML element of the component (<kup-grid>).
+     */
+    rootElement: HTMLElement;
+    /**
+     * The number of columns displayed by the grid, the default behavior is 12.
+     * @default 12
+     */
+    columns: number;
+    /**
+     * Custom style of the component.
+     * @default ""
+     * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+     */
+    customStyle: string;
+    /**
+     * When set to true, forces the content on a single line.
+     * @default false
+     */
+    singleLine: boolean;
+    /**
+     * Instance of the KupManager class.
+     */
+    private kupManager;
+    /**
+     * 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-iframe/kup-iframe-declarations.d.ts

@@ -3,7 +3,7 @@
  * Used to export every prop in an object.
  */
 export declare enum KupIframeProps {
-  buttonData = "Props of the button (when isButton is set to true).",
-  isButton = "The component will be rendered as a button, which opens the link associated to the iframe in another tab when clicked.",
-  src = "The address the iframe should be referencing to."
+    buttonData = "Props of the button (when isButton is set to true).",
+    isButton = "The component will be rendered as a button, which opens the link associated to the iframe in another tab when clicked.",
+    src = "The address the iframe should be referencing to."
 }

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

@@ -1,49 +1,49 @@
 import { EventEmitter } from '../../stencil-public-runtime';
 import type { GenericObject, KupEventPayload } from '../../types/GenericTypes';
 export declare class KupIframe {
-  /**
-   * References the root HTML element of the component (<kup-iframe>).
-   */
-  rootElement: HTMLElement;
-  /**
-   *  Props of the button (when isButton is set to true).
-   */
-  buttonData: Object;
-  /**
-   * The component will be rendered as a button, which opens the link associated to the iframe in another tab when clicked.
-   */
-  isButton: boolean;
-  /**
-   * The address the iframe should be referencing to.
-   */
-  src: string;
-  /**
-   * Instance of the KupManager class.
-   */
-  private kupManager;
-  kupIframeError: EventEmitter<KupEventPayload>;
-  onKupIframeError(): void;
-  kupIframeLoad: EventEmitter<KupEventPayload>;
-  onKupIframeLoad(): 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>;
-  openInNew(): void;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  render(): any;
+    /**
+     * References the root HTML element of the component (<kup-iframe>).
+     */
+    rootElement: HTMLElement;
+    /**
+     *  Props of the button (when isButton is set to true).
+     */
+    buttonData: Object;
+    /**
+     * The component will be rendered as a button, which opens the link associated to the iframe in another tab when clicked.
+     */
+    isButton: boolean;
+    /**
+     * The address the iframe should be referencing to.
+     */
+    src: string;
+    /**
+     * Instance of the KupManager class.
+     */
+    private kupManager;
+    kupIframeError: EventEmitter<KupEventPayload>;
+    onKupIframeError(): void;
+    kupIframeLoad: EventEmitter<KupEventPayload>;
+    onKupIframeLoad(): 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>;
+    openInNew(): void;
+    componentWillLoad(): void;
+    componentDidLoad(): void;
+    componentWillRender(): void;
+    componentDidRender(): void;
+    render(): any;
 }

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

@@ -1,23 +1,23 @@
 export declare class GraphicElement {
-  width: number;
-  height: number;
-  color: Color;
-  shape: string;
-  init(markers: string[]): void;
-  initColor(rgb: string): void;
-  isTrasparent(): boolean;
-  initHeight(height: string): void;
-  initShape(shape: string): void;
-  isValidColor(color: string): boolean;
-  getHeight(): number;
-  getWidth(): number;
-  getShape(): string;
-  getColor(): Color;
+    width: number;
+    height: number;
+    color: Color;
+    shape: string;
+    init(markers: string[]): void;
+    initColor(rgb: string): void;
+    isTrasparent(): boolean;
+    initHeight(height: string): void;
+    initShape(shape: string): void;
+    isValidColor(color: string): boolean;
+    getHeight(): number;
+    getWidth(): number;
+    getShape(): string;
+    getColor(): Color;
 }
 export declare class Color {
-  private r;
-  private g;
-  private b;
-  constructor(r: number, g: number, b: number);
-  toString(): string;
+    private r;
+    private g;
+    private b;
+    constructor(r: number, g: number, b: number);
+    toString(): string;
 }

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

@@ -1,28 +1,28 @@
 import { GraphicElement, Color } from './kup-image-canvas-declarations';
 export declare class imageCanvas {
-  graphic_element_marker_splitter: string;
-  graphic_element_splitter: string;
-  background_color: string;
-  default_color: Color;
-  value: string;
-  canvas: HTMLCanvasElement;
-  ctx: CanvasRenderingContext2D;
-  drawCanvas(value: string, canvas: HTMLCanvasElement): Promise<string>;
-  draw(): void;
-  drawGraphicCell(): void;
-  isShapeMarker(value: string): boolean;
-  isBgColorMarker(value: string): boolean;
-  isHeightMarker(value: string): boolean;
-  isDecoratorMarker(value: string): boolean;
-  getDim(dimPixel: number, dimPerc: number): number;
-  getNewStarXFromBar(startX: number, elem: GraphicElement): number;
-  getNewStarXFromCircle(startX: number, circle: GraphicElement): number;
-  getNewStarXFromTril(startX: number, triLeft: GraphicElement): number;
-  getNewStarXFromTrir(startX: number, triRight: GraphicElement): number;
-  drawArc(x: number, radius: number, color: Color): void;
-  drawRect(x: number, y: number, width: number, height: number, color: Color): void;
-  drawTri(x1: number, y1: number, x2: number, y2: number, color: Color): void;
-  drawArrow(sep: string): void;
-  drawGrid(sep: string): void;
-  drawSeparator(sep: string): void;
+    graphic_element_marker_splitter: string;
+    graphic_element_splitter: string;
+    background_color: string;
+    default_color: Color;
+    value: string;
+    canvas: HTMLCanvasElement;
+    ctx: CanvasRenderingContext2D;
+    drawCanvas(value: string, canvas: HTMLCanvasElement): Promise<string>;
+    draw(): void;
+    drawGraphicCell(): void;
+    isShapeMarker(value: string): boolean;
+    isBgColorMarker(value: string): boolean;
+    isHeightMarker(value: string): boolean;
+    isDecoratorMarker(value: string): boolean;
+    getDim(dimPixel: number, dimPerc: number): number;
+    getNewStarXFromBar(startX: number, elem: GraphicElement): number;
+    getNewStarXFromCircle(startX: number, circle: GraphicElement): number;
+    getNewStarXFromTril(startX: number, triLeft: GraphicElement): number;
+    getNewStarXFromTrir(startX: number, triRight: GraphicElement): number;
+    drawArc(x: number, radius: number, color: Color): void;
+    drawRect(x: number, y: number, width: number, height: number, color: Color): void;
+    drawTri(x1: number, y1: number, x2: number, y2: number, color: Color): void;
+    drawArrow(sep: string): void;
+    drawGrid(sep: string): void;
+    drawSeparator(sep: string): void;
 }

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

@@ -4,16 +4,16 @@ import { KupEventPayload } from "../../types/GenericTypes";
  * Used to export every prop in an object.
  */
 export declare enum KupImageProps {
-  badgeData = "Sets the data of badges.",
-  color = "The color of the icon, defaults to the CSS variable --kup-icon-color.",
-  customStyle = "Custom style of the component.",
-  data = "When present, the component will be drawn using CSS. Check the 'Drawing with CSS' section of the image showcase for more information.",
-  feedback = "When set to true, a spinner will be displayed until the image finished loading. Not compatible with SVGs.",
-  isCanvas = "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.",
-  resource = "The resource used to fetch the image.",
-  sizeX = "The width of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.).",
-  sizeY = "The height of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.)."
+    badgeData = "Sets the data of badges.",
+    color = "The color of the icon, defaults to the CSS variable --kup-icon-color.",
+    customStyle = "Custom style of the component.",
+    data = "When present, the component will be drawn using CSS. Check the 'Drawing with CSS' section of the image showcase for more information.",
+    feedback = "When set to true, a spinner will be displayed until the image finished loading. Not compatible with SVGs.",
+    isCanvas = "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.",
+    resource = "The resource used to fetch the image.",
+    sizeX = "The width of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.).",
+    sizeY = "The height of the icon, defaults to 100%. Accepts any valid CSS format (px, %, vh, etc.)."
 }
 export interface KupImageClickEventPayload extends KupEventPayload {
-  el: EventTarget;
+    el: EventTarget;
 }