@procore/data-table 14.9.0 → 14.11.0

package/dist/modern/index.d.cts

@@ -1,5 +1,5 @@
 import * as _ag_grid_community_core from '@ag-grid-community/core';
-import { ICellRendererParams, NumberFilterModel as NumberFilterModel$1, ColDef, IRowNode, ICellEditorParams, RowDataTransaction, RowNodeTransaction, ServerSideTransaction, GridApi, ICellEditor, RefreshCellsParams, RowNode as RowNode$1, Column, SelectionEventSourceType, ColumnPinnedType, RowHeightParams, CheckboxSelectionCallbackParams, ExcelDataType, RowGroupOpenedEvent, Module, RowSelectedEvent, ColumnEverythingChangedEvent, GetRowIdParams, ColumnApi, IFilter, IScalarFilterParams, ISimpleFilterParams } from '@ag-grid-community/core';
+import { ICellRendererParams, NumberFilterModel as NumberFilterModel$1, ColDef, IRowNode, ICellEditorParams, RowDataTransaction, RowNodeTransaction, ServerSideTransaction, GridApi, ICellEditor, RefreshCellsParams, RowNode as RowNode$1, Column, SelectionEventSourceType, ColumnPinnedType, RowHeightParams, CheckboxSelectionCallbackParams, ExcelDataType, RowGroupOpenedEvent, Module, RowSelectedEvent, ColumnEverythingChangedEvent, TabToNextCellParams, CellPosition, GetRowIdParams, ColumnApi, IFilter, IScalarFilterParams, ISimpleFilterParams } from '@ag-grid-community/core';
 import * as React$1 from 'react';
 import React__default from 'react';
 import { AgGridReactProps, AgReactUiProps } from '@ag-grid-community/react';
@@ -509,6 +509,9 @@ interface ColumnDefinition<TValue = any, TRenderer = React.FC<ICellRendererParam
     autoHeight?: boolean;
     wrapText?: boolean;
     lockPosition?: ColDef['lockPosition'];
+    rowDrag?: boolean | ((params: {
+        node: RowNode;
+    }) => boolean);
 }
 interface ExtendedColDef extends ColDef {
     bulkEditable?: ((params: IsEditableParams) => boolean) | boolean;
@@ -571,6 +574,10 @@ interface TableApi {
      * @private
      */
     getCellEditorInstances: () => ICellEditor[];
+    /**
+     * Returns an array of transformed visible row nodes
+     */
+    getVisibleRowNodes: () => RowNode[];
     /**
      * Get the sorted leaf and group nodes remaining after filtering. Note: This only works for tables using the client side row model.
      */
@@ -645,7 +652,7 @@ interface TableApi {
      */
     setIsRowSelectable?(isRowSelectableFunc: IsRowSelectable): void;
 }
-type PartialTableApi = Pick<TableApi, 'applyTransaction' | 'applyServerSideTransaction' | 'collapseAll' | 'deselectAll' | 'expandAll' | 'getColumnDefinitions' | 'getDetailGridTableApi' | 'getFilteredAndSortedRowNodes' | 'getRootAggregateData' | 'getRowData' | 'getSelectedRows' | 'getServerSideSelectionState' | 'getTableConfiguration' | 'refreshCells' | 'scrollToRow' | 'selectAll' | 'setPinnedBottomRowData' | 'setRowData' | 'setRowNodeExpanded' | 'sizeColumnsToFit'>;
+type PartialTableApi = Pick<TableApi, 'applyTransaction' | 'applyServerSideTransaction' | 'collapseAll' | 'deselectAll' | 'expandAll' | 'getColumnDefinitions' | 'getDetailGridTableApi' | 'getFilteredAndSortedRowNodes' | 'getVisibleRowNodes' | 'getRootAggregateData' | 'getRowData' | 'getSelectedRows' | 'getServerSideSelectionState' | 'getTableConfiguration' | 'refreshCells' | 'scrollToRow' | 'selectAll' | 'setPinnedBottomRowData' | 'setRowData' | 'setRowNodeExpanded' | 'sizeColumnsToFit'>;
 type AgDomLayout = 'normal' | 'autoHeight' | 'print' | undefined;
 interface IsRowSelectable {
     (node: RowNode): boolean;
@@ -989,6 +996,10 @@ interface TableProps<TRow = any, TBottomRow = any> {
     suppressResetColumnsOption?: boolean;
     suppressRowClickSelection?: boolean;
     stickyExpandedGroupRows?: boolean;
+    /**
+     * Allows overriding the default behaviour for when user hits Tab key when a cell is focused
+     */
+    tabToNextCell?: (params: TabToNextCellParams<any, any>) => CellPosition | null;
 }
 type AggregationFunction<TValue> = (params: {
     columnDefinition: ColumnDefinition;
@@ -1156,7 +1167,11 @@ interface IFilterProps<Opt = any, Val = number | string | null> {
         headerName: string;
         value: Val extends string ? string[] : Val extends number ? number[] : unknown[];
     }) => React.FunctionComponent | string;
-    getFilterOptions?: () => Promise<Opt[]>;
+    getFilterOptions?: (params?: {
+        currentOffset?: number;
+        searchQuery?: string;
+    }) => Promise<Opt[] | IFilterOptions<Opt>>;
+    onSearch?: (event: React.ChangeEvent<HTMLInputElement>) => void;
     getId?: (option: Opt) => Val extends string ? string : Val extends number ? number : unknown;
     getLabel?: (option: Opt) => string;
     groupName?: string;
@@ -1188,6 +1203,8 @@ interface FilterComponentProps<Opt = any, Val = Opt[] | NumberFilterModel> {
     getOptions?: () => Promise<boolean>;
     loading: boolean;
     onChange: (value: Opt[] | NumberFilterModel | undefined) => void;
+    onScrollBottom?: () => void;
+    onSearch?: (event: React.ChangeEvent<HTMLInputElement>) => void;
     onRemove: () => void;
     options: Opt[];
     value: Val;
@@ -1220,6 +1237,10 @@ interface IFilterState<Opt = any, Val = number | string> {
 interface IServerFiltersState {
     [field: string]: IFilterState;
 }
+interface IFilterOptions<UniversalOpt = any> {
+    options: UniversalOpt[];
+    totalOptions: number;
+}
 interface IFilterStorage<UniversalOpt = any, UniversalVal = number | string> {
     hasDefinedFilters: boolean;
     hasSelectedFilters: boolean;
@@ -1227,6 +1248,7 @@ interface IFilterStorage<UniversalOpt = any, UniversalVal = number | string> {
     getSelected: (field: string) => IFilterState<UniversalOpt, UniversalVal>;
     getListFilter: (field: string) => IFilterState<UniversalOpt, UniversalVal>;
     selectedFilters: IServerFiltersState;
+    getTotalOptions: (field: string) => number;
     onChangeFilterValue: ({ field, value, }: {
         field: string;
         value: any;
@@ -1235,7 +1257,7 @@ interface IFilterStorage<UniversalOpt = any, UniversalVal = number | string> {
     onClearAllFilters: React.MouseEventHandler<HTMLButtonElement>;
     possibleFilters: string[];
     setSelectedFilters: (filters: IServerFilter[]) => void;
-    waitForStoredOptions: (field: string) => Promise<void>;
+    waitForStoredOptions: (field: string, search?: string) => Promise<void>;
     filtersState: IServerFilter[];
 }
 

package/dist/modern/index.d.ts

@@ -1,5 +1,5 @@
 import * as _ag_grid_community_core from '@ag-grid-community/core';
-import { ICellRendererParams, NumberFilterModel as NumberFilterModel$1, ColDef, IRowNode, ICellEditorParams, RowDataTransaction, RowNodeTransaction, ServerSideTransaction, GridApi, ICellEditor, RefreshCellsParams, RowNode as RowNode$1, Column, SelectionEventSourceType, ColumnPinnedType, RowHeightParams, CheckboxSelectionCallbackParams, ExcelDataType, RowGroupOpenedEvent, Module, RowSelectedEvent, ColumnEverythingChangedEvent, GetRowIdParams, ColumnApi, IFilter, IScalarFilterParams, ISimpleFilterParams } from '@ag-grid-community/core';
+import { ICellRendererParams, NumberFilterModel as NumberFilterModel$1, ColDef, IRowNode, ICellEditorParams, RowDataTransaction, RowNodeTransaction, ServerSideTransaction, GridApi, ICellEditor, RefreshCellsParams, RowNode as RowNode$1, Column, SelectionEventSourceType, ColumnPinnedType, RowHeightParams, CheckboxSelectionCallbackParams, ExcelDataType, RowGroupOpenedEvent, Module, RowSelectedEvent, ColumnEverythingChangedEvent, TabToNextCellParams, CellPosition, GetRowIdParams, ColumnApi, IFilter, IScalarFilterParams, ISimpleFilterParams } from '@ag-grid-community/core';
 import * as React$1 from 'react';
 import React__default from 'react';
 import { AgGridReactProps, AgReactUiProps } from '@ag-grid-community/react';
@@ -509,6 +509,9 @@ interface ColumnDefinition<TValue = any, TRenderer = React.FC<ICellRendererParam
     autoHeight?: boolean;
     wrapText?: boolean;
     lockPosition?: ColDef['lockPosition'];
+    rowDrag?: boolean | ((params: {
+        node: RowNode;
+    }) => boolean);
 }
 interface ExtendedColDef extends ColDef {
     bulkEditable?: ((params: IsEditableParams) => boolean) | boolean;
@@ -571,6 +574,10 @@ interface TableApi {
      * @private
      */
     getCellEditorInstances: () => ICellEditor[];
+    /**
+     * Returns an array of transformed visible row nodes
+     */
+    getVisibleRowNodes: () => RowNode[];
     /**
      * Get the sorted leaf and group nodes remaining after filtering. Note: This only works for tables using the client side row model.
      */
@@ -645,7 +652,7 @@ interface TableApi {
      */
     setIsRowSelectable?(isRowSelectableFunc: IsRowSelectable): void;
 }
-type PartialTableApi = Pick<TableApi, 'applyTransaction' | 'applyServerSideTransaction' | 'collapseAll' | 'deselectAll' | 'expandAll' | 'getColumnDefinitions' | 'getDetailGridTableApi' | 'getFilteredAndSortedRowNodes' | 'getRootAggregateData' | 'getRowData' | 'getSelectedRows' | 'getServerSideSelectionState' | 'getTableConfiguration' | 'refreshCells' | 'scrollToRow' | 'selectAll' | 'setPinnedBottomRowData' | 'setRowData' | 'setRowNodeExpanded' | 'sizeColumnsToFit'>;
+type PartialTableApi = Pick<TableApi, 'applyTransaction' | 'applyServerSideTransaction' | 'collapseAll' | 'deselectAll' | 'expandAll' | 'getColumnDefinitions' | 'getDetailGridTableApi' | 'getFilteredAndSortedRowNodes' | 'getVisibleRowNodes' | 'getRootAggregateData' | 'getRowData' | 'getSelectedRows' | 'getServerSideSelectionState' | 'getTableConfiguration' | 'refreshCells' | 'scrollToRow' | 'selectAll' | 'setPinnedBottomRowData' | 'setRowData' | 'setRowNodeExpanded' | 'sizeColumnsToFit'>;
 type AgDomLayout = 'normal' | 'autoHeight' | 'print' | undefined;
 interface IsRowSelectable {
     (node: RowNode): boolean;
@@ -989,6 +996,10 @@ interface TableProps<TRow = any, TBottomRow = any> {
     suppressResetColumnsOption?: boolean;
     suppressRowClickSelection?: boolean;
     stickyExpandedGroupRows?: boolean;
+    /**
+     * Allows overriding the default behaviour for when user hits Tab key when a cell is focused
+     */
+    tabToNextCell?: (params: TabToNextCellParams<any, any>) => CellPosition | null;
 }
 type AggregationFunction<TValue> = (params: {
     columnDefinition: ColumnDefinition;
@@ -1156,7 +1167,11 @@ interface IFilterProps<Opt = any, Val = number | string | null> {
         headerName: string;
         value: Val extends string ? string[] : Val extends number ? number[] : unknown[];
     }) => React.FunctionComponent | string;
-    getFilterOptions?: () => Promise<Opt[]>;
+    getFilterOptions?: (params?: {
+        currentOffset?: number;
+        searchQuery?: string;
+    }) => Promise<Opt[] | IFilterOptions<Opt>>;
+    onSearch?: (event: React.ChangeEvent<HTMLInputElement>) => void;
     getId?: (option: Opt) => Val extends string ? string : Val extends number ? number : unknown;
     getLabel?: (option: Opt) => string;
     groupName?: string;
@@ -1188,6 +1203,8 @@ interface FilterComponentProps<Opt = any, Val = Opt[] | NumberFilterModel> {
     getOptions?: () => Promise<boolean>;
     loading: boolean;
     onChange: (value: Opt[] | NumberFilterModel | undefined) => void;
+    onScrollBottom?: () => void;
+    onSearch?: (event: React.ChangeEvent<HTMLInputElement>) => void;
     onRemove: () => void;
     options: Opt[];
     value: Val;
@@ -1220,6 +1237,10 @@ interface IFilterState<Opt = any, Val = number | string> {
 interface IServerFiltersState {
     [field: string]: IFilterState;
 }
+interface IFilterOptions<UniversalOpt = any> {
+    options: UniversalOpt[];
+    totalOptions: number;
+}
 interface IFilterStorage<UniversalOpt = any, UniversalVal = number | string> {
     hasDefinedFilters: boolean;
     hasSelectedFilters: boolean;
@@ -1227,6 +1248,7 @@ interface IFilterStorage<UniversalOpt = any, UniversalVal = number | string> {
     getSelected: (field: string) => IFilterState<UniversalOpt, UniversalVal>;
     getListFilter: (field: string) => IFilterState<UniversalOpt, UniversalVal>;
     selectedFilters: IServerFiltersState;
+    getTotalOptions: (field: string) => number;
     onChangeFilterValue: ({ field, value, }: {
         field: string;
         value: any;
@@ -1235,7 +1257,7 @@ interface IFilterStorage<UniversalOpt = any, UniversalVal = number | string> {
     onClearAllFilters: React.MouseEventHandler<HTMLButtonElement>;
     possibleFilters: string[];
     setSelectedFilters: (filters: IServerFilter[]) => void;
-    waitForStoredOptions: (field: string) => Promise<void>;
+    waitForStoredOptions: (field: string, search?: string) => Promise<void>;
     filtersState: IServerFilter[];
 }