beautiful-grid 1.0.2 → 1.0.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "beautiful-grid",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "A beautiful, powerful, open-source React Data Grid.",
   "homepage": "https://bgrid.axisj.com",
   "bugs": {

package/types/BGrid.d.ts

@@ -1,3 +1,3 @@
 import * as React from 'react';
 import { BGridProps } from './types';
-export declare function BGrid<T = Record<string, any>>({ width, height, headerHeight, footerHeight, summaryHeight, itemHeight, itemPadding, columns, columnsGroup, columnGroups, onChangeColumns, frozenColumnIndex, frozenRowCount, data, page, scrollbar, status, pagination, bottomBarHeight, scrollTop, scrollLeft, className, style, rowChecked, sort, onClick, loading, spinning, rowKey, selectedRowKey, editable, onChangeData, showLineNumber, msg, getRowClassName, editTrigger, cellMergeOptions, cellSelectionOptions, cellNavigationOptions, variant, summary, columnSortable, reorder, pivot, dataControl, icons, searchOptions, contextMenuOptions, }: BGridProps<T>): React.JSX.Element;
+export declare function BGrid<T = Record<string, any>>({ ref, width, height, headerHeight, footerHeight, summaryHeight, itemHeight, itemPadding, columns, columnsGroup, columnGroups, onChangeColumns, frozenColumnIndex, frozenRowCount, data, page, scrollbar, status, pagination, bottomBarHeight, scrollTop, scrollLeft, className, style, rowChecked, sort, onClick, loading, spinning, rowKey, selectedRowKey, editable, onChangeData, showLineNumber, msg, getRowClassName, editTrigger, cellMergeOptions, cellSelectionOptions, cellNavigationOptions, variant, summary, columnSortable, reorder, pivot, dataControl, icons, searchOptions, contextMenuOptions, }: BGridProps<T>): React.JSX.Element;

package/types/components/Table.d.ts

@@ -2,6 +2,7 @@ import * as React from 'react';
 import { Key } from 'react';
 import { BGridCellNavigationOptions, AppModelColumn, BGridColumnGroup, BGridColumnGroupNode, BGridDataControl, BGridDataItem, BGridDataQuery, BGridPage, BGridProps, BGridRowChecked, BGridSortInfo, BGridSortParam, BGridResolvedScrollbarOptions, BGridResolvedStatusOptions, BGridResolvedPaginationViewOptions } from '../types';
 interface Props<T> {
+    ref?: BGridProps<T>['ref'];
     width?: number;
     height?: number;
     headerHeight?: number;

package/types/components/selection/CellSelectionOverlay.d.ts

@@ -12,6 +12,7 @@ interface Props {
         width: number;
         height: number;
     };
+    offsetTop?: number;
 }
 export declare function CellSelectionOverlay(props: Props): React.JSX.Element;
 export {};

package/types/components/selection/CellSelectionOverlayLayer.d.ts

@@ -13,6 +13,7 @@ interface Props {
     activeFill: boolean;
     activeRing: boolean;
     viewport: SelectionViewport;
+    offsetTop?: number;
 }
-export declare function CellSelectionOverlayLayer({ quadrant, selectionFragments, activeFragments, activeFill, activeRing, viewport, }: Props): React.JSX.Element | null;
+export declare function CellSelectionOverlayLayer({ quadrant, selectionFragments, activeFragments, activeFill, activeRing, viewport, offsetTop, }: Props): React.JSX.Element | null;
 export {};

package/types/types.d.ts

@@ -619,7 +619,20 @@ export interface BGridResolvedStatusOptions extends BGridStatusOptions {
     configured: boolean;
 }
 export type BGridResolvedPaginationViewOptions = Required<Pick<BGridPaginationViewOptions, 'visible'>> & Omit<BGridPaginationViewOptions, 'visible'>;
+export interface BGridScrollToRowOptions {
+    /** Defaults to nearest: scroll only as far as needed to reveal the row. */
+    align?: 'start' | 'center' | 'end' | 'nearest';
+}
+export interface BGridRef {
+    /**
+     * Reveal a zero-based row in the displayed (sorted/filtered) data on the current page.
+     * Runs after pending data updates. Invalid indexes and frozen rows are ignored.
+     * Preserves horizontal scroll, cell focus and selection; does not load other pages.
+     */
+    scrollToRow: (rowIndex: number, options?: BGridScrollToRowOptions) => void;
+}
 export interface BGridProps<T> {
+    ref?: React.Ref<BGridRef>;
     width: number;
     height: number;
     headerHeight?: number;

package/types/utils/coordinate.d.ts

@@ -12,6 +12,10 @@ export interface EnsureCellVisibleParams {
     frozenRowCount?: number;
     columns: AppModelColumn<any>[];
     rowHeight: number;
+    verticalScrollState?: {
+        scrollTop: number;
+        scrollHeight: number;
+    };
     viewportInsets?: {
         top?: number;
         right?: number;
@@ -26,4 +30,4 @@ export interface EnsureCellVisibleResult {
     didScrollTop: boolean;
     didScrollLeft: boolean;
 }
-export declare function ensureCellVisible({ cell, scrollContainer, frozenColumnCount, frozenRowCount, columns, rowHeight, viewportInsets, }: EnsureCellVisibleParams): EnsureCellVisibleResult;
+export declare function ensureCellVisible({ cell, scrollContainer, frozenColumnCount, frozenRowCount, columns, rowHeight, verticalScrollState, viewportInsets, }: EnsureCellVisibleParams): EnsureCellVisibleResult;

package/types/utils/index.d.ts

@@ -15,6 +15,7 @@ export * from './scrollbar';
 export * from './number';
 export * from './buildHeaderMatrix';
 export * from './getVisibleScrollableRowRange';
+export * from './virtualScrollWindow';
 export * from './cellEditState';
 export * from './getCellSelectionAxisState';
 export * from './mergedCells';

package/types/utils/virtualScrollWindow.d.ts

@@ -0,0 +1,24 @@
+export declare const BGRID_MAX_PHYSICAL_SCROLL_HEIGHT = 1000000;
+export interface VirtualScrollWindowMetrics {
+    enabled: boolean;
+    logicalContentHeight: number;
+    physicalContentHeight: number;
+    logicalMaxScroll: number;
+    physicalMaxScroll: number;
+}
+interface GetVirtualScrollWindowMetricsParams {
+    logicalContentHeight: number;
+    viewportHeight: number;
+    enabled: boolean;
+    maxPhysicalHeight?: number;
+}
+export interface VirtualScrollWindowPosition {
+    base: number;
+    physicalScrollTop: number;
+    logicalScrollTop: number;
+}
+export declare function getVirtualScrollWindowMetrics({ logicalContentHeight, viewportHeight, enabled, maxPhysicalHeight, }: GetVirtualScrollWindowMetricsParams): VirtualScrollWindowMetrics;
+export declare function getLogicalScrollTop(base: number, physicalScrollTop: number, metrics: VirtualScrollWindowMetrics): number;
+export declare function getVirtualScrollWindowPosition(logicalScrollTop: number, metrics: VirtualScrollWindowMetrics): VirtualScrollWindowPosition;
+export declare function rebaseVirtualScrollWindow(base: number, physicalScrollTop: number, metrics: VirtualScrollWindowMetrics): VirtualScrollWindowPosition;
+export {};