@infinite-table/infinite-react 1.3.23 → 2.0.0

package/index.d.ts

@@ -11,7 +11,7 @@ declare type MultisortInfo<T> = {
      * for now 'string' and 'number' are known types, meaning they have
      * sort functions already implemented
      */
-    type?: string;
+    type?: string | string[];
     fn?: (a: any, b: any) => number;
     /**
      * a property whose value to use for sorting on the array items
@@ -370,6 +370,13 @@ declare type InfiniteTableColumnValueGetter<T, VALUE_GETTER_TYPE = string | numb
 declare type InfiniteTableColumnValueFormatter<T, VALUE_FORMATTER_TYPE = string | number | boolean | Date | null | undefined> = (params: InfiniteTableColumnValueFormatterParams<T>) => VALUE_FORMATTER_TYPE;
 declare type InfiniteTableColumnRowspanFn<T> = (params: InfiniteTableColumnRowspanParam<T>) => number;
 declare type InfiniteTableColumnComparer<T> = (a: T, b: T) => number;
+declare type InfiniteTableColumnSortableFn<T> = (context: {
+    api: InfiniteTableApi<T>;
+    columnApi: InfiniteTableColumnApi<T>;
+    column: InfiniteTableComputedColumn<T>;
+    columns: Map<string, InfiniteTableComputedColumn<T>>;
+}) => boolean;
+declare type InfiniteTableColumnSortable<T> = boolean | InfiniteTableColumnSortableFn<T>;
 /**
  * Defines a column in the table.
  *
@@ -380,7 +387,7 @@ declare type InfiniteTableColumnComparer<T> = (a: T, b: T) => number;
 declare type InfiniteTableColumn<DATA_TYPE> = {
     field?: KeyOfNoSymbol<DATA_TYPE>;
     valueGetter?: InfiniteTableColumnValueGetter<DATA_TYPE>;
-    sortable?: boolean;
+    defaultSortable?: InfiniteTableColumnSortable<DATA_TYPE>;
     draggable?: boolean;
     resizable?: boolean;
     shouldAcceptEdit?: (params: InfiniteTablePropOnEditAcceptedParams<DATA_TYPE>) => boolean | Error | Promise<boolean | Error>;
@@ -403,7 +410,7 @@ declare type InfiniteTableColumn<DATA_TYPE> = {
     headerCssEllipsis?: boolean;
     type?: InfiniteTableColumnTypeNames | InfiniteTableColumnTypeNames[] | null;
     dataType?: InfiniteTableDataTypeNames;
-    sortType?: string;
+    sortType?: string | string[];
     filterType?: string;
     style?: InfiniteTableColumnStyle<DATA_TYPE>;
     headerStyle?: InfiniteTableColumnHeaderStyle<DATA_TYPE>;
@@ -435,7 +442,7 @@ declare type InfiniteTableColumn<DATA_TYPE> = {
         MenuIcon?: (props: MenuIconProps) => JSX.Element | null;
     };
 };
-declare type InfiniteTableGeneratedGroupColumn<T> = Omit<InfiniteTableColumn<T>, 'sortable'> & {
+declare type InfiniteTableGeneratedGroupColumn<T> = Omit<InfiniteTableColumn<T>, 'defaultSortable'> & {
     groupByForColumn: GroupBy<T> | GroupBy<T>[];
     id?: string;
 };
@@ -462,7 +469,7 @@ declare type InfiniteTablePivotFinalColumn<DataType, KeyType extends any = any>
 declare type InfiniteTablePivotFinalColumnVariant<DataType, KeyType extends any = any> = InfiniteTablePivotFinalColumn<DataType, KeyType>;
 declare type InfiniteTableComputedColumnBase<T> = {
     computedFilterType: string;
-    computedSortType: string;
+    computedSortType: string | string[];
     computedDataType: string;
     computedWidth: number;
     computedFlex: number | null;
@@ -471,7 +478,6 @@ declare type InfiniteTableComputedColumnBase<T> = {
     computedOffset: number;
     computedPinningOffset: number;
     computedAbsoluteOffset: number;
-    computedSortable: boolean;
     computedSortInfo: DataSourceSingleSortInfo<T> | null;
     computedSorted: boolean;
     computedSortedAsc: boolean;
@@ -492,6 +498,7 @@ declare type InfiniteTableComputedColumnBase<T> = {
     computedFirst: boolean;
     computedLast: boolean;
     computedEditable: NonUndefined<InfiniteTableColumn<T>['defaultEditable']>;
+    computedSortable: NonUndefined<InfiniteTableColumn<T>['defaultSortable']>;
     colType: InfiniteTableColumnType<T>;
     id: string;
 };
@@ -1222,6 +1229,7 @@ interface InfiniteTableMappedState<T> {
     columnMenuRealignDelay: NonUndefined<InfiniteTableProps<T>['columnMenuRealignDelay']>;
     columnDefaultEditable: InfiniteTableProps<T>['columnDefaultEditable'];
     columnDefaultFilterable: InfiniteTableProps<T>['columnDefaultFilterable'];
+    columnDefaultSortable: InfiniteTableProps<T>['columnDefaultSortable'];
     rowStyle: InfiniteTableProps<T>['rowStyle'];
     rowProps: InfiniteTableProps<T>['rowProps'];
     rowClassName: InfiniteTableProps<T>['rowClassName'];
@@ -1235,7 +1243,7 @@ interface InfiniteTableMappedState<T> {
     columnDefaultFlex: InfiniteTableProps<T>['columnDefaultFlex'];
     columnCssEllipsis: NonUndefined<InfiniteTableProps<T>['columnCssEllipsis']>;
     draggableColumns: NonUndefined<InfiniteTableProps<T>['draggableColumns']>;
-    sortable: NonUndefined<InfiniteTableProps<T>['sortable']>;
+    sortable: InfiniteTableProps<T>['sortable'];
     hideEmptyGroupColumns: NonUndefined<InfiniteTableProps<T>['hideEmptyGroupColumns']>;
     hideColumnWhenGrouped: NonUndefined<InfiniteTableProps<T>['hideColumnWhenGrouped']>;
     keyboardSelection: NonUndefined<InfiniteTableProps<T>['keyboardSelection']>;
@@ -2320,12 +2328,12 @@ declare type InfiniteTableColumnType<T> = {
     header?: InfiniteTableColumn<T>['header'];
     comparer?: InfiniteTableColumn<T>['comparer'];
     draggable?: InfiniteTableColumn<T>['draggable'];
-    sortable?: InfiniteTableColumn<T>['sortable'];
     resizable?: InfiniteTableColumn<T>['resizable'];
     align?: InfiniteTableColumn<T>['align'];
     headerAlign?: InfiniteTableColumn<T>['headerAlign'];
     verticalAlign?: InfiniteTableColumn<T>['verticalAlign'];
     contentFocusable?: InfiniteTableColumn<T>['contentFocusable'];
+    defaultSortable?: InfiniteTableColumn<T>['defaultSortable'];
     defaultEditable?: InfiniteTableColumn<T>['defaultEditable'];
     defaultFilterable?: InfiniteTableColumn<T>['defaultFilterable'];
     columnGroup?: string;
@@ -2369,6 +2377,7 @@ declare type InfiniteTableColumnApi<_T> = {
     toggleFilterOperatorMenu: (target: EventTarget | HTMLElement) => void;
     hideFilterOperatorMenu: () => void;
     isVisible: () => boolean;
+    isSortable: () => boolean;
     getSortInfo: () => DataSourceSingleSortInfo<_T> | null;
     getSortDir(): SortDir | null;
     toggleSort: (options?: MultiSortBehaviorOptions) => void;
@@ -2442,16 +2451,18 @@ interface InfiniteTableApi<T> {
         renderStartIndex: number;
         renderEndIndex: number;
     };
+    collapseAllGroupRows: () => void;
     toggleGroupRow: (groupKeys: any[]) => void;
     collapseGroupRow: (groupKeys: any[]) => boolean;
     expandGroupRow: (groupKeys: any[]) => boolean;
     setSortInfoForColumn: (columnId: string, sortInfo: DataSourceSingleSortInfo<T> | null) => void;
     getSortInfoForColumn: (columnId: string) => DataSourceSingleSortInfo<T> | null;
-    getSortTypeForColumn: (columnId: string) => string | null;
+    getSortTypeForColumn: (columnId: string) => string | string[] | null;
     toggleSortingForColumn: (columnId: string, options?: MultiSortBehaviorOptions) => void;
     setColumnFilter: (columnId: string, filterValue: any) => void;
     setColumnFilterOperator: (columnId: string, operator: string) => void;
     clearColumnFilter: (columnId: string) => void;
+    isColumnSortable: (columnId: string) => boolean;
     setFilterValueForColumn: (columnId: string, filterValue: DataSourceFilterValueItem<T>) => void;
     setPinningForColumn: (columnId: string, pinning: InfiniteTableColumnPinnedValues) => void;
     setSortingForColumn: (columnId: string, dir: SortDir | null) => void;
@@ -2550,6 +2561,7 @@ declare type InfiniteTableRowInfoDataDiscriminatorWithColumnAndApis<T> = {
     dataSourceApi: DataSourceApi<T>;
 } & InfiniteTableRowInfoDataDiscriminatorWithColumn<T>;
 declare type InfiniteTablePropsEditable<T> = InfiniteTableColumnEditableFn<T> | undefined;
+declare type InfiniteTablePropsSortable<T> = InfiniteTableColumnSortable<T> | undefined;
 declare type InfiniteTablePropOnEditAcceptedParams<T> = InfiniteTableRowInfoDataDiscriminatorWithColumnAndApis<T> & {
     initialValue: any;
 };
@@ -2571,6 +2583,20 @@ interface InfiniteTableProps<T> {
     pivotColumn?: InfiniteTablePropPivotColumn<T, InfiniteTableColumn<T> & InfiniteTablePivotFinalColumn<T>>;
     columnDefaultFilterable?: boolean;
     columnDefaultEditable?: boolean;
+    /**
+     * Default behavior for column sorting. Defaults to true.
+     *
+     * This is overriden by all other props that can control sorting behavior (`column.defaultSortable`, `columnType.defaultSortable`, `sortable`).
+     */
+    columnDefaultSortable?: boolean;
+    /**
+     * This overrides both the global `columnDefaultSortable` prop and the column's own `defaultSortable` prop.
+     * When used, it's the ultimate source of truth for whether (and which) columns are sortable.
+     */
+    sortable?: InfiniteTablePropsSortable<T>;
+    /**
+     * This overrides both the global `columnDefaultEditable` prop and the column's own `defaultEditable` prop.
+     */
     editable?: InfiniteTablePropsEditable<T>;
     pivotTotalColumnPosition?: InfiniteTablePropPivotTotalColumnPosition;
     pivotGrandTotalColumnPosition?: InfiniteTablePropPivotGrandTotalColumnPosition;
@@ -2633,7 +2659,6 @@ interface InfiniteTableProps<T> {
     id?: string;
     showZebraRows?: boolean;
     showHoverRows?: boolean;
-    sortable?: boolean;
     multiSortBehavior?: InfiniteTablePropMultiSortBehavior;
     keyboardNavigation?: InfiniteTablePropKeyboardNavigation;
     keyboardSelection?: InfiniteTablePropKeyboardSelection;