@react-stately/virtualizer 4.1.0 → 4.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@react-stately/virtualizer",
-  "version": "4.1.0",
+  "version": "4.2.1",
   "description": "Spectrum UI components in React",
   "license": "Apache-2.0",
   "main": "dist/main.js",
@@ -22,14 +22,16 @@
     "url": "https://github.com/adobe/react-spectrum"
   },
   "dependencies": {
-    "@react-aria/utils": "^3.25.3",
-    "@react-types/shared": "^3.25.0",
+    "@react-aria/utils": "^3.27.0",
+    "@react-types/shared": "^3.27.0",
     "@swc/helpers": "^0.5.0"
   },
   "peerDependencies": {
-    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0"
+    "react": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1",
+    "react-dom": "^16.8.0 || ^17.0.0-rc.1 || ^18.0.0 || ^19.0.0-rc.1"
   },
   "publishConfig": {
     "access": "public"
-  }
-}
+  },
+  "gitHead": "09e7f44bebdc9d89122926b2b439a0a38a2814ea"
+}

package/src/Layout.ts

@@ -32,7 +32,7 @@ import {Virtualizer} from './Virtualizer';
  */
 export abstract class Layout<T extends object, O = any> implements LayoutDelegate {
   /** The Virtualizer the layout is currently attached to. */
-  virtualizer: Virtualizer<T, any>;
+  virtualizer: Virtualizer<T, any> | null = null;
 
   /**
    * Returns whether the layout should invalidate in response to
@@ -83,11 +83,11 @@ export abstract class Layout<T extends object, O = any> implements LayoutDelegat
    */
   getDropTargetLayoutInfo?(target: ItemDropTarget): LayoutInfo;
 
-  getItemRect(key: Key): Rect {
-    return this.getLayoutInfo(key)?.rect;
+  getItemRect(key: Key): Rect | null {
+    return this.getLayoutInfo(key)?.rect ?? null;
   }
 
   getVisibleRect(): Rect {
-    return this.virtualizer.visibleRect;
+    return this.virtualizer!.visibleRect;
   }
 }

package/src/ReusableView.ts

@@ -28,23 +28,25 @@ export class ReusableView<T extends object, V> {
   layoutInfo: LayoutInfo | null;
 
   /** The content currently being displayed by this view, set by the virtualizer. */
-  content: T;
+  content: T | null;
 
-  rendered: V;
+  rendered: V | null;
 
   viewType: string;
   key: Key;
 
-  parent: ReusableView<T, V> | null;
-  children: Set<ReusableView<T, V>>;
-  reusableViews: Map<string, ReusableView<T, V>[]>;
+  children: Set<ChildView<T, V>>;
+  reusableViews: Map<string, ChildView<T, V>[]>;
 
-  constructor(virtualizer: Virtualizer<T, V>) {
+  constructor(virtualizer: Virtualizer<T, V>, viewType: string) {
     this.virtualizer = virtualizer;
     this.key = ++KEY;
-    this.parent = null;
+    this.viewType = viewType;
     this.children = new Set();
     this.reusableViews = new Map();
+    this.layoutInfo = null;
+    this.content = null;
+    this.rendered = null;
   }
 
   /**
@@ -62,16 +64,14 @@ export class ReusableView<T extends object, V> {
     // The cells within a row are removed from their parent in order. If the row is reused, the cells
     // should be reused in the new row in the same order they were before.
     let reusable = this.reusableViews.get(reuseType);
-    let view = reusable?.length > 0
-      ? reusable.shift()
-      : new ReusableView<T, V>(this.virtualizer);
+    let view = reusable && reusable.length > 0
+      ? reusable.shift()!
+      : new ChildView<T, V>(this.virtualizer, this, reuseType);
 
-    view.viewType = reuseType;
-    view.parent = this;
     return view;
   }
 
-  reuseChild(child: ReusableView<T, V>) {
+  reuseChild(child: ChildView<T, V>) {
     child.prepareForReuse();
     let reusable = this.reusableViews.get(child.viewType);
     if (!reusable) {
@@ -81,3 +81,18 @@ export class ReusableView<T extends object, V> {
     reusable.push(child);
   }
 }
+
+export class RootView<T extends object, V> extends ReusableView<T, V> {
+  constructor(virtualizer: Virtualizer<T, V>) {
+    super(virtualizer, 'root');
+  }
+}
+
+export class ChildView<T extends object, V> extends ReusableView<T, V> {
+  parent: ReusableView<T, V>;
+
+  constructor(virtualizer: Virtualizer<T, V>, parent: ReusableView<T, V>, viewType: string) {
+    super(virtualizer, viewType);
+    this.parent = parent;
+  }
+}

package/src/Virtualizer.ts

@@ -10,6 +10,7 @@
  * governing permissions and limitations under the License.
  */
 
+import {ChildView, ReusableView, RootView} from './ReusableView';
 import {Collection, Key} from '@react-types/shared';
 import {InvalidationContext, Mutable, VirtualizerDelegate, VirtualizerRenderOptions} from './types';
 import {isSetEqual} from './utils';
@@ -18,9 +19,14 @@ import {LayoutInfo} from './LayoutInfo';
 import {OverscanManager} from './OverscanManager';
 import {Point} from './Point';
 import {Rect} from './Rect';
-import {ReusableView} from './ReusableView';
 import {Size} from './Size';
 
+interface VirtualizerOptions<T extends object, V> {
+  delegate: VirtualizerDelegate<T, V>,
+  collection: Collection<T>,
+  layout: Layout<T>
+}
+
 /**
  * The Virtualizer class renders a scrollable collection of data using customizable layouts.
  * It supports very large collections by only rendering visible views to the DOM, reusing
@@ -55,23 +61,25 @@ export class Virtualizer<T extends object, V> {
   /** The set of persisted keys that are always present in the DOM, even if not currently in view. */
   readonly persistedKeys: Set<Key>;
 
-  private _visibleViews: Map<Key, ReusableView<T, V>>;
+  private _visibleViews: Map<Key, ChildView<T, V>>;
   private _renderedContent: WeakMap<T, V>;
-  private _rootView: ReusableView<T, V>;
+  private _rootView: RootView<T, V>;
   private _isScrolling: boolean;
-  private _invalidationContext: InvalidationContext | null;
+  private _invalidationContext: InvalidationContext;
   private _overscanManager: OverscanManager;
 
-  constructor(delegate: VirtualizerDelegate<T, V>) {
-    this.delegate = delegate;
+  constructor(options: VirtualizerOptions<T, V>) {
+    this.delegate = options.delegate;
+    this.collection = options.collection;
+    this.layout = options.layout;
     this.contentSize = new Size;
     this.visibleRect = new Rect;
     this.persistedKeys = new Set();
     this._visibleViews = new Map();
     this._renderedContent = new WeakMap();
-    this._rootView = new ReusableView(this);
+    this._rootView = new RootView(this);
     this._isScrolling = false;
-    this._invalidationContext = null;
+    this._invalidationContext = {};
     this._overscanManager = new OverscanManager();
   }
 
@@ -86,7 +94,7 @@ export class Virtualizer<T extends object, V> {
     for (let k of this.persistedKeys) {
       while (k != null) {
         let layoutInfo = this.layout.getLayoutInfo(k);
-        if (!layoutInfo) {
+        if (!layoutInfo || layoutInfo.parentKey == null) {
           break;
         }
 
@@ -105,7 +113,7 @@ export class Virtualizer<T extends object, V> {
     return layoutInfo.parentKey != null ? this._visibleViews.get(layoutInfo.parentKey) : this._rootView;
   }
 
-  private getReusableView(layoutInfo: LayoutInfo): ReusableView<T, V> {
+  private getReusableView(layoutInfo: LayoutInfo): ChildView<T, V> {
     let parentView = this.getParentView(layoutInfo)!;
     let view = parentView.getReusableView(layoutInfo.type);
     view.layoutInfo = layoutInfo;
@@ -114,13 +122,15 @@ export class Virtualizer<T extends object, V> {
   }
 
   private _renderView(reusableView: ReusableView<T, V>) {
-    let {type, key, content} = reusableView.layoutInfo;
-    reusableView.content = content || this.collection.getItem(key);
-    reusableView.rendered = this._renderContent(type, reusableView.content);
+    if (reusableView.layoutInfo) {
+      let {type, key, content} = reusableView.layoutInfo;
+      reusableView.content = content || this.collection.getItem(key);
+      reusableView.rendered = this._renderContent(type, reusableView.content);
+    }
   }
 
-  private _renderContent(type: string, content: T) {
-    let cached = this._renderedContent.get(content);
+  private _renderContent(type: string, content: T | null) {
+    let cached = content != null ? this._renderedContent.get(content) : null;
     if (cached != null) {
       return cached;
     }
@@ -196,7 +206,7 @@ export class Virtualizer<T extends object, V> {
   private updateSubviews() {
     let visibleLayoutInfos = this.getVisibleLayoutInfos();
 
-    let removed = new Set<ReusableView<T, V>>();
+    let removed = new Set<ChildView<T, V>>();
     for (let [key, view] of this._visibleViews) {
       let layoutInfo = visibleLayoutInfos.get(key);
       // If a view's parent changed, treat it as a delete and re-create in the new parent.
@@ -219,7 +229,9 @@ export class Virtualizer<T extends object, V> {
 
         let item = this.collection.getItem(layoutInfo.key);
         if (view.content !== item) {
-          this._renderedContent.delete(view.content);
+          if (view.content != null) {
+            this._renderedContent.delete(view.content);
+          }
           this._renderView(view);
         }
       }
@@ -261,7 +273,7 @@ export class Virtualizer<T extends object, V> {
       needsLayout = true;
     }
 
-    if (opts.layout !== this.layout) {
+    if (opts.layout !== this.layout || this.layout.virtualizer !== this) {
       if (this.layout) {
         this.layout.virtualizer = null;
       }

package/src/types.ts

@@ -24,14 +24,14 @@ export interface InvalidationContext<O = any> {
 
 export interface VirtualizerDelegate<T extends object, V> {
   setVisibleRect(rect: Rect): void,
-  renderView(type: string, content: T): V,
+  renderView(type: string, content: T | null): V,
   invalidate(ctx: InvalidationContext): void
 }
 
 export interface VirtualizerRenderOptions<T extends object, O = any> {
   layout: Layout<T>,
   collection: Collection<T>,
-  persistedKeys?: Set<Key>,
+  persistedKeys?: Set<Key> | null,
   visibleRect: Rect,
   invalidationContext: InvalidationContext,
   isScrolling: boolean,

package/src/useVirtualizerState.ts

@@ -21,7 +21,7 @@ import {useLayoutEffect} from '@react-aria/utils';
 import {Virtualizer} from './Virtualizer';
 
 interface VirtualizerProps<T extends object, V, O> {
-  renderView(type: string, content: T): V,
+  renderView(type: string, content: T | null): V,
   layout: Layout<T>,
   collection: Collection<T>,
   onVisibleRectChange(rect: Rect): void,
@@ -45,13 +45,17 @@ export function useVirtualizerState<T extends object, V, O = any>(opts: Virtuali
   let [invalidationContext, setInvalidationContext] = useState<InvalidationContext>({});
   let visibleRectChanged = useRef(false);
   let [virtualizer] = useState(() => new Virtualizer<T, V>({
-    setVisibleRect(rect) {
-      setVisibleRect(rect);
-      visibleRectChanged.current = true;
-    },
-    // TODO: should changing these invalidate the entire cache?
-    renderView: opts.renderView,
-    invalidate: setInvalidationContext
+    collection: opts.collection,
+    layout: opts.layout,
+    delegate: {
+      setVisibleRect(rect) {
+        setVisibleRect(rect);
+        visibleRectChanged.current = true;
+      },
+      // TODO: should changing these invalidate the entire cache?
+      renderView: opts.renderView,
+      invalidate: setInvalidationContext
+    }
   }));
 
   // onVisibleRectChange must be called from an effect, not during render.