@sme.up/ketchup 8.0.2 → 8.1.0

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

@@ -1,270 +1,275 @@
-import { EventEmitter, VNode } from '../../stencil-public-runtime';
-import { KupBoxRow, KupBoxLayout, KupBoxKanban, KupBoxClickEventPayload, KupBoxSelectedEventPayload, KupBoxAutoSelectEventPayload, KupBoxRowActionClickEventPayload, KupBoxContextMenuEventPayload, KupBoxData } from './kup-box-declarations';
-import { KupBoxState } from './kup-box-state';
-import { KupStore } from '../kup-state/kup-store';
-import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
-import { KupDataRowAction } from '../../managers/kup-data/kup-data-declarations';
-export declare class KupBox {
-  /**
-   * References the root HTML element of the component (<kup-box>).
-   */
-  rootElement: HTMLElement;
-  private collapsedSection;
-  private selectedRows;
-  /**
-   * Row that has the row object menu open
-   */
-  private rowActionMenuOpened;
-  private currentPage;
-  private currentRowsPerPage;
-  state: KupBoxState;
-  initWithPersistedState(): void;
-  persistState(): void;
-  /**
-   * Data of the card linked to the box when the latter's layout must be a premade template.
-   * @default null
-   */
-  cardData: GenericObject;
-  /**
-   * Number of columns
-   * @default 1
-   */
-  columns: number;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * Actual data of the box.
-   * @default null
-   */
-  data: KupBoxData;
-  /**
-   * Enable dragging
-   * @default false
-   */
-  dragEnabled: boolean;
-  /**
-   * Enable dropping
-   * @default false
-   */
-  dropEnabled: boolean;
-  /**
-   * Drop can be done in section
-   * @default false
-   */
-  dropOnSection: boolean;
-  /**
-   * When set to true, editable cells will be rendered using input components.
-   * @default false
-   */
-  editableData: boolean;
-  /**
-   * If enabled, a button to load / display the row actions
-   * will be displayed on the right of every box
-   * @default false
-   */
-  enableRowActions: boolean;
-  /**
-   * When set to true it activates the global filter.
-   * @default false
-   */
-  globalFilter: boolean;
-  /**
-   * The value of the global filter.
-   * @default ""
-   */
-  globalFilterValue: string;
-  /**
-   * Displays the boxlist as a Kanban.
-   * @default null
-   */
-  kanban: KupBoxKanban;
-  /**
-   * How the field will be displayed. If not present, a default one will be created.
-   * @default undefined
-   */
-  layout: KupBoxLayout;
-  /**
-   * Enable multi selection
-   * @default false
-   */
-  multiSelection: boolean;
-  /**
-   * Current page number
-   * @default 1
-   */
-  pageSelected: number;
-  /**
-   * Number of boxes per page
-   * @default 10
-   */
-  pageSize: number;
-  /**
-   * Enables pagination
-   * @default false
-   */
-  pagination: boolean;
-  /**
-   * Number of current rows per page
-   * @default undefined
-   */
-  rowsPerPage: number;
-  /**
-   * Activates the scroll on hover function.
-   * @default false
-   */
-  scrollOnHover: boolean;
-  /**
-   * Automatically selects the box at the specified index
-   * @default undefined
-   */
-  selectBox: number;
-  /**
-   * Multiple selection
-   * @default undefined
-   */
-  selectedRowsState: string;
-  /**
-   * If enabled, highlights the selected box/boxes
-   * @default true
-   */
-  showSelection: boolean;
-  /**
-   * If sorting is enabled, specifies which column to sort
-   * @default undefined
-   */
-  sortBy: string;
-  /**
-   * Enable sorting
-   * @default false
-   */
-  sortEnabled: boolean;
-  stateId: string;
-  store: KupStore;
-  /**
-   * Disable swipe
-   * @default false
-   */
-  swipeDisabled: boolean;
-  /**
-   * Instance of the KupManager class.
-   */
-  private kupManager;
-  private boxLayout;
-  private visibleColumns;
-  private rows;
-  private filteredRows;
-  private globalFilterTimeout;
-  private boxContainer;
-  private sectionRef;
-  private rowsRefs;
-  private hold;
-  private interactableDrag;
-  private interactableDrop;
-  private interactableTouch;
-  /**
-   * Triggered when a box is clicked
-   */
-  kupBoxClick: EventEmitter<KupBoxClickEventPayload>;
-  /**
-   * Triggered when the multi selection checkbox changes value
-   */
-  kupBoxSelected: EventEmitter<KupBoxSelectedEventPayload>;
-  /**
-   * Triggered when a box is auto selected via selectBox prop
-   */
-  kupAutoBoxSelect: EventEmitter<KupBoxAutoSelectEventPayload>;
-  /**
-   * When the row menu action icon is click
-   */
-  kupRowActionMenuClick: EventEmitter<KupBoxAutoSelectEventPayload>;
-  /**
-   * When the row menu action icon is click
-   */
-  kupRowActionClick: EventEmitter<KupBoxRowActionClickEventPayload>;
-  kupDidLoad: EventEmitter<KupEventPayload>;
-  /**
-   * Triggered when stop propagation event
-   */
-  kupDidUnload: EventEmitter<KupEventPayload>;
-  /**
-   * Generic right click event on box.
-   */
-  kupBoxContextMenu: EventEmitter<KupBoxContextMenuEventPayload>;
-  rowsPerPageHandler(newValue: number): void;
-  recalculateRows(): void;
-  onDataChanged(): void;
-  onLayoutChanged(): void;
-  onSelectBoxChanged(): 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>;
-  loadRowActions(row: KupBoxRow, actions: KupDataRowAction[]): Promise<void>;
-  /**
-   * 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>;
-  private getColumns;
-  private initVisibleColumns;
-  private getRows;
-  private initRows;
-  private sortRows;
-  private checkScrollOnHover;
-  private checkLayout;
-  private onSortChange;
-  private onGlobalFilterChange;
-  private isSectionExpanded;
-  private handleAutomaticBoxSelection;
-  private getEventDetails;
-  private contextMenuHandler;
-  /**
-   * Checks if the element is the svg that opens the "row actions menu"
-   * @param element the element to check
-   */
-  private checkIfElementIsActionMenuIcon;
-  private onBoxClick;
-  private onSelectionCheckChange;
-  private toggleSectionExpand;
-  private onRowAction;
-  private onRowActionClick;
-  /**
-   * see onDocumentClick in kup-combo
-   */
-  private clickFunction;
-  private handlePageChange;
-  private handleRowsPerPageChange;
-  private adjustPaginator;
-  private renderSectionAsCard;
-  private renderRow;
-  private renderSection;
-  private renderBoxObject;
-  /**
-   * Prepares the kanban sections by sorting the boxlist's data.
-   * @returns {{jsx: VNode[], style: { [index: string]: string }}} jsx contains the virtual nodes of the Kanban sections, style contains the grid CSS settings.
-   */
-  kanbanMode(): {
-    jsx: VNode[];
-    style: {
-      [index: string]: string;
-    };
-  };
-  didLoadInteractables(): void;
-  didRenderInteractables(): void;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  render(): any;
-  disconnectedCallback(): void;
-}
+import { EventEmitter, VNode } from '../../stencil-public-runtime';
+import { KupBoxRow, KupBoxLayout, KupBoxKanban, KupBoxClickEventPayload, KupBoxSelectedEventPayload, KupBoxAutoSelectEventPayload, KupBoxRowActionClickEventPayload, KupBoxContextMenuEventPayload, KupBoxData } from './kup-box-declarations';
+import { KupBoxState } from './kup-box-state';
+import { KupStore } from '../kup-state/kup-store';
+import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
+import { KupDataRowAction } from '../../managers/kup-data/kup-data-declarations';
+export declare class KupBox {
+  #private;
+  /**
+   * References the root HTML element of the component (<kup-box>).
+   */
+  rootElement: HTMLElement;
+  private collapsedSection;
+  private selectedRows;
+  /**
+   * Row that has the row object menu open
+   */
+  private rowActionMenuOpened;
+  private currentPage;
+  private currentRowsPerPage;
+  state: KupBoxState;
+  initWithPersistedState(): void;
+  persistState(): void;
+  /**
+   * Data of the card linked to the box when the latter's layout must be a premade template.
+   * @default null
+   */
+  cardData: GenericObject;
+  /**
+   * Number of columns
+   * @default 1
+   */
+  columns: number;
+  /**
+   * Custom style of the component.
+   * @default ""
+   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+   */
+  customStyle: string;
+  /**
+   * Actual data of the box.
+   * @default null
+   */
+  data: KupBoxData;
+  /**
+   * Enable dragging
+   * @default false
+   */
+  dragEnabled: boolean;
+  /**
+   * Enable dropping
+   * @default false
+   */
+  dropEnabled: boolean;
+  /**
+   * Drop can be done in section
+   * @default false
+   */
+  dropOnSection: boolean;
+  /**
+   * When set to true, editable cells will be rendered using input components.
+   * @default false
+   */
+  editableData: boolean;
+  /**
+   * If enabled, a button to load / display the row actions
+   * will be displayed on the right of every box
+   * @default false
+   */
+  enableRowActions: boolean;
+  /**
+   * When set to true it activates the global filter.
+   * @default false
+   */
+  globalFilter: boolean;
+  /**
+   * The value of the global filter.
+   * @default ""
+   */
+  globalFilterValue: string;
+  /**
+   * Displays the boxlist as a Kanban.
+   * @default null
+   */
+  kanban: KupBoxKanban;
+  /**
+   * How the field will be displayed. If not present, a default one will be created.
+   * @default undefined
+   */
+  layout: KupBoxLayout;
+  /**
+   * When set to true, extra rows will be automatically loaded once the last row enters the viewport.
+   */
+  lazyLoadRows: boolean;
+  /**
+   * Enable multi selection
+   * @default false
+   */
+  multiSelection: boolean;
+  /**
+   * Current page number
+   * @default 1
+   */
+  pageSelected: number;
+  /**
+   * Number of boxes per page
+   * @default 10
+   */
+  pageSize: number;
+  /**
+   * Enables pagination
+   * @default false
+   */
+  pagination: boolean;
+  /**
+   * Number of current rows per page
+   * @default undefined
+   */
+  rowsPerPage: number;
+  /**
+   * Activates the scroll on hover function.
+   * @default false
+   */
+  scrollOnHover: boolean;
+  /**
+   * Automatically selects the box at the specified index
+   * @default undefined
+   */
+  selectBox: number;
+  /**
+   * Multiple selection
+   * @default undefined
+   */
+  selectedRowsState: string;
+  /**
+   * If enabled, highlights the selected box/boxes
+   * @default true
+   */
+  showSelection: boolean;
+  /**
+   * If sorting is enabled, specifies which column to sort
+   * @default undefined
+   */
+  sortBy: string;
+  /**
+   * Enable sorting
+   * @default false
+   */
+  sortEnabled: boolean;
+  stateId: string;
+  store: KupStore;
+  /**
+   * Disable swipe
+   * @default false
+   */
+  swipeDisabled: boolean;
+  /**
+   * Instance of the KupManager class.
+   */
+  private kupManager;
+  private boxLayout;
+  private visibleColumns;
+  private rows;
+  private filteredRows;
+  private globalFilterTimeout;
+  private boxContainer;
+  private sectionRef;
+  private rowsRefs;
+  private hold;
+  private interactableDrag;
+  private interactableDrop;
+  private interactableTouch;
+  /**
+   * Triggered when a box is clicked
+   */
+  kupBoxClick: EventEmitter<KupBoxClickEventPayload>;
+  /**
+   * Triggered when the multi selection checkbox changes value
+   */
+  kupBoxSelected: EventEmitter<KupBoxSelectedEventPayload>;
+  /**
+   * Triggered when a box is auto selected via selectBox prop
+   */
+  kupAutoBoxSelect: EventEmitter<KupBoxAutoSelectEventPayload>;
+  /**
+   * When the row menu action icon is click
+   */
+  kupRowActionMenuClick: EventEmitter<KupBoxAutoSelectEventPayload>;
+  /**
+   * When the row menu action icon is click
+   */
+  kupRowActionClick: EventEmitter<KupBoxRowActionClickEventPayload>;
+  kupDidLoad: EventEmitter<KupEventPayload>;
+  /**
+   * Triggered when stop propagation event
+   */
+  kupDidUnload: EventEmitter<KupEventPayload>;
+  /**
+   * Generic right click event on box.
+   */
+  kupBoxContextMenu: EventEmitter<KupBoxContextMenuEventPayload>;
+  rowsPerPageHandler(newValue: number): void;
+  recalculateRows(): void;
+  onDataChanged(): void;
+  onLayoutChanged(): void;
+  onSelectBoxChanged(): 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>;
+  loadRowActions(row: KupBoxRow, actions: KupDataRowAction[]): Promise<void>;
+  /**
+   * 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>;
+  private getColumns;
+  private initVisibleColumns;
+  private getRows;
+  private initRows;
+  private sortRows;
+  private checkScrollOnHover;
+  private checkLayout;
+  private onSortChange;
+  private onGlobalFilterChange;
+  private isSectionExpanded;
+  private handleAutomaticBoxSelection;
+  private getEventDetails;
+  private contextMenuHandler;
+  /**
+   * Checks if the element is the svg that opens the "row actions menu"
+   * @param element the element to check
+   */
+  private checkIfElementIsActionMenuIcon;
+  private onBoxClick;
+  private onSelectionCheckChange;
+  private toggleSectionExpand;
+  private onRowAction;
+  private onRowActionClick;
+  /**
+   * see onDocumentClick in kup-combo
+   */
+  private clickFunction;
+  private handlePageChange;
+  private handleRowsPerPageChange;
+  private adjustPaginator;
+  private renderSectionAsCard;
+  private renderRow;
+  private renderSection;
+  private renderBoxObject;
+  /**
+   * Prepares the kanban sections by sorting the boxlist's data.
+   * @returns {{jsx: VNode[], style: { [index: string]: string }}} jsx contains the virtual nodes of the Kanban sections, style contains the grid CSS settings.
+   */
+  kanbanMode(): {
+    jsx: VNode[];
+    style: {
+      [index: string]: string;
+    };
+  };
+  didLoadInteractables(): void;
+  didRenderInteractables(): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  componentDidRender(): void;
+  render(): any;
+  disconnectedCallback(): void;
+}

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

@@ -1,24 +1,24 @@
-import { KupEventPayload } from '../../types/GenericTypes';
-/**
- * Props of the kup-button component.
- * Used to export every prop in an object.
- */
-export declare enum KupButtonProps {
-  buttonType = "Sets the type of the button.",
-  checked = "When set to true, the icon button state will be on.",
-  customStyle = "Custom style of the component.",
-  disabled = "Defaults at false. When set to true, the component is disabled.",
-  icon = "When set, the button will show this icon.",
-  iconOff = "When set, the icon button off state will show this icon. Otherwise, an outlined version of the icon prop will be displayed.",
-  label = "When set, the button will show this text.",
-  styling = "Defines the style of the button. Styles available: \"flat\", \"outlined\" and \"raised\" which is also the default.",
-  showSpinner = "When set to true, the button show a spinner received in slot.",
-  toggable = "When set to true, the icon button will be toggable on/off.",
-  trailingIcon = "When set, the icon will be shown after the text."
-}
-/**
- * Generic payload of a kup event.
- */
-export interface KupButtonClickEventPayload extends KupEventPayload {
-  value: string;
-}
+import { KupEventPayload } from '../../types/GenericTypes';
+/**
+ * Props of the kup-button component.
+ * Used to export every prop in an object.
+ */
+export declare enum KupButtonProps {
+  buttonType = "Sets the type of the button.",
+  checked = "When set to true, the icon button state will be on.",
+  customStyle = "Custom style of the component.",
+  disabled = "Defaults at false. When set to true, the component is disabled.",
+  icon = "When set, the button will show this icon.",
+  iconOff = "When set, the icon button off state will show this icon. Otherwise, an outlined version of the icon prop will be displayed.",
+  label = "When set, the button will show this text.",
+  styling = "Defines the style of the button. Styles available: \"flat\", \"outlined\" and \"raised\" which is also the default.",
+  showSpinner = "When set to true, the button show a spinner received in slot.",
+  toggable = "When set to true, the icon button will be toggable on/off.",
+  trailingIcon = "When set, the icon will be shown after the text."
+}
+/**
+ * Generic payload of a kup event.
+ */
+export interface KupButtonClickEventPayload extends KupEventPayload {
+  value: string;
+}