@sme.up/ketchup 8.0.2 → 8.1.0

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

@@ -1,119 +1,119 @@
-import { EventEmitter } from '../../stencil-public-runtime';
-import { GenericObject } from '../../types/GenericTypes';
-import { KupAutocompleteEventPayload, KupAutocompleteIconClickEventPayload } from './kup-autocomplete-declarations';
-import { ItemsDisplayMode, KupListEventPayload } from '../kup-list/kup-list-declarations';
-export declare class KupAutocomplete {
-  #private;
-  /**
-   * References the root HTML element of the component (<kup-autocomplete>).
-   */
-  rootElement: HTMLElement;
-  displayedValue: string;
-  value: string;
-  /**
-   * When true, the autocomplete fires the change event even when the value typed isn't included in the autocomplete list.
-   * @default false
-   */
-  allowInconsistentValues: boolean;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * Props of the sub-components.
-   * @default undefined
-   */
-  data: Object;
-  /**
-   * Defaults at false. When set to true, the component is disabled.
-   * @default false
-   */
-  disabled: boolean;
-  /**
-   * Sets how to show the selected item value. Suported values: "code", "description", "both".
-   * @default ItemsDisplayMode.DESCRIPTION
-   */
-  displayMode: ItemsDisplayMode;
-  /**
-   * Sets the initial value of the component.
-   * @default ""
-   */
-  initialValue: string;
-  /**
-   * Input event emission delay in milliseconds.
-   * @default 300
-   */
-  inputDelay: number;
-  /**
-   * The minimum number of chars to trigger the autocomplete
-   * @default 1
-   */
-  minimumChars: number;
-  /**
-   * Sets how to return the selected item value. Suported values: "code", "description", "both".
-   * @default ItemsDisplayMode.CODE
-   */
-  selectMode: ItemsDisplayMode;
-  /**
-   * When true, the items filter is managed server side, otherwise items filter is done client side.
-   * @default false
-   */
-  serverHandledFilter: boolean;
-  /**
-   * When true shows the drop-down icon, for open list.
-   * @default true
-   */
-  showDropDownIcon: boolean;
-  kupBlur: EventEmitter<KupAutocompleteEventPayload>;
-  kupChange: EventEmitter<KupAutocompleteEventPayload>;
-  kupClick: EventEmitter<KupAutocompleteEventPayload>;
-  kupFocus: EventEmitter<KupAutocompleteEventPayload>;
-  kupInput: EventEmitter<KupAutocompleteEventPayload>;
-  kupIconClick: EventEmitter<KupAutocompleteIconClickEventPayload>;
-  kupItemClick: EventEmitter<KupAutocompleteEventPayload>;
-  onKupBlur(): void;
-  onKupChange(value: string): void;
-  onKupClick(): void;
-  onKupFocus(): void;
-  onKupInput(): void;
-  onKupIconClick(): void;
-  onKupItemClick(e: CustomEvent<KupListEventPayload>): void;
-  listenKeydown(e: KeyboardEvent): 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>;
-  /**
-   * Used to retrieve the value of the component.
-   * @returns {Promise<string>} Value of the component.
-   */
-  getValue(): Promise<string>;
-  /**
-   * This method is used to trigger a new render of the component.
-   */
-  refresh(): Promise<void>;
-  /**
-   * Sets the focus to the component.
-   */
-  setFocus(): 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>;
-  /**
-   * Sets the value of the component.
-   * @param {string} value - Value of the component.
-   */
-  setValue(value: string): Promise<void>;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  render(): any;
-  disconnectedCallback(): void;
-}
+import { EventEmitter } from '../../stencil-public-runtime';
+import { GenericObject } from '../../types/GenericTypes';
+import { KupAutocompleteEventPayload, KupAutocompleteIconClickEventPayload } from './kup-autocomplete-declarations';
+import { ItemsDisplayMode, KupListEventPayload } from '../kup-list/kup-list-declarations';
+export declare class KupAutocomplete {
+  #private;
+  /**
+   * References the root HTML element of the component (<kup-autocomplete>).
+   */
+  rootElement: HTMLElement;
+  displayedValue: string;
+  value: string;
+  /**
+   * When true, the autocomplete fires the change event even when the value typed isn't included in the autocomplete list.
+   * @default false
+   */
+  allowInconsistentValues: boolean;
+  /**
+   * Custom style of the component.
+   * @default ""
+   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+   */
+  customStyle: string;
+  /**
+   * Props of the sub-components.
+   * @default undefined
+   */
+  data: Object;
+  /**
+   * Defaults at false. When set to true, the component is disabled.
+   * @default false
+   */
+  disabled: boolean;
+  /**
+   * Sets how to show the selected item value. Suported values: "code", "description", "both".
+   * @default ItemsDisplayMode.DESCRIPTION
+   */
+  displayMode: ItemsDisplayMode;
+  /**
+   * Sets the initial value of the component.
+   * @default ""
+   */
+  initialValue: string;
+  /**
+   * Input event emission delay in milliseconds.
+   * @default 300
+   */
+  inputDelay: number;
+  /**
+   * The minimum number of chars to trigger the autocomplete
+   * @default 1
+   */
+  minimumChars: number;
+  /**
+   * Sets how to return the selected item value. Suported values: "code", "description", "both".
+   * @default ItemsDisplayMode.CODE
+   */
+  selectMode: ItemsDisplayMode;
+  /**
+   * When true, the items filter is managed server side, otherwise items filter is done client side.
+   * @default false
+   */
+  serverHandledFilter: boolean;
+  /**
+   * When true shows the drop-down icon, for open list.
+   * @default true
+   */
+  showDropDownIcon: boolean;
+  kupBlur: EventEmitter<KupAutocompleteEventPayload>;
+  kupChange: EventEmitter<KupAutocompleteEventPayload>;
+  kupClick: EventEmitter<KupAutocompleteEventPayload>;
+  kupFocus: EventEmitter<KupAutocompleteEventPayload>;
+  kupInput: EventEmitter<KupAutocompleteEventPayload>;
+  kupIconClick: EventEmitter<KupAutocompleteIconClickEventPayload>;
+  kupItemClick: EventEmitter<KupAutocompleteEventPayload>;
+  onKupBlur(): void;
+  onKupChange(value: string): void;
+  onKupClick(): void;
+  onKupFocus(): void;
+  onKupInput(): void;
+  onKupIconClick(): void;
+  onKupItemClick(e: CustomEvent<KupListEventPayload>): void;
+  listenKeydown(e: KeyboardEvent): 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>;
+  /**
+   * Used to retrieve the value of the component.
+   * @returns {Promise<string>} Value of the component.
+   */
+  getValue(): Promise<string>;
+  /**
+   * This method is used to trigger a new render of the component.
+   */
+  refresh(): Promise<void>;
+  /**
+   * Sets the focus to the component.
+   */
+  setFocus(): 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>;
+  /**
+   * Sets the value of the component.
+   * @param {string} value - Value of the component.
+   */
+  setValue(value: string): Promise<void>;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  componentDidRender(): void;
+  render(): any;
+  disconnectedCallback(): void;
+}

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

@@ -1,9 +1,9 @@
-/**
- * Props of the kup-badge component.
- * Used to export every prop in an object.
- */
-export declare enum KupBadgeProps {
-  customStyle = "Custom style of the component.",
-  imageData = "The data of the image displayed inside the badge.Props of the sub-components.",
-  text = "The text displayed inside the badge.Defaults at false. When set to true, the component is disabled."
-}
+/**
+ * Props of the kup-badge component.
+ * Used to export every prop in an object.
+ */
+export declare enum KupBadgeProps {
+  customStyle = "Custom style of the component.",
+  imageData = "The data of the image displayed inside the badge.Props of the sub-components.",
+  text = "The text displayed inside the badge.Defaults at false. When set to true, the component is disabled."
+}

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

@@ -1,51 +1,51 @@
-import { EventEmitter } from '../../stencil-public-runtime';
-import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
-export declare class KupBadge {
-  /**
-   * References the root HTML element of the component (<kup-badge>).
-   */
-  rootElement: HTMLElement;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * The data of the image displayed inside the badge.
-   * @default null
-   */
-  imageData: GenericObject;
-  /**
-   * The text displayed inside the badge.
-   * @default null
-   */
-  text: string;
-  /**
-   * Instance of the KupManager class.
-   */
-  private kupManager;
-  kupClick: EventEmitter<KupEventPayload>;
-  onKupClick(): 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;
-}
+import { EventEmitter } from '../../stencil-public-runtime';
+import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
+export declare class KupBadge {
+  /**
+   * References the root HTML element of the component (<kup-badge>).
+   */
+  rootElement: HTMLElement;
+  /**
+   * Custom style of the component.
+   * @default ""
+   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+   */
+  customStyle: string;
+  /**
+   * The data of the image displayed inside the badge.
+   * @default null
+   */
+  imageData: GenericObject;
+  /**
+   * The text displayed inside the badge.
+   * @default null
+   */
+  text: string;
+  /**
+   * Instance of the KupManager class.
+   */
+  private kupManager;
+  kupClick: EventEmitter<KupEventPayload>;
+  onKupClick(): 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-box/kup-box-declarations.d.ts

@@ -1,113 +1,114 @@
-import { KupBadge } from '../kup-badge/kup-badge';
-import { KupEventPayload } from '../../types/GenericTypes';
-import { FCellShapes } from '../../f-components/f-cell/f-cell-declarations';
-import { KupDataCell, KupDataColumn, KupDataRow, KupDataRowAction } from '../../managers/kup-data/kup-data-declarations';
-import type { PointerEvent } from '@interactjs/types/index';
-/**
- * Props of the kup-box component.
- * Used to export every prop in an object.
- */
-export declare enum KupBoxProps {
-  cardData = "Data of the card linked to the box when the latter's layout must be a premade template.",
-  columns = "Number of columns.",
-  customStyle = "Custom style of the component.",
-  data = "Actual data of the box.",
-  dragEnabled = "Enable dragging.",
-  dropEnabled = "Enable dropping.",
-  dropOnSection = "Drop can be done in section.",
-  enableRowActions = "If enabled, a button to load / display the row actions will be displayed on the right of every box.",
-  globalFilter = "When set to true it activates the global filter.",
-  globalFilterValue = "The value of the global filter.",
-  kanban = "Displays the boxlist as a Kanban.",
-  layout = "How the field will be displayed. If not present, a default one will be created.",
-  multiSelection = "Enable multi selection.",
-  pageSelected = "Current page number.",
-  pageSize = "Number of boxes per page.",
-  pagination = "Enables pagination.",
-  rowsPerPage = "Number of current rows per page.",
-  scrollOnHover = "Activates the scroll on hover function.",
-  selectBox = "Automatically selects the box at the specified index.",
-  selectedRowsState = "Multiple selection.",
-  showSelection = "If enabled, highlights the selected box/boxes.",
-  sortBy = "If sorting is enabled, specifies which column to sort.",
-  sortEnabled = "Enable sorting.",
-  stateId = "",
-  store = "",
-  swipeDisabled = "Disable swipe."
-}
-export interface KupBoxData {
-  columns?: KupDataColumn[];
-  rows?: KupBoxRow[];
-}
-export interface KupBoxRow extends KupDataRow {
-  layout?: KupBoxLayout;
-  badgeData?: KupBadge[];
-  style?: {
-    [index: string]: string;
-  };
-}
-export interface KupBoxLayout {
-  horizontal?: boolean;
-  sections?: KupBoxSection[];
-}
-export interface KupBoxSection {
-  collapsible?: boolean;
-  columns?: number;
-  content?: KupBoxObject[];
-  dim?: string;
-  horizontal?: boolean;
-  id?: string;
-  sections?: KupBoxSection[];
-  style?: {
-    [index: string]: string;
-  };
-  title?: string;
-}
-export interface KupBoxObject {
-  column?: string;
-  value?: string;
-  shape?: FCellShapes;
-  config?: any;
-}
-export interface CollapsedSectionsState {
-  [index: string]: {
-    [index: string]: boolean;
-  };
-}
-/**
- * Interface for a kanban-displayed boxlist.
- */
-export interface KupBoxKanban {
-  columns: string[];
-  isStacked?: boolean;
-  labels?: Array<Array<string>>;
-  size?: string;
-}
-/**
- * Contains all the data of an event.
- */
-export interface KupBoxEventHandlerDetails {
-  boxObject: HTMLElement;
-  cell: KupDataCell;
-  column: KupDataColumn;
-  originalEvent: PointerEvent;
-  row: KupBoxRow;
-}
-export interface KupBoxClickEventPayload extends KupEventPayload {
-  row: KupBoxRow;
-  column?: string;
-}
-export interface KupBoxSelectedEventPayload extends KupEventPayload {
-  rows: KupBoxRow[];
-}
-export interface KupBoxAutoSelectEventPayload extends KupEventPayload {
-  row: KupBoxRow;
-}
-export interface KupBoxRowActionClickEventPayload extends KupEventPayload {
-  row: KupBoxRow;
-  action: KupDataRowAction;
-  index: number;
-}
-export interface KupBoxContextMenuEventPayload extends KupEventPayload {
-  details: KupBoxEventHandlerDetails;
-}
+import { KupBadge } from '../kup-badge/kup-badge';
+import { KupEventPayload } from '../../types/GenericTypes';
+import { FCellShapes } from '../../f-components/f-cell/f-cell-declarations';
+import { KupDataCell, KupDataColumn, KupDataRow, KupDataRowAction } from '../../managers/kup-data/kup-data-declarations';
+import type { PointerEvent } from '@interactjs/types/index';
+/**
+ * Props of the kup-box component.
+ * Used to export every prop in an object.
+ */
+export declare enum KupBoxProps {
+  cardData = "Data of the card linked to the box when the latter's layout must be a premade template.",
+  columns = "Number of columns.",
+  customStyle = "Custom style of the component.",
+  data = "Actual data of the box.",
+  dragEnabled = "Enable dragging.",
+  dropEnabled = "Enable dropping.",
+  dropOnSection = "Drop can be done in section.",
+  enableRowActions = "If enabled, a button to load / display the row actions will be displayed on the right of every box.",
+  globalFilter = "When set to true it activates the global filter.",
+  globalFilterValue = "The value of the global filter.",
+  kanban = "Displays the boxlist as a Kanban.",
+  layout = "How the field will be displayed. If not present, a default one will be created.",
+  lazyLoadRows = "When set to true, extra rows will be automatically loaded once the last row enters the viewport.",
+  multiSelection = "Enable multi selection.",
+  pageSelected = "Current page number.",
+  pageSize = "Number of boxes per page.",
+  pagination = "Enables pagination.",
+  rowsPerPage = "Number of current rows per page.",
+  scrollOnHover = "Activates the scroll on hover function.",
+  selectBox = "Automatically selects the box at the specified index.",
+  selectedRowsState = "Multiple selection.",
+  showSelection = "If enabled, highlights the selected box/boxes.",
+  sortBy = "If sorting is enabled, specifies which column to sort.",
+  sortEnabled = "Enable sorting.",
+  stateId = "",
+  store = "",
+  swipeDisabled = "Disable swipe."
+}
+export interface KupBoxData {
+  columns?: KupDataColumn[];
+  rows?: KupBoxRow[];
+}
+export interface KupBoxRow extends KupDataRow {
+  layout?: KupBoxLayout;
+  badgeData?: KupBadge[];
+  style?: {
+    [index: string]: string;
+  };
+}
+export interface KupBoxLayout {
+  horizontal?: boolean;
+  sections?: KupBoxSection[];
+}
+export interface KupBoxSection {
+  collapsible?: boolean;
+  columns?: number;
+  content?: KupBoxObject[];
+  dim?: string;
+  horizontal?: boolean;
+  id?: string;
+  sections?: KupBoxSection[];
+  style?: {
+    [index: string]: string;
+  };
+  title?: string;
+}
+export interface KupBoxObject {
+  column?: string;
+  value?: string;
+  shape?: FCellShapes;
+  config?: any;
+}
+export interface CollapsedSectionsState {
+  [index: string]: {
+    [index: string]: boolean;
+  };
+}
+/**
+ * Interface for a kanban-displayed boxlist.
+ */
+export interface KupBoxKanban {
+  columns: string[];
+  isStacked?: boolean;
+  labels?: Array<Array<string>>;
+  size?: string;
+}
+/**
+ * Contains all the data of an event.
+ */
+export interface KupBoxEventHandlerDetails {
+  boxObject: HTMLElement;
+  cell: KupDataCell;
+  column: KupDataColumn;
+  originalEvent: PointerEvent;
+  row: KupBoxRow;
+}
+export interface KupBoxClickEventPayload extends KupEventPayload {
+  row: KupBoxRow;
+  column?: string;
+}
+export interface KupBoxSelectedEventPayload extends KupEventPayload {
+  rows: KupBoxRow[];
+}
+export interface KupBoxAutoSelectEventPayload extends KupEventPayload {
+  row: KupBoxRow;
+}
+export interface KupBoxRowActionClickEventPayload extends KupEventPayload {
+  row: KupBoxRow;
+  action: KupDataRowAction;
+  index: number;
+}
+export interface KupBoxContextMenuEventPayload extends KupEventPayload {
+  details: KupBoxEventHandlerDetails;
+}

package/dist/types/components/kup-box/kup-box-state.d.ts

@@ -1,10 +1,10 @@
-import { KupState } from '../kup-state/kup-state';
-export declare class KupBoxState implements KupState {
-  globalFilterValue: string;
-  sortBy: string;
-  selectedRowsState: string;
-  pageSelected: number;
-  rowsPerPage: number;
-  load: boolean;
-  toDebugString(): string;
-}
+import { KupState } from '../kup-state/kup-state';
+export declare class KupBoxState implements KupState {
+  globalFilterValue: string;
+  sortBy: string;
+  selectedRowsState: string;
+  pageSelected: number;
+  rowsPerPage: number;
+  load: boolean;
+  toDebugString(): string;
+}