@sme.up/ketchup 8.0.2 → 8.1.0

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

@@ -1,83 +1,83 @@
-import { EventEmitter } from '../../stencil-public-runtime';
-import { KupFormLayout, KupFormData, KupFormLabelPlacement } from './kup-form-declarations';
-import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
-export declare class KupForm {
-  /**
-   * References the root HTML element of the component (<kup-form>).
-   */
-  rootElement: HTMLElement;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * Actual data of the form.
-   * @default null
-   */
-  data: KupFormData;
-  /**
-   * Creates a hidden submit button in order to submit the form with enter.
-   * @default false
-   */
-  hiddenSubmitButton: boolean;
-  /**
-   * Sets the label placement for 'all' fields in form
-   * @default KupFormLabelPlacement.LEFT
-   */
-  labelPlacement: KupFormLabelPlacement;
-  /**
-   * How the form will arrange its content.
-   * @default null
-   */
-  layout: KupFormLayout;
-  /**
-   * Sets the callback function on submit form
-   * @default null
-   */
-  submitCb: (e: SubmitEvent) => unknown;
-  private kupManager;
-  private formLayout;
-  private visibleColumns;
-  onDataChanged(): void;
-  onLayoutChanged(): 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 focus on an editable table cell.
-   * @param {string} column - Name of the column.
-   * @param {string} rowId - Id of the row.
-   */
-  setFocus(column: string, rowId: string): 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>;
-  /**
-   * When component load is complete
-   */
-  kupReady: EventEmitter<KupEventPayload>;
-  private getColumns;
-  private initVisibleColumns;
-  private getRows;
-  private checkLayout;
-  private renderRow;
-  private renderSection;
-  private renderFormField;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  render(): any;
-  disconnectedCallback(): void;
-}
+import { EventEmitter } from '../../stencil-public-runtime';
+import { KupFormLayout, KupFormData, KupFormLabelPlacement } from './kup-form-declarations';
+import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
+export declare class KupForm {
+  /**
+   * References the root HTML element of the component (<kup-form>).
+   */
+  rootElement: HTMLElement;
+  /**
+   * Custom style of the component.
+   * @default ""
+   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+   */
+  customStyle: string;
+  /**
+   * Actual data of the form.
+   * @default null
+   */
+  data: KupFormData;
+  /**
+   * Creates a hidden submit button in order to submit the form with enter.
+   * @default false
+   */
+  hiddenSubmitButton: boolean;
+  /**
+   * Sets the label placement for 'all' fields in form
+   * @default KupFormLabelPlacement.LEFT
+   */
+  labelPlacement: KupFormLabelPlacement;
+  /**
+   * How the form will arrange its content.
+   * @default null
+   */
+  layout: KupFormLayout;
+  /**
+   * Sets the callback function on submit form
+   * @default null
+   */
+  submitCb: (e: SubmitEvent) => unknown;
+  private kupManager;
+  private formLayout;
+  private visibleColumns;
+  onDataChanged(): void;
+  onLayoutChanged(): 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 focus on an editable table cell.
+   * @param {string} column - Name of the column.
+   * @param {string} rowId - Id of the row.
+   */
+  setFocus(column: string, rowId: string): 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>;
+  /**
+   * When component load is complete
+   */
+  kupReady: EventEmitter<KupEventPayload>;
+  private getColumns;
+  private initVisibleColumns;
+  private getRows;
+  private checkLayout;
+  private renderRow;
+  private renderSection;
+  private renderFormField;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  componentDidRender(): void;
+  render(): any;
+  disconnectedCallback(): void;
+}

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

@@ -1,25 +1,25 @@
-/**
- * Props of the kup-gauge component.
- * Used to export every prop in an object.
- */
-export declare enum KupGaugeProps {
-  arcThickness = "Sets how much the arc of the gauge should be thick.",
-  colors = "Array of three elements to specify the color of the arcs.",
-  customStyle = "Custom style of the component. For more information: https://ketchup.smeup.com/ketchup-showcase/#/customization",
-  firstThreshold = "The first threshold, establishing the length of the first and second arc.",
-  labelDistance = "The distance the label and the value has from the gauge graph.",
-  maxValue = "The maximum value reachable in the current graph.",
-  measurementUnit = "A string which will be appended to the displayed values of the component.",
-  minValue = "The minimum value reachable in the current graph.",
-  needleCircle = "When true, shows a rounded needle.",
-  onlyValue = "When true, ignore thresholds in gauge and show colored value's arc.",
-  reverseColors = "When true, the colors inside the colors array are used in the reversed order.",
-  secondThreshold = "The second threshold, establishing the length of the second and third arc.",
-  showLabels = "If set to false, threshold values of the gauge are not displayed.",
-  showMaxmin = "If set to false, the maximum and minimum values of the gauge are not displayed.",
-  showValue = "If set to false, the current value of the gauge is not displayed.",
-  size = "Con be used change the viewbox of the SVG. By manipulating this value, some customizations of the aspect of the gauge is achievable.",
-  value = "The current value of the gauge. The gauge's needle points to the percentage based on this prop.",
-  valueSize = "The current size of gauge's value. Correct values are: 0,1,2 or 3.",
-  widthComponent = "Set Width gauge."
-}
+/**
+ * Props of the kup-gauge component.
+ * Used to export every prop in an object.
+ */
+export declare enum KupGaugeProps {
+  arcThickness = "Sets how much the arc of the gauge should be thick.",
+  colors = "Array of three elements to specify the color of the arcs.",
+  customStyle = "Custom style of the component. For more information: https://ketchup.smeup.com/ketchup-showcase/#/customization",
+  firstThreshold = "The first threshold, establishing the length of the first and second arc.",
+  labelDistance = "The distance the label and the value has from the gauge graph.",
+  maxValue = "The maximum value reachable in the current graph.",
+  measurementUnit = "A string which will be appended to the displayed values of the component.",
+  minValue = "The minimum value reachable in the current graph.",
+  needleCircle = "When true, shows a rounded needle.",
+  onlyValue = "When true, ignore thresholds in gauge and show colored value's arc.",
+  reverseColors = "When true, the colors inside the colors array are used in the reversed order.",
+  secondThreshold = "The second threshold, establishing the length of the second and third arc.",
+  showLabels = "If set to false, threshold values of the gauge are not displayed.",
+  showMaxmin = "If set to false, the maximum and minimum values of the gauge are not displayed.",
+  showValue = "If set to false, the current value of the gauge is not displayed.",
+  size = "Con be used change the viewbox of the SVG. By manipulating this value, some customizations of the aspect of the gauge is achievable.",
+  value = "The current value of the gauge. The gauge's needle points to the percentage based on this prop.",
+  valueSize = "The current size of gauge's value. Correct values are: 0,1,2 or 3.",
+  widthComponent = "Set Width gauge."
+}

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;
-}
+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;
+}

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

@@ -1,9 +1,9 @@
-/**
- * Props of the kup-grid component.
- * 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."
-}
+/**
+ * Props of the kup-grid component.
+ * 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."
+}

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;
-}
+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;
+}

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

@@ -1,9 +1,9 @@
-/**
- * Props of the kup-iframe component.
- * 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."
-}
+/**
+ * Props of the kup-iframe component.
+ * 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."
+}