@homebound/beam 2.371.0 → 2.371.1

package/dist/components/Table/GridTableApi.d.ts

@@ -1,6 +1,6 @@
 import { MutableRefObject } from "react";
 import { VirtuosoHandle } from "react-virtuoso";
-import { GridRowLookup, MaybeFn } from "../index";
+import { GridRowLookup, GridTableScrollOptions, MaybeFn } from "../index";
 import { GridDataRow } from "./components/Row";
 import { DiscriminateUnion, Kinded } from "./types";
 import { TableState } from "./utils/TableState";
@@ -22,8 +22,11 @@ import { TableState } from "./utils/TableState";
 export declare function useGridTableApi<R extends Kinded>(): GridTableApi<R>;
 /** Provides an imperative API for an application page to interact with the table. */
 export type GridTableApi<R extends Kinded> = {
-    /** Scrolls row `index` into view; only supported with `as=virtual` and after a `useEffect`. */
-    scrollToIndex(index: number): void;
+    /** Scrolls row `index` into view;  only supported with `as=virtual` and after a `useEffect`.
+     *
+     * Defaults "smooth" behavior; Use {index, behavior: "auto"} for instant scroll in cases where grid table has many, many records and the scroll effect is undesirable.
+     * */
+    scrollToIndex(index: GridTableScrollOptions): void;
     /** Returns the currently-visible rows. */
     getVisibleRows(): GridDataRow<R>[];
     /** Returns the currently-visible rows of the given `kind`. */
@@ -78,7 +81,7 @@ export declare class GridTableApiImpl<R extends Kinded> implements GridTableApi<
     constructor();
     /** Called once by the GridTable when it takes ownership of this api instance. */
     init(persistCollapse: string | undefined, virtuosoRef: MutableRefObject<VirtuosoHandle | null>): void;
-    scrollToIndex(index: number): void;
+    scrollToIndex(index: GridTableScrollOptions): void;
     getSelectedRowIds(kind?: string): string[];
     private getSelectedRowIdsImpl;
     getSelectedRows(kind?: string): any;

package/dist/components/Table/GridTableApi.js

@@ -50,7 +50,8 @@ class GridTableApiImpl {
         this.lookup = (0, index_1.createRowLookup)(this, virtuosoRef);
     }
     scrollToIndex(index) {
-        this.virtuosoRef.current && this.virtuosoRef.current.scrollToIndex(index);
+        this.virtuosoRef.current &&
+            this.virtuosoRef.current.scrollToIndex(typeof index === "number" ? { index, behavior: "smooth" } : index);
     }
     getSelectedRowIds(kind) {
         return this.getSelectedRowIdsImpl(kind !== null && kind !== void 0 ? kind : undefined);

package/dist/components/Table/types.d.ts

@@ -11,6 +11,15 @@ export type RenderAs = "div" | "table" | "virtual";
 export type Direction = "ASC" | "DESC";
 export type MaybeFn<T> = T | (() => T);
 export type GridCellAlignment = "left" | "right" | "center";
+export type GridTableScrollOptions = number | {
+    /** The index of the row to scroll to */
+    index: number;
+    behavior?: "auto" | "smooth";
+    /**
+     * How to position the row in the viewport
+     */
+    align?: "start" | "center" | "end";
+};
 /**
  * Given an ADT of type T, performs a look up and returns the type of kind K.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homebound/beam",
-  "version": "2.371.0",
+  "version": "2.371.1",
   "author": "Homebound",
   "license": "MIT",
   "main": "dist/index.js",