@dxos/react-ui-mosaic 0.9.1-staging.ee54ba693a → 0.11.0

package/dist/types/src/hooks/useVirtualizerPagination.d.ts

@@ -0,0 +1,60 @@
+import { type Virtualizer } from '@tanstack/react-virtual';
+import { type GetId } from '@dxos/react-ui-dnd';
+export type VirtualizerPaginationController = {
+    /** Requests the next (e.g. older) page. Omit to disable the bottom-edge trigger. */
+    getNext?: () => void;
+    /** Requests the previous (e.g. newer) page. Omit to disable the top-edge trigger. */
+    getPrevious?: () => void;
+    /** When true, suppresses the top-edge trigger (window is anchored at the live head). */
+    atHead?: boolean;
+    /** When true, suppresses both edge triggers while a page is in flight. */
+    isLoading?: boolean;
+};
+export type UseVirtualizerPaginationProps<TItem = any> = {
+    /** Currently loaded window, in the order rendered by the virtualizer. */
+    items: readonly TItem[] | TItem[] | undefined;
+    /** ID getter, aligned with the virtualizer's own `getId`/`getItemKey`. */
+    getId: GetId<TItem>;
+    /** Load-next/load-previous callbacks. Both edges are inert while omitted. */
+    pagination?: VirtualizerPaginationController;
+    /** Rows from either loaded edge at which the adjacent page is requested. @default 12. */
+    threshold?: number;
+};
+export type UseVirtualizerPaginationResult = {
+    onChange: (virtualizer: Virtualizer<any, any>) => void;
+    /** Extra scrollable space (px) to feed into the virtualizer's `paddingStart`. */
+    leadingSpace: number;
+};
+/**
+ * Wires a paginated data source into a `Mosaic.VirtualStack`: requests the next/previous page near
+ * either loaded edge (`evaluateTriggers`), and keeps the scrollbar stable across the resulting
+ * `items` change by maintaining a leading spacer instead of rewriting the scroll offset.
+ *
+ * Called internally by `Mosaic.VirtualStack` when its `pagination` prop is set -- not normally
+ * called directly.
+ *
+ * `@tanstack/react-virtual` recomputes every item's pixel offset from the current array on each
+ * render, with no compensation for insertion/removal at the front -- rewriting the scroll offset
+ * to chase that shift visibly jumps the scrollbar thumb. Instead, `leadingSpace` (fed back into
+ * `paddingStart`) grows by exactly the evicted height and shrinks by exactly the prepended height,
+ * so retained items keep their absolute position and the thumb only scales as the total grows.
+ *
+ * Eviction (`classifyFrontEdgeChange`'s `'evicted'`) is corrected synchronously during the same
+ * render that observes the new `items`, since the evicted height is already known -- deferring it
+ * would let the browser observe (and clamp `scrollTop` against) a momentary, too-short frame.
+ * Prepending (`'prepended'`) is corrected one render later, from a layout effect
+ * (`computePrependCorrection`), since the prepended items' heights aren't known until the incoming
+ * render measures them; that lag is safe because prepending only ever grows content before the
+ * spacer shrinks to match.
+ *
+ * The layout effect also re-runs `evaluateTriggers` on every `items` change, evicted/appended or
+ * prepended alike -- `@tanstack/react-virtual` only calls `onChange` when the visible range (or
+ * `isScrolling`) changes, not merely when `items` does. Once the loaded window's tail is already
+ * fully rendered and the scrollbar sits at its physical max, further scrolling can't move that
+ * range at all, so `onChange` stops firing -- relying on it alone would permanently stall a
+ * `getNext` chain right after its own page lands, before the user scrolls again.
+ *
+ * Assumes the stack renders with `draggable={false}` (virtual indices map 1:1 onto `items`).
+ */
+export declare const useVirtualizerPagination: <TItem = any>({ items, getId, pagination, threshold, }: UseVirtualizerPaginationProps<TItem>) => UseVirtualizerPaginationResult;
+//# sourceMappingURL=useVirtualizerPagination.d.ts.map

package/dist/types/src/hooks/useVirtualizerPagination.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useVirtualizerPagination.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useVirtualizerPagination.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAG3D,OAAO,EAAE,KAAK,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAehD,MAAM,MAAM,+BAA+B,GAAG;IAC5C,oFAAoF;IACpF,OAAO,CAAC,EAAE,MAAM,IAAI,CAAC;IACrB,qFAAqF;IACrF,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IACzB,wFAAwF;IACxF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,0EAA0E;IAC1E,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,6BAA6B,CAAC,KAAK,GAAG,GAAG,IAAI;IACvD,yEAAyE;IACzE,KAAK,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,EAAE,GAAG,SAAS,CAAC;IAE9C,0EAA0E;IAC1E,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAEpB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,+BAA+B,CAAC;IAE7C,yFAAyF;IACzF,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,8BAA8B,GAAG;IAC3C,QAAQ,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,KAAK,IAAI,CAAC;IACvD,iFAAiF;IACjF,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AA8QF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,eAAO,MAAM,wBAAwB,GAAI,KAAK,GAAG,GAAG,4CAKjD,6BAA6B,CAAC,KAAK,CAAC,KAAG,8BAmHzC,CAAC"}

package/dist/types/src/hooks/useVirtualizerPagination.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=useVirtualizerPagination.test.d.ts.map

package/dist/types/src/hooks/useVirtualizerPagination.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useVirtualizerPagination.test.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useVirtualizerPagination.test.tsx"],"names":[],"mappings":""}

package/dist/types/src/hooks/useVisibleItems.d.ts

@@ -1,11 +1,11 @@
-import { type GetId, type MosaicTileData } from '../components';
+import { type DndTileData, type GetId } from '@dxos/react-ui-dnd';
 export type UseVisibleItemsProps<TItem = any> = {
     /** Container id. */
     id: string;
     /** Current items. */
     items?: readonly TItem[] | TItem[];
     /** Currently dragging item. */
-    dragging: MosaicTileData<TItem> | undefined;
+    dragging: DndTileData<TItem> | undefined;
     /** ID getter */
     getId: GetId<TItem>;
 };

package/dist/types/src/hooks/useVisibleItems.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useVisibleItems.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useVisibleItems.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,cAAc,EAAE,MAAM,eAAe,CAAC;AAEhE,MAAM,MAAM,oBAAoB,CAAC,KAAK,GAAG,GAAG,IAAI;IAC9C,oBAAoB;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,qBAAqB;IACrB,KAAK,CAAC,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC;IAEnC,+BAA+B;IAC/B,QAAQ,EAAE,cAAc,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAE5C,gBAAgB;IAChB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,GAAI,KAAK,GAAG,GAAG,mCAKxC,oBAAoB,CAAC,KAAK,CAAC,KAAG,SAAS,KAAK,EAAE,GAAG,KAAK,EAiBxD,CAAC"}
+{"version":3,"file":"useVisibleItems.d.ts","sourceRoot":"","sources":["../../../../src/hooks/useVisibleItems.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAElE,MAAM,MAAM,oBAAoB,CAAC,KAAK,GAAG,GAAG,IAAI;IAC9C,oBAAoB;IACpB,EAAE,EAAE,MAAM,CAAC;IAEX,qBAAqB;IACrB,KAAK,CAAC,EAAE,SAAS,KAAK,EAAE,GAAG,KAAK,EAAE,CAAC;IAEnC,+BAA+B;IAC/B,QAAQ,EAAE,WAAW,CAAC,KAAK,CAAC,GAAG,SAAS,CAAC;IAEzC,gBAAgB;IAChB,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,GAAI,KAAK,GAAG,GAAG,mCAKxC,oBAAoB,CAAC,KAAK,CAAC,KAAG,SAAS,KAAK,EAAE,GAAG,KAAK,EAiBxD,CAAC"}