@infinite-table/infinite-react 0.5.3 → 0.6.1

package/index.d.ts

@@ -157,6 +157,7 @@ declare type InfiniteTableColumnHeaderParam<DATA_TYPE, COL_TYPE = InfiniteTableC
     someRowsSelected: boolean;
     api: InfiniteTableApi<DATA_TYPE>;
     renderBag: {
+        all?: Renderable;
         header: string | number | Renderable;
         sortIcon?: Renderable;
         menuIcon?: Renderable;
@@ -166,6 +167,7 @@ declare type InfiniteTableColumnHeaderParam<DATA_TYPE, COL_TYPE = InfiniteTableC
 declare type InfiniteTableColumnRenderBag = {
     value: string | number | Renderable;
     groupIcon?: Renderable;
+    all?: Renderable;
     selectionCheckBox?: Renderable;
 };
 declare type InfiniteTableColumnRenderParamBase<DATA_TYPE, COL_TYPE = InfiniteTableComputedColumn<DATA_TYPE>> = {
@@ -211,6 +213,14 @@ declare type InfiniteTableColumnRenderFunctionForNormalRows<DATA_TYPE, COL_TYPE
 }) => Renderable | null;
 declare type InfiniteTableColumnRenderFunction<DATA_TYPE, COL_TYPE = InfiniteTableComputedColumn<DATA_TYPE>> = (renderParams: InfiniteTableColumnRenderParam<DATA_TYPE, COL_TYPE>) => Renderable | null;
 declare type InfiniteTableColumnHeaderRenderFunction<T> = (headerParams: InfiniteTableColumnHeaderParam<T>) => Renderable;
+declare type InfiniteTableColumnContentFocusable<T> = boolean | InfiniteTableColumnContentFocusableFn<T>;
+declare type InfiniteTableColumnEditable<T> = boolean | InfiniteTableColumnEditableFn<T>;
+declare type InfiniteTableColumnContentFocusableFn<T> = (params: InfiniteTableColumnContentFocusableParams<T>) => boolean;
+declare type InfiniteTableColumnEditableFn<T> = (params: InfiniteTableColumnEditableParams<T>) => boolean;
+declare type InfiniteTableColumnContentFocusableParams<T> = InfiniteTableColumnValueFormatterParams<T> & {
+    column: InfiniteTableComputedColumn<T>;
+};
+declare type InfiniteTableColumnEditableParams<T> = InfiniteTableColumnContentFocusableParams<T>;
 declare type InfiniteTableColumnAlign = 'start' | 'center' | 'end';
 declare type InfiniteTableColumnVerticalAlign = 'start' | 'center' | 'end';
 declare type InfiniteTableColumnHeader<T> = Renderable | InfiniteTableColumnHeaderRenderFunction<T>;
@@ -248,11 +258,14 @@ declare type InfiniteTableColumn<DATA_TYPE> = {
     sortable?: boolean;
     draggable?: boolean;
     resizable?: boolean;
+    contentFocusable?: InfiniteTableColumnContentFocusable<DATA_TYPE>;
+    editable?: InfiniteTableColumnEditable<DATA_TYPE>;
     comparer?: InfiniteTableColumnComparer<DATA_TYPE>;
     defaultHiddenWhenGroupedBy?: '*' | true | keyof DATA_TYPE | {
         [k in keyof Partial<DATA_TYPE>]: true;
     };
     align?: InfiniteTableColumnAlign;
+    headerAlign?: InfiniteTableColumnAlign;
     verticalAlign?: InfiniteTableColumnVerticalAlign;
     columnGroup?: string;
     header?: InfiniteTableColumnHeader<DATA_TYPE>;
@@ -936,12 +949,14 @@ declare class ScrollListener {
 
 interface InfiniteTableSetupState<T> {
     renderer: ReactHeadlessTableRenderer;
+    getDOMNodeForCell: (cellPos: CellPosition) => HTMLElement | null;
     onRenderUpdater: SubscriptionCallback<Renderable>;
     propsCache: Map<keyof InfiniteTableProps<T>, WeakMap<any, any>>;
     columnsWhenInlineGroupRenderStrategy?: Map<string, InfiniteTableColumn<T>>;
     domRef: MutableRefObject<HTMLDivElement | null>;
     scrollerDOMRef: MutableRefObject<HTMLDivElement | null>;
     portalDOMRef: MutableRefObject<HTMLDivElement | null>;
+    focusDetectDOMRef: MutableRefObject<HTMLDivElement | null>;
     activeCellIndicatorDOMRef: MutableRefObject<HTMLDivElement | null>;
     onRowHeightCSSVarChange: SubscriptionCallback<number>;
     onColumnMenuClick: SubscriptionCallback<{
@@ -979,6 +994,8 @@ interface InfiniteTableMappedState<T> {
     viewportReservedWidth: InfiniteTableProps<T>['viewportReservedWidth'];
     resizableColumns: InfiniteTableProps<T>['resizableColumns'];
     groupColumn: InfiniteTableProps<T>['groupColumn'];
+    onKeyDown: InfiniteTableProps<T>['onKeyDown'];
+    onCellClick: InfiniteTableProps<T>['onCellClick'];
     headerOptions: NonUndefined<InfiniteTableProps<T>['headerOptions']>;
     onScrollbarsChange: InfiniteTableProps<T>['onScrollbarsChange'];
     getColumContextMenuItems: InfiniteTableProps<T>['getColumContextMenuItems'];
@@ -1179,6 +1196,7 @@ interface DataSourceMappedState<T> {
     aggregationReducers?: DataSourceProps<T>['aggregationReducers'];
     livePagination: DataSourceProps<T>['livePagination'];
     isRowSelected: DataSourceProps<T>['isRowSelected'];
+    onDataArrayChange: DataSourceProps<T>['onDataArrayChange'];
     lazyLoad: DataSourceProps<T>['lazyLoad'];
     useGroupKeysForMultiRowSelection: NonUndefined<DataSourceProps<T>['useGroupKeysForMultiRowSelection']>;
     onDataParamsChange: DataSourceProps<T>['onDataParamsChange'];
@@ -1239,6 +1257,8 @@ interface DataSourceSetupState<T> {
     indexer: Indexer<T, any>;
     unfilteredCount: number;
     filteredCount: number;
+    originalDataArrayChanged: boolean;
+    originalDataArrayChangedAt: number;
     lazyLoadCacheOfLoadedBatches: DeepMap<string, true>;
     pivotMappings?: DataSourceMappings;
     propsCache: Map<keyof DataSourceProps<T>, WeakMap<any, any>>;
@@ -1322,6 +1342,7 @@ declare type DataSourceProps<T> = {
     defaultSortInfo?: DataSourceSortInfo<T>;
     onSortInfoChange?: ((sortInfo: DataSourceSingleSortInfo<T> | null) => void) | ((sortInfo: DataSourceSingleSortInfo<T>[]) => void);
     onDataParamsChange?: (dataParamsChange: DataSourceDataParams<T>) => void;
+    onDataArrayChange?: (dataArray: DataSourceState<T>['originalDataArray']) => void;
     livePagination?: boolean;
     livePaginationCursor?: DataSourcePropLivePaginationCursor<T>;
     onLivePaginationCursorChange?: (livePaginationCursor: DataSourceLivePaginationCursorValue) => void;
@@ -1913,6 +1934,23 @@ declare type MenuColumnRenderParam = {
     domProps: HTMLProps<HTMLDivElement>;
 };
 
+declare type InfiniteTableEventHandlerContext<T> = {
+    getComputed: () => InfiniteTableComputedValues<T>;
+    getState: () => InfiniteTableState<T>;
+    actions: InfiniteTableActions<T>;
+    cloneRowSelection: (rowSelection: RowSelectionState<T>) => RowSelectionState<T>;
+    getDataSourceState: () => DataSourceState<T>;
+    dataSourceActions: DataSourceComponentActions<T>;
+    api: InfiniteTableApi<T>;
+};
+declare type InfiniteTableKeyboardEventHandlerContext<T> = InfiniteTableEventHandlerContext<T>;
+declare type InfiniteTableCellClickEventHandlerContext<T> = InfiniteTableEventHandlerContext<T> & {
+    rowIndex: number;
+    colIndex: number;
+};
+
+declare type OnCellClickContext<T> = InfiniteTableCellClickEventHandlerContext<T> & InfiniteTableKeyboardEventHandlerContext<T>;
+
 declare type LoadMaskProps = {
     visible: boolean;
     children: Renderable;
@@ -1951,6 +1989,8 @@ declare type InfiniteTableColumnType<T> = {
     resizable?: InfiniteTableColumn<T>['resizable'];
     align?: InfiniteTableColumn<T>['align'];
     verticalAlign?: InfiniteTableColumn<T>['verticalAlign'];
+    contentFocusable?: InfiniteTableColumn<T>['contentFocusable'];
+    editable?: InfiniteTableColumn<T>['editable'];
     columnGroup?: string;
     cssEllipsis?: boolean;
     headerCssEllipsis?: boolean;
@@ -2111,6 +2151,27 @@ interface InfiniteTableProps<T> {
     rowStyle?: InfiniteTablePropRowStyle<T>;
     rowClassName?: InfiniteTablePropRowClassName<T>;
     columnHeaderHeight: number | string;
+    onKeyDown?: (context: {
+        api: InfiniteTableEventHandlerContext<T>['api'];
+        getState: InfiniteTableEventHandlerContext<T>['getState'];
+        getDataSourceState: InfiniteTableEventHandlerContext<T>['getDataSourceState'];
+        actions: InfiniteTableEventHandlerContext<T>['actions'];
+    }, event: React$1.KeyboardEvent) => void;
+    onCellClick?: (context: {
+        rowIndex: OnCellClickContext<T>['rowIndex'];
+        colIndex: OnCellClickContext<T>['colIndex'];
+        api: OnCellClickContext<T>['api'];
+        getState: OnCellClickContext<T>['getState'];
+        getDataSourceState: OnCellClickContext<T>['getDataSourceState'];
+        actions: OnCellClickContext<T>['actions'];
+    }, event: React$1.MouseEvent) => void;
+    /**
+     * Properties to be sent directly to the DOM element underlying InfiniteTable.
+     *
+     * Useful for passing a className or style and any other event handlers. For more context
+     * on some event handlers (eg: onKeyDown), you might want to use dedicated props that give you access
+     * to component state as well.
+     */
     domProps?: React$1.HTMLProps<HTMLDivElement>;
     /**
      * A unique identifier for the table instance. Will not be passed to the DOM.