@react-aria/virtualizer 4.0.4 → 4.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -12,8 +12,8 @@
12
12
 
13
13
  import {Collection, Key, RefObject} from '@react-types/shared';
14
14
  import {Layout, Rect, ReusableView, useVirtualizerState} from '@react-stately/virtualizer';
15
- import {mergeProps, useLoadMore} from '@react-aria/utils';
16
- import React, {HTMLAttributes, ReactElement, ReactNode, useCallback, useRef} from 'react';
15
+ import {mergeProps, useLoadMore, useObjectRef} from '@react-aria/utils';
16
+ import React, {ForwardedRef, HTMLAttributes, ReactElement, ReactNode, useCallback} from 'react';
17
17
  import {ScrollView} from './ScrollView';
18
18
  import {VirtualizerItem} from './VirtualizerItem';
19
19
 
@@ -22,7 +22,7 @@ type RenderWrapper<T extends object, V> = (
22
22
  reusableView: ReusableView<T, V>,
23
23
  children: ReusableView<T, V>[],
24
24
  renderChildren: (views: ReusableView<T, V>[]) => ReactElement[]
25
- ) => ReactElement;
25
+ ) => ReactElement | null;
26
26
 
27
27
  interface VirtualizerProps<T extends object, V, O> extends Omit<HTMLAttributes<HTMLElement>, 'children'> {
28
28
  children: (type: string, content: T) => V,
@@ -36,32 +36,31 @@ interface VirtualizerProps<T extends object, V, O> extends Omit<HTMLAttributes<H
36
36
  layoutOptions?: O
37
37
  }
38
38
 
39
- function Virtualizer<T extends object, V extends ReactNode, O>(props: VirtualizerProps<T, V, O>, ref: RefObject<HTMLDivElement | null>) {
39
+ function Virtualizer<T extends object, V extends ReactNode, O>(props: VirtualizerProps<T, V, O>, forwardedRef: ForwardedRef<HTMLDivElement | null>) {
40
40
  let {
41
41
  children: renderView,
42
42
  renderWrapper,
43
43
  layout,
44
44
  collection,
45
45
  scrollDirection,
46
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
47
46
  isLoading,
48
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
49
47
  onLoadMore,
50
48
  persistedKeys,
51
49
  layoutOptions,
52
50
  ...otherProps
53
51
  } = props;
54
52
 
55
- let fallbackRef = useRef<HTMLDivElement>(undefined);
56
- ref = ref || fallbackRef;
53
+ let ref = useObjectRef(forwardedRef);
57
54
 
58
55
  let state = useVirtualizerState({
59
56
  layout,
60
57
  collection,
61
58
  renderView,
62
59
  onVisibleRectChange(rect) {
63
- ref.current.scrollLeft = rect.x;
64
- ref.current.scrollTop = rect.y;
60
+ if (ref.current) {
61
+ ref.current.scrollLeft = rect.x;
62
+ ref.current.scrollTop = rect.y;
63
+ }
65
64
  },
66
65
  persistedKeys,
67
66
  layoutOptions
@@ -108,7 +107,7 @@ function defaultRenderWrapper<T extends object, V extends ReactNode>(
108
107
  return (
109
108
  <VirtualizerItem
110
109
  key={reusableView.key}
111
- layoutInfo={reusableView.layoutInfo}
110
+ layoutInfo={reusableView.layoutInfo!}
112
111
  virtualizer={reusableView.virtualizer}
113
112
  parent={parent?.layoutInfo}>
114
113
  {reusableView.rendered}
@@ -17,6 +17,7 @@ import {useLocale} from '@react-aria/i18n';
17
17
  import {useVirtualizerItem, VirtualizerItemOptions} from './useVirtualizerItem';
18
18
 
19
19
  interface VirtualizerItemProps extends Omit<VirtualizerItemOptions, 'ref'> {
20
+ layoutInfo: LayoutInfo,
20
21
  parent?: LayoutInfo | null,
21
22
  style?: CSSProperties,
22
23
  className?: string,
@@ -26,7 +27,7 @@ interface VirtualizerItemProps extends Omit<VirtualizerItemOptions, 'ref'> {
26
27
  export function VirtualizerItem(props: VirtualizerItemProps) {
27
28
  let {style, className, layoutInfo, virtualizer, parent, children} = props;
28
29
  let {direction} = useLocale();
29
- let ref = useRef(undefined);
30
+ let ref = useRef<HTMLDivElement | null>(null);
30
31
  useVirtualizerItem({
31
32
  layoutInfo,
32
33
  virtualizer,
@@ -57,7 +58,7 @@ export function layoutInfoToStyle(layoutInfo: LayoutInfo, dir: Direction, parent
57
58
  }
58
59
  }
59
60
 
60
- let rectStyles = {
61
+ let rectStyles: Record<string, number | undefined> = {
61
62
  // TODO: For layoutInfos that are sticky that have parents with overflow visible, their "top" will be relative to the to the nearest scrolling container
62
63
  // which WON'T be the parent since the parent has overflow visible. This means we shouldn't offset the height by the parent's position
63
64
  // Not 100% about this change here since it is quite ambigious what the scrolling container maybe and how its top is positioned with respect to the
@@ -82,7 +83,7 @@ export function layoutInfoToStyle(layoutInfo: LayoutInfo, dir: Direction, parent
82
83
  overflow: layoutInfo.allowOverflow ? 'visible' : 'hidden',
83
84
  opacity: layoutInfo.opacity,
84
85
  zIndex: layoutInfo.zIndex,
85
- transform: layoutInfo.transform,
86
+ transform: layoutInfo.transform ?? undefined,
86
87
  contain: 'size layout style',
87
88
  ...rectStyles
88
89
  };
@@ -20,20 +20,21 @@ interface IVirtualizer {
20
20
  }
21
21
 
22
22
  export interface VirtualizerItemOptions {
23
- layoutInfo: LayoutInfo,
23
+ layoutInfo: LayoutInfo | null,
24
24
  virtualizer: IVirtualizer,
25
25
  ref: RefObject<HTMLElement | null>
26
26
  }
27
27
 
28
28
  export function useVirtualizerItem(options: VirtualizerItemOptions) {
29
29
  let {layoutInfo, virtualizer, ref} = options;
30
+ let key = layoutInfo?.key;
30
31
 
31
32
  let updateSize = useCallback(() => {
32
- if (layoutInfo) {
33
+ if (key != null && ref.current) {
33
34
  let size = getSize(ref.current);
34
- virtualizer.updateItemSize(layoutInfo.key, size);
35
+ virtualizer.updateItemSize(key, size);
35
36
  }
36
- }, [virtualizer, layoutInfo?.key, ref]);
37
+ }, [virtualizer, key, ref]);
37
38
 
38
39
  useLayoutEffect(() => {
39
40
  if (layoutInfo?.estimatedSize) {