cx 25.11.1 → 26.0.1

package/src/widgets/grid/Grid.d.ts

@@ -1,445 +0,0 @@
-import * as React from "react";
-import { Instance } from "../../ui/Instance";
-import { DragEvent } from "../drag-drop/ops";
-import { View } from "../../data/View";
-import {
-   BooleanProp,
-   ClassProp,
-   CollatorOptions,
-   Config,
-   NumberProp,
-   Prop,
-   Record,
-   RecordAlias,
-   SortDirection,
-   SortersProp,
-   StringProp,
-   StructuredProp,
-   StyledContainerProps,
-   StyleProp,
-   UnknownProp,
-   Widget,
-} from "../../core";
-import { DataAdapterRecord } from "../../ui/adapter/DataAdapter";
-
-type FetchRecordsResult<T> = T[] | { records: T[]; lastPage?: boolean; totalRecordCount?: number };
-
-interface MappedGridRecord<T = unknown> extends DataAdapterRecord<T> {
-   row: Instance;
-   vdom: unknown;
-}
-
-interface GridDragEvent<T> extends DragEvent {
-   target: {
-      recordBefore: MappedGridRecord<T>;
-      recordAfter: MappedGridRecord<T>;
-      insertionIndex: number;
-      totalRecordCount: number;
-   };
-}
-
-interface GridRowDragEvent<T> extends DragEvent {
-   target: {
-      record: MappedGridRecord<T>;
-      index: number;
-   };
-}
-
-interface GridColumnDropEvent extends DragEvent {
-   target: {
-      grid: any;
-      instance: Instance;
-      index: number;
-   };
-}
-
-interface GridGroupingKey {
-   [key: string]:
-      | Prop<any>
-      | {
-           value: Prop<any>;
-           direction: SortDirection;
-        };
-}
-
-interface GroupingResult<T> {
-   key: any;
-   aggregates: any;
-   name: string;
-   indexes: number[];
-   records: MappedGridRecord<T>[];
-}
-
-type GridColumnAlignment = "left" | "right" | "center";
-
-interface GridGroupingConfig<T> {
-   key: GridGroupingKey;
-   aggregates?: StructuredProp;
-   showCaption?: boolean;
-   showFooter?: boolean;
-   showHeader?: boolean;
-   caption?: StringProp;
-   name?: StringProp;
-   text?: StringProp;
-   comparer?: (a: GroupingResult<T>, b: GroupingResult<T>) => number;
-}
-
-// TODO: Check Column config
-// Props are in order based on docs
-
-interface GridColumnHeaderConfig {
-   text?: StringProp;
-   colSpan?: NumberProp;
-   rowSpan?: NumberProp;
-   align?: GridColumnAlignment;
-   allowSorting?: boolean;
-   items?: React.ReactNode;
-   children?: React.ReactNode;
-   tool?: React.ReactNode;
-   style?: StyleProp;
-   class?: ClassProp;
-   className?: ClassProp;
-   tooltip?: StringProp | StructuredProp;
-   defaultWidth?: NumberProp;
-   width?: NumberProp;
-   resizable?: boolean;
-}
-
-interface GridColumnFooterConfig {
-   value?: Prop<any>;
-   format?: StringProp;
-   style?: StyleProp;
-   class?: StyleProp;
-   expand?: boolean;
-}
-
-interface GridColumnCaptionConfig {
-   value?: Prop<any>;
-   format?: StringProp;
-   style?: StyleProp;
-   class?: StyleProp;
-   children?: React.ReactNode;
-   items?: React.ReactNode;
-   expand?: boolean;
-}
-
-interface GridColumnConfig {
-   align?: GridColumnAlignment;
-   field?: string;
-   format?: StringProp;
-   header?: StringProp | GridColumnHeaderConfig;
-   header1?: StringProp | GridColumnHeaderConfig;
-   header2?: StringProp | GridColumnHeaderConfig;
-   header3?: StringProp | GridColumnHeaderConfig;
-   fixed?: BooleanProp;
-   sortable?: boolean;
-   aggregate?: "min" | "max" | "count" | "sum" | "distinct" | "avg";
-   aggregateAlias?: string;
-   aggregateField?: string;
-   aggregateValue?: UnknownProp;
-   caption?: GridColumnCaptionConfig | StringProp | false;
-   class?: ClassProp;
-   className?: ClassProp;
-   draggable?: boolean;
-   editable?: boolean;
-   editor?: React.ReactNode;
-   footer?: GridColumnFooterConfig | StringProp | false;
-   items?: React.ReactNode;
-   children?: React.ReactNode;
-   key?: string;
-   pad?: boolean;
-   sortField?: string;
-   sortValue?: Prop<any>;
-   style?: StyleProp;
-   trimWhitespace?: boolean;
-   visible?: BooleanProp;
-   if?: BooleanProp;
-   weightField?: string;
-
-   // Not in docs
-   value?: Prop<any>;
-   defaultWidth?: NumberProp;
-   width?: NumberProp;
-   resizable?: boolean;
-   comparer?: (a: any, b: any) => number;
-
-   /** Options for data sorting. See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator */
-   sortOptions?: CollatorOptions;
-   colSpan?: NumberProp;
-
-   mergeCells?: Prop<null | false | "same-value" | "always">;
-   primarySortDirection?: "ASC" | "DESC";
-}
-
-interface GridRowLineConfig {
-   visible?: BooleanProp;
-   columns: GridColumnConfig[];
-}
-
-interface GridRowConfig {
-   invalid?: BooleanProp;
-   valid?: BooleanProp;
-   style?: StyleProp;
-   class?: ClassProp;
-   className?: ClassProp;
-   line1?: GridRowLineConfig;
-   line2?: GridRowLineConfig;
-   line3?: GridRowLineConfig;
-   mod?: StringProp | Prop<string[]> | StructuredProp;
-}
-
-interface GridProps<T = unknown> extends StyledContainerProps {
-   /** An array of records to be displayed in the grid. */
-   records?: Prop<T[]>;
-
-   /** Set to true to add a vertical scroll and a fixed header to the grid. */
-   scrollable?: boolean;
-
-   /** A binding used to store the sorting order list. Commonly used for server-side sorting. */
-   sorters?: SortersProp;
-
-   /** A list of sorters to be prepended to the actual list of sorters. */
-   preSorters?: SortersProp;
-
-   /** A binding used to store the name of the field used for sorting grids. Available only if sorters are not used. */
-   sortField?: StringProp;
-
-   /** A binding used to store the sort direction. Available only if sorters are not used. Possible values are "ASC" and "DESC". Defaults to "ASC". */
-   sortDirection?: StringProp;
-
-   /** Default sort field. Used if neither sortField or sorters are set. */
-   defaultSortField?: string;
-
-   /** Default sort direction. */
-   defaultSortDirection?: "ASC" | "DESC";
-
-   /** Set to true to add vertical gridlines. */
-   vlines?: boolean;
-
-   /** Text to be displayed instead of an empty table. */
-   emptyText?: StringProp;
-
-   /** Drag source configuration. Define mode as 'move' or 'copy` and additional data. */
-   dragSource?: StructuredProp;
-
-   /** Drop zone configuration. Define mode as either preview or insertion. */
-   dropZone?: StructuredProp;
-
-   /** Row configuration. See grid examples. */
-   row?: GridRowConfig;
-
-   /**An array of columns. Check column configuration options in the section below. */
-   columns?: GridColumnConfig[];
-
-   /** Whenever columnParams change, columns are recalculated using the onGetColumn callback. */
-   columnParams?: Config;
-
-   /** Selection configuration. */
-   selection?: Config;
-
-   /** An array of grouping level definitions. Check allowed grouping level properties in the section below. */
-   grouping?: GridGroupingConfig<T>[];
-
-   /** Params for grouping. Whenever params change grouping is recalculated using the onGetGrouping callback. */
-   groupingParams?: Config;
-
-   /**
-    * Determines header appearance. Supported values are plain and default. Default mode is used if some of the columns are sortable.
-    * Plain mode better suits reports and other scenarios in which users do not interact with the grid.
-    */
-   headerMode?: StringProp;
-
-   /** Set to true to add default border around the table. Automatically set if grid is scrollable. */
-   border?: BooleanProp;
-
-   /** Base CSS class to be applied to the element. Default is 'grid'. */
-   baseClass?: string;
-
-   /** A field used to get the unique identifier of the record. Setting keyField improves grid performance on sort operations as the widget is able to identify row movement inside the grid.  */
-   keyField?: string;
-
-   /** Show grid header within the group. Useful for long report-like (printable) grids. Defaults to false. */
-   showHeader?: boolean;
-
-   /** Show grid footer. Defaults to false. */
-   showFooter?: boolean;
-
-   /** Record alias. Default is $record. */
-   recordName?: RecordAlias;
-
-   /** Record alias. Default is $record. */
-   recordAlias?: RecordAlias;
-
-   /** Set to true if sorting is done remotely, on the server-side. Default value is false. */
-   remoteSort?: boolean;
-
-   /** Set to true to enable row caching. This greatly improves grid performance
-    on subsequent render operations, however, only changes on records
-    are allowed. If grid rows display any data outside records, changes on that
-    data will be ignored. */
-   cached?: boolean;
-
-   /** Render only rows visible on the screen. */
-   buffered?: boolean;
-
-   /** Specifies how many rows should be visible on the screen */
-   bufferSize?: number;
-
-   /** Specifies how many rows needs to be scrolled in order to recalculate buffer */
-   bufferStep?: number;
-
-   /** Used when rows have variable heights to improve buffered rendering by measuring and caching rendered row heights. Default value is false. */
-   measureRowHeights?: boolean;
-
-   /** Scrolls selection into the view. Default value is false. */
-   scrollSelectionIntoView?: boolean;
-
-   /**
-    * Set to true to lock column widths after the first render.
-    * This is helpful in pagination scenarios to maintain consistent looks across pages.
-    */
-   lockColumnWidths?: boolean;
-
-   lockColumnWidthsRequiredRowCount?: number;
-   focused?: boolean;
-   showBorder?: boolean;
-
-   /** Data adapter used to convert data in list of records. Used to enable grouping and tree operations. */
-   dataAdapter?: any;
-
-   /** Additional CSS class to be added to each grid row. */
-   rowClass?: ClassProp;
-
-   /** Additional CSS styles to be added to each grid row. */
-   rowStyle?: StyleProp;
-
-   // drag-drop handlers
-   onDrop?: string | ((e: GridDragEvent<T>, instance: Instance) => void);
-   onDropTest?: string | ((e: DragEvent, instance: Instance) => boolean);
-   onDragStart?: string | ((e: DragEvent, instance: Instance) => void);
-   onDragEnd?: string | ((e: DragEvent, instance: Instance) => void);
-   onDragOver?: string | ((e: GridDragEvent<T>, instance: Instance) => void | boolean);
-
-   onRowDropTest?: string | ((e: DragEvent, instance: Instance) => boolean);
-   onRowDragOver?: string | ((e: GridRowDragEvent<T>, instance: Instance) => void | boolean);
-   onRowDrop?: string | ((e: GridRowDragEvent<T>, instance: Instance) => void | boolean);
-
-   onColumnDrop?: string | ((e: GridColumnDropEvent, instance: Instance) => void);
-   onColumnDropTest?: string | ((e: DragEvent, instance: Instance) => boolean);
-
-   /** Parameters that affect filtering. */
-   filterParams?: StructuredProp;
-
-   /** Callback function to be executed when a row is right-clicked.  */
-   onRowContextMenu?: string | ((e: React.SyntheticEvent<any>, instance: Instance) => void);
-
-   /** Callback to create a filter function for given filter params. */
-   onCreateFilter?: (filterParams: any, instance?: Instance) => (record: T) => boolean;
-
-   /** Enable infinite scrolling */
-   infinite?: boolean;
-
-   /** If set, clicking on the column header will loop between ASC, DESC and no sorting order, instead of ASC and DESC only. */
-   clearableSort?: boolean;
-
-   /** A callback to fetch records during infinite loading */
-   onFetchRecords?: (
-      pageInfo: {
-         page: number;
-         pageSize: number;
-         sorters?: Record[];
-         sortField?: string;
-         sortDirection?: string;
-      },
-      instance?: Instance,
-   ) => FetchRecordsResult<T> | Promise<FetchRecordsResult<T>>;
-
-   /** Callback function to be executed when a row is double-clicked. */
-   onRowDoubleClick?: string | ((e: React.SyntheticEvent<any>, instance: Instance) => void);
-
-   /** Callback function to be executed on key down. Accepts instance of the currently focused record as the second argument. */
-   onRowKeyDown?: string | ((e: React.SyntheticEvent<any>, instance: Instance) => void);
-
-   /** Callback function to be executed when a row is clicked. */
-   onRowClick?: string | ((e: React.SyntheticEvent<any>, instance: Instance) => void);
-
-   /** Set to true to add a fixed footer at the bottom of the grid. */
-   fixedFooter?: boolean;
-
-   /** Set to true to enable cell editing. Please note that all editable columns should specify the editor field. */
-   cellEditable?: boolean;
-
-   /** A callback function which is executed before a cell editor is initialized. Return false from the callback to prevent the cell from going into the edit mode. */
-   onBeforeCellEdit?: string | ((change: GridCellBeforeEditInfo, record: DataAdapterRecord<T>) => any);
-
-   /** A callback function which is executed after a cell has been successfully edited. */
-   onCellEdited?: string | ((change: GridCellEditInfo<T>, record: DataAdapterRecord<T>) => void);
-
-   /** A callback function which is executed after a column has been resized. */
-   onColumnResize?: (data: { width: number; column: Record }, instance: Instance) => void;
-
-   /** Options for data sorting. See: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator */
-   sortOptions?: CollatorOptions;
-
-   /** Callback to create a function that can be used to check whether a record is selectable. */
-   onCreateIsRecordSelectable?: (
-      params: any,
-      instance: Instance,
-   ) => (record: T, options?: { range?: boolean; toggle?: boolean }) => boolean;
-
-   /** Parameters whose change will cause scroll to be reset. */
-   scrollResetParams?: StructuredProp;
-
-   /** Enable precise (sub-pixel) measurements. Useful for grids with many columns. Better behavior at small zoom factors. */
-   preciseMeasurements?: boolean;
-
-   /** A value used to identify the group of components participating in hover effect synchronization. */
-   hoverChannel?: string;
-
-   /** A value used to uniquely identify the record within the hover sync group. */
-   rowHoverId?: Prop<string | number>;
-
-   /** Set to true or false to explicitly define if grid is allowed to receive focus. */
-   focusable?: boolean;
-
-   /** Callback function to retrieve grouping data. */
-   onGetGrouping?: (params: any, instance: Instance) => GridGroupingConfig<T>[];
-
-   /** Callback function to dynamically calculate columns.  */
-   onGetColumns?: (params: any, instance: Instance) => GridColumnConfig[] | GridRowConfig;
-
-   /** Allow grid to receive drag and drop operations containing files. */
-   allowsFileDrops?: boolean;
-
-   /**
-    * Callback function to track and retrieve displayed records.
-    * Accepts new records as a first argument.
-    * If onCreateFilter callback is defined, filtered records can be retrieved using this callback.
-    */
-   onTrackMappedRecords?: string | ((records: DataAdapterRecord<T>[], instance: Instance) => void);
-
-   /** Callback to create a function that can be used to check whether a record is draggable. */
-   onCreateIsRecordDraggable?: (params: any, instance: Instance) => (record: T) => boolean;
-
-   /** Callback function to get grid component and instance references on component init. */
-   onRef?: string | ((element: any, instance: Instance) => void);
-
-   /** When enabled, groups are shown in the same order as the source records. */
-   preserveGroupOrder?: boolean;
-}
-
-interface GridCellInfo {
-   column: any;
-   field: string;
-}
-
-interface GridCellBeforeEditInfo extends GridCellInfo {
-   data: any;
-}
-
-interface GridCellEditInfo<T> extends GridCellInfo {
-   oldData: T;
-   newData: T;
-}
-
-export class Grid<T = unknown> extends Widget<GridProps<T>> {}