ia-table 0.15.3 → 0.15.5

package/dist/index.d.ts

@@ -107,6 +107,10 @@ declare const ACTION_TYPES: {
     readonly SET_COMMENT_CONTEXT_REF: "SET_COMMENT_CONTEXT_REF";
     readonly SET_CHAT_ENABLED: "SET_CHAT_ENABLED";
     readonly SET_COMMENT_ENABLED: "SET_COMMENT_ENABLED";
+    readonly SET_NO_HEADER_SELECTION_CHECKBOX: "SET_NO_HEADER_SELECTION_CHECKBOX";
+    readonly SET_DATA_IS_TREE_DATA: "SET_DATA_IS_TREE_DATA";
+    readonly SET_VIRTUALIZATION_CONFIG: "SET_VIRTUALIZATION_CONFIG";
+    readonly SET_DISABLE_CURRENT_PAGE_RECORDS: "SET_DISABLE_CURRENT_PAGE_RECORDS";
 };
 
 declare interface ChildHeightsResult {
@@ -572,6 +576,7 @@ export declare interface SmartGridAPI extends SmartGridPaginationAPI, SmartGridA
     tableId: string;
     getFocusedCell: () => SmartGridFocusedCell | null;
     getSelectedCells: () => SmartGridSelectedCell[];
+    getCellRanges: () => SmartGridCellRange[] | null;
     getAllDisplayedColumns: () => SmartGridDisplayedColumn[];
     getDisplayedRowCount: () => number;
     setFocusedCell: (rowIndex: number, colKey: SmartGridColumnDefinition | string | number) => boolean;
@@ -579,6 +584,7 @@ export declare interface SmartGridAPI extends SmartGridPaginationAPI, SmartGridA
     getColumnByField: (fieldName: string) => SmartGridColumnDefinition | null;
     getTableInstance: () => SmartGridTableInstance | undefined;
     getFilterModel: () => SmartGridFilterModel | Record<string, SmartGridFilterModel[]>;
+    getSortModel: () => SmartGridSortModel;
     setFilterModel: (field: string, rules: SmartGridFilterModel) => void;
     getTableDispatcher: () => (action: SmartGridDisptach) => void;
     getTableStateContext: () => SmartGridStateContext;
@@ -723,12 +729,14 @@ export declare interface SmartGridBaseColumnDefinition {
     headerTooltip?: string;
     filter?: string | boolean;
     filterParams?: {
+        [key: string]: unknown;
+    } & {
         filterOptions?: string[];
         textCustomComparator?: (filter: string, value: unknown, filterText: string) => boolean;
         numberCustomComparator?: (filter: number, value: unknown) => boolean;
         dateCustomComparator?: (filterLocalDateAtMidnight: Date, cellValue: string) => number;
         comparator?: (filterValue: unknown, cellValue: unknown) => boolean;
-        [key: string]: unknown;
+        maxCharLength?: number;
     };
     order_of_display?: number;
     is_hidden?: boolean;
@@ -1108,6 +1116,28 @@ export declare interface SmartGridCallbackRefCurrent {
     onContentDensityChange?: ((contentDensity: SmartGridRowHeightType) => void) | null;
 }
 
+export declare interface SmartGridCellPosition {
+    rowIndex: number;
+    colIndex: number;
+}
+
+/**
+ * Represents a cell range selection (similar to AG Grid's CellRange).
+ * Contains the start/end rows and the columns included in the range.
+ */
+export declare interface SmartGridCellRange {
+    startRow: {
+        rowIndex: number;
+        rowPinned: string | null;
+    };
+    endRow: {
+        rowIndex: number;
+        rowPinned: string | null;
+    };
+    columns: SmartGridColumnDefinition[];
+    startColumn: SmartGridColumnDefinition;
+}
+
 export declare type SmartGridCellRenderer = {
     value: unknown;
     data: SmartGridRowData;
@@ -2143,6 +2173,7 @@ export declare type SmartGridDefaultColDef = {
     };
     headerComponent?: React.FC<SmartGridHeaderStyleParams> | null;
     enableCellChangeFlash?: boolean;
+    maxCharLengthInSearch?: number;
 };
 
 export declare type SmartGridDispatch = (action: {
@@ -2689,6 +2720,7 @@ export declare interface SmartGridIATableState {
     selectedCells: Map<string, SmartGridSelectedCellState>;
     instanceKeyHandlers: Map<string, (e: KeyboardEvent) => void>;
     activeInstance?: HTMLElement | null;
+    multiSelection?: SmartGridMultiSelectionState;
 }
 
 export declare interface SmartGridImageUploaderProps {
@@ -2996,6 +3028,12 @@ export declare interface SmartGridInternalGetRowsParams {
     noDataUpdate?: boolean;
 }
 
+export declare interface SmartGridIsRowSelectableParams {
+    data: SmartGridRowData;
+    id: string;
+    rowIndex: number;
+}
+
 /** Last accessed sequence generator */
 declare interface SmartGridLastAccessedSequence {
     value: number;
@@ -3377,6 +3415,12 @@ export declare interface SmartGridMoreAvatarProps {
     size?: SmartGridAvatarSize;
 }
 
+export declare interface SmartGridMultiSelectionState {
+    anchor: SmartGridCellPosition | null;
+    current: SmartGridCellPosition | null;
+    selectedPositions: SmartGridCellPosition[];
+}
+
 export declare interface SmartGridNewSortModel {
     column: string | null;
     order: SmartGridSortDirection | null;
@@ -4193,6 +4237,12 @@ export declare interface SmartGridRowRenderProps {
     rowHeightCache: RowHeightCache | null;
     adjustTableHeightServerSide?: boolean;
     height: string | number;
+    childRowsCount: number;
+}
+
+export declare interface SmartGridRowSelectionRefCurrent {
+    isRowSelectable?: (params: SmartGridIsRowSelectableParams) => boolean;
+    hideDisabledCheckboxes?: boolean;
 }
 
 export declare interface SmartGridRowSpanInfo {
@@ -4567,6 +4617,7 @@ export declare interface SmartGridStateContext {
     clickCallbackRef: MutableRefObject<SmartGridClickCallbackRefCurrent>;
     customCallback: SmartGridCustomCallbackRefCurrent;
     contextRef: MutableRefObject<SmartGridCommentContextRef> | null;
+    rowSelectionRef: MutableRefObject<SmartGridRowSelectionRefCurrent> | null;
     tableId: string;
     isSingleSelect: boolean;
     selectable: boolean;
@@ -4588,6 +4639,10 @@ export declare interface SmartGridStateContext {
     totalColumnsCount: number;
     isCommentFeatureEnabled: boolean;
     isChatEnabled: boolean;
+    noHeaderSelection: boolean;
+    treeData: boolean;
+    virtualizationConfig: SmartGridVirConfig;
+    disableCurrentPageRecords: boolean;
     [key: string]: unknown;
 }
 
@@ -5069,7 +5124,7 @@ export declare interface SmartGridTableProps extends SmartGridSaveViewCallbackRe
     defaultPageSize?: number;
     paginationPageSize?: number[];
     enableRowSpan?: boolean;
-    rowSpanColumn?: string | string[];
+    rowSpanColumn?: string | string[] | null;
     showHeader?: boolean;
     showFooter?: boolean;
     showToolbar?: boolean;
@@ -5109,6 +5164,11 @@ export declare interface SmartGridTableProps extends SmartGridSaveViewCallbackRe
     CommentComponent?: FC<SmartGridCommentWrapperProps>;
     commentProps?: SmartGridCommentProps;
     onContentDensityChange?: ((contentDensity: SmartGridRowHeightType) => void) | null;
+    noHeaderSelection?: boolean;
+    treeData?: boolean;
+    virtualizationConfig?: SmartGridVirConfig;
+    rowSelection?: SmartGridRowSelectionRefCurrent;
+    disableCurrentPageRecords?: boolean;
 }
 
 export declare interface SmartGridTableRef {
@@ -5258,6 +5318,7 @@ export declare interface SmartGridUpdateRefParams extends SmartGridCallbackRefCu
     handleSortChange?: (sortModel: SmartGridSortModel) => void;
     handleFilterChange?: (filterModel: SmartGridFilterModel) => void;
     handleSearch?: (searchValue: SmartGridSearchFunctionParams) => void;
+    rowSelection?: SmartGridRowSelectionRefCurrent;
 }
 
 export declare interface SmartGridUpdateRefReturn {
@@ -5266,6 +5327,7 @@ export declare interface SmartGridUpdateRefReturn {
     saveViewCallbackRef: MutableRefObject<SmartGridSaveViewCallbackRefCurrent>;
     saveViewOptionsRef: MutableRefObject<SmartGridSaveViewOptionsRefCurrent>;
     clickCallbackRef: MutableRefObject<SmartGridClickCallbackRefCurrent>;
+    rowSelectionRef: MutableRefObject<SmartGridRowSelectionRefCurrent>;
 }
 
 export declare type SmartGridValueFormatterConfig = {
@@ -5299,6 +5361,10 @@ declare interface SmartGridViewportRange {
     endRow: number;
 }
 
+export declare type SmartGridVirConfig = {
+    threshold: number;
+};
+
 export declare interface SmartGridVirtualizationParams {
     dataLength: number;
     threshold?: number;