@legendapp/list 3.3.9 → 3.3.10

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 3.3.10
+
+- Fix: Changing `dataKey` no longer loses the new dataset's initial scroll position when React retries a render.
+
 ## 3.3.9
 
 - Fix: Rows after an item that changes size stay in the correct positions while scrolling

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@legendapp/list",
-  "version": "3.3.9",
+  "version": "3.3.10",
   "description": "Legend List is a drop-in replacement for FlatList with much better performance and supporting dynamically sized items.",
   "sideEffects": false,
   "private": false,

package/react-native.js

@@ -7470,6 +7470,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     refState.current = ctx.state;
   }
   const state = refState.current;
+  const handledDataChangeEpochRef = React2.useRef(state.dataChangeEpoch);
+  const handledFreshDataTransitionEpochRef = React2.useRef(state.freshDataTransitionEpoch);
   const isFirstLocal = state.isFirst;
   const previousAdaptiveRender = state.props.adaptiveRender;
   const previousHideItemsUntilMeasured = state.props.hideItemsUntilMeasured;
@@ -7495,6 +7497,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   if (shouldResetFreshDataLayout) {
     state.freshDataTransitionEpoch += 1;
   }
+  const dataChangeEpoch = state.dataChangeEpoch;
+  const freshDataTransitionEpoch = state.freshDataTransitionEpoch;
   const throttledOnScroll = useThrottledOnScroll(onScrollProp != null ? onScrollProp : noopOnScroll, scrollEventThrottle != null ? scrollEventThrottle : 0);
   const throttleScrollFn = scrollEventThrottle && onScrollProp ? throttledOnScroll : onScrollProp;
   const didAnchoredEndSpaceAnchorIndexChange = !isFirstLocal && !didDataChangeLocal && ((_q = state.props.anchoredEndSpace) == null ? void 0 : _q.anchorIndex) !== (anchoredEndSpace == null ? void 0 : anchoredEndSpace.anchorIndex);
@@ -7622,7 +7626,11 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     useDevChecks(props);
   }
   React2.useLayoutEffect(() => {
-    if (shouldResetFreshDataLayout) {
+    const didDataChange = handledDataChangeEpochRef.current !== dataChangeEpoch;
+    const didStartFreshData = handledFreshDataTransitionEpochRef.current !== freshDataTransitionEpoch;
+    handledDataChangeEpochRef.current = dataChangeEpoch;
+    handledFreshDataTransitionEpochRef.current = freshDataTransitionEpoch;
+    if (didStartFreshData) {
       resetInitialRenderState(ctx, {
         resetInitialScroll: !!initialScrollProp,
         resetLayout: true
@@ -7630,8 +7638,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     }
     handleInitialScrollDataChange(ctx, {
       dataLength: dataProp.length,
-      didDataChange: didDataChangeLocal,
-      didStartFreshData: shouldResetFreshDataLayout,
+      didDataChange,
+      didStartFreshData,
       initialScrollAtEnd,
       latestInitialScroll: initialScrollProp,
       latestInitialScrollSessionKind: initialScrollUsesOffsetOnly ? "offset" : "bootstrap",
@@ -7641,8 +7649,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   }, [
     dataProp.length,
     dataKey,
-    didDataChangeLocal,
-    shouldResetFreshDataLayout,
+    dataChangeEpoch,
+    freshDataTransitionEpoch,
     initialScrollAtEnd,
     stylePaddingEndState,
     usesBootstrapInitialScroll

package/react-native.mjs

@@ -7449,6 +7449,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     refState.current = ctx.state;
   }
   const state = refState.current;
+  const handledDataChangeEpochRef = useRef(state.dataChangeEpoch);
+  const handledFreshDataTransitionEpochRef = useRef(state.freshDataTransitionEpoch);
   const isFirstLocal = state.isFirst;
   const previousAdaptiveRender = state.props.adaptiveRender;
   const previousHideItemsUntilMeasured = state.props.hideItemsUntilMeasured;
@@ -7474,6 +7476,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   if (shouldResetFreshDataLayout) {
     state.freshDataTransitionEpoch += 1;
   }
+  const dataChangeEpoch = state.dataChangeEpoch;
+  const freshDataTransitionEpoch = state.freshDataTransitionEpoch;
   const throttledOnScroll = useThrottledOnScroll(onScrollProp != null ? onScrollProp : noopOnScroll, scrollEventThrottle != null ? scrollEventThrottle : 0);
   const throttleScrollFn = scrollEventThrottle && onScrollProp ? throttledOnScroll : onScrollProp;
   const didAnchoredEndSpaceAnchorIndexChange = !isFirstLocal && !didDataChangeLocal && ((_q = state.props.anchoredEndSpace) == null ? void 0 : _q.anchorIndex) !== (anchoredEndSpace == null ? void 0 : anchoredEndSpace.anchorIndex);
@@ -7601,7 +7605,11 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     useDevChecks(props);
   }
   useLayoutEffect(() => {
-    if (shouldResetFreshDataLayout) {
+    const didDataChange = handledDataChangeEpochRef.current !== dataChangeEpoch;
+    const didStartFreshData = handledFreshDataTransitionEpochRef.current !== freshDataTransitionEpoch;
+    handledDataChangeEpochRef.current = dataChangeEpoch;
+    handledFreshDataTransitionEpochRef.current = freshDataTransitionEpoch;
+    if (didStartFreshData) {
       resetInitialRenderState(ctx, {
         resetInitialScroll: !!initialScrollProp,
         resetLayout: true
@@ -7609,8 +7617,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     }
     handleInitialScrollDataChange(ctx, {
       dataLength: dataProp.length,
-      didDataChange: didDataChangeLocal,
-      didStartFreshData: shouldResetFreshDataLayout,
+      didDataChange,
+      didStartFreshData,
       initialScrollAtEnd,
       latestInitialScroll: initialScrollProp,
       latestInitialScrollSessionKind: initialScrollUsesOffsetOnly ? "offset" : "bootstrap",
@@ -7620,8 +7628,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   }, [
     dataProp.length,
     dataKey,
-    didDataChangeLocal,
-    shouldResetFreshDataLayout,
+    dataChangeEpoch,
+    freshDataTransitionEpoch,
     initialScrollAtEnd,
     stylePaddingEndState,
     usesBootstrapInitialScroll

package/react-native.web.js

@@ -8075,6 +8075,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     refState.current = ctx.state;
   }
   const state = refState.current;
+  const handledDataChangeEpochRef = React3.useRef(state.dataChangeEpoch);
+  const handledFreshDataTransitionEpochRef = React3.useRef(state.freshDataTransitionEpoch);
   const isFirstLocal = state.isFirst;
   const previousAdaptiveRender = state.props.adaptiveRender;
   const previousHideItemsUntilMeasured = state.props.hideItemsUntilMeasured;
@@ -8100,6 +8102,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   if (shouldResetFreshDataLayout) {
     state.freshDataTransitionEpoch += 1;
   }
+  const dataChangeEpoch = state.dataChangeEpoch;
+  const freshDataTransitionEpoch = state.freshDataTransitionEpoch;
   const throttledOnScroll = useThrottledOnScroll(onScrollProp != null ? onScrollProp : noopOnScroll, scrollEventThrottle != null ? scrollEventThrottle : 0);
   const throttleScrollFn = scrollEventThrottle && onScrollProp ? throttledOnScroll : onScrollProp;
   const didAnchoredEndSpaceAnchorIndexChange = !isFirstLocal && !didDataChangeLocal && ((_q = state.props.anchoredEndSpace) == null ? void 0 : _q.anchorIndex) !== (anchoredEndSpace == null ? void 0 : anchoredEndSpace.anchorIndex);
@@ -8222,7 +8226,11 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     useDevChecks(props);
   }
   React3.useLayoutEffect(() => {
-    if (shouldResetFreshDataLayout) {
+    const didDataChange = handledDataChangeEpochRef.current !== dataChangeEpoch;
+    const didStartFreshData = handledFreshDataTransitionEpochRef.current !== freshDataTransitionEpoch;
+    handledDataChangeEpochRef.current = dataChangeEpoch;
+    handledFreshDataTransitionEpochRef.current = freshDataTransitionEpoch;
+    if (didStartFreshData) {
       resetInitialRenderState(ctx, {
         resetInitialScroll: !!initialScrollProp,
         resetLayout: true
@@ -8230,8 +8238,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     }
     handleInitialScrollDataChange(ctx, {
       dataLength: dataProp.length,
-      didDataChange: didDataChangeLocal,
-      didStartFreshData: shouldResetFreshDataLayout,
+      didDataChange,
+      didStartFreshData,
       initialScrollAtEnd,
       latestInitialScroll: initialScrollProp,
       latestInitialScrollSessionKind: initialScrollUsesOffsetOnly ? "offset" : "bootstrap",
@@ -8241,8 +8249,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   }, [
     dataProp.length,
     dataKey,
-    didDataChangeLocal,
-    shouldResetFreshDataLayout,
+    dataChangeEpoch,
+    freshDataTransitionEpoch,
     initialScrollAtEnd,
     stylePaddingEndState,
     usesBootstrapInitialScroll

package/react-native.web.mjs

@@ -8054,6 +8054,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     refState.current = ctx.state;
   }
   const state = refState.current;
+  const handledDataChangeEpochRef = useRef(state.dataChangeEpoch);
+  const handledFreshDataTransitionEpochRef = useRef(state.freshDataTransitionEpoch);
   const isFirstLocal = state.isFirst;
   const previousAdaptiveRender = state.props.adaptiveRender;
   const previousHideItemsUntilMeasured = state.props.hideItemsUntilMeasured;
@@ -8079,6 +8081,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   if (shouldResetFreshDataLayout) {
     state.freshDataTransitionEpoch += 1;
   }
+  const dataChangeEpoch = state.dataChangeEpoch;
+  const freshDataTransitionEpoch = state.freshDataTransitionEpoch;
   const throttledOnScroll = useThrottledOnScroll(onScrollProp != null ? onScrollProp : noopOnScroll, scrollEventThrottle != null ? scrollEventThrottle : 0);
   const throttleScrollFn = scrollEventThrottle && onScrollProp ? throttledOnScroll : onScrollProp;
   const didAnchoredEndSpaceAnchorIndexChange = !isFirstLocal && !didDataChangeLocal && ((_q = state.props.anchoredEndSpace) == null ? void 0 : _q.anchorIndex) !== (anchoredEndSpace == null ? void 0 : anchoredEndSpace.anchorIndex);
@@ -8201,7 +8205,11 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     useDevChecks(props);
   }
   useLayoutEffect(() => {
-    if (shouldResetFreshDataLayout) {
+    const didDataChange = handledDataChangeEpochRef.current !== dataChangeEpoch;
+    const didStartFreshData = handledFreshDataTransitionEpochRef.current !== freshDataTransitionEpoch;
+    handledDataChangeEpochRef.current = dataChangeEpoch;
+    handledFreshDataTransitionEpochRef.current = freshDataTransitionEpoch;
+    if (didStartFreshData) {
       resetInitialRenderState(ctx, {
         resetInitialScroll: !!initialScrollProp,
         resetLayout: true
@@ -8209,8 +8217,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     }
     handleInitialScrollDataChange(ctx, {
       dataLength: dataProp.length,
-      didDataChange: didDataChangeLocal,
-      didStartFreshData: shouldResetFreshDataLayout,
+      didDataChange,
+      didStartFreshData,
       initialScrollAtEnd,
       latestInitialScroll: initialScrollProp,
       latestInitialScrollSessionKind: initialScrollUsesOffsetOnly ? "offset" : "bootstrap",
@@ -8220,8 +8228,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   }, [
     dataProp.length,
     dataKey,
-    didDataChangeLocal,
-    shouldResetFreshDataLayout,
+    dataChangeEpoch,
+    freshDataTransitionEpoch,
     initialScrollAtEnd,
     stylePaddingEndState,
     usesBootstrapInitialScroll

package/react.js

@@ -8075,6 +8075,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     refState.current = ctx.state;
   }
   const state = refState.current;
+  const handledDataChangeEpochRef = React3.useRef(state.dataChangeEpoch);
+  const handledFreshDataTransitionEpochRef = React3.useRef(state.freshDataTransitionEpoch);
   const isFirstLocal = state.isFirst;
   const previousAdaptiveRender = state.props.adaptiveRender;
   const previousHideItemsUntilMeasured = state.props.hideItemsUntilMeasured;
@@ -8100,6 +8102,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   if (shouldResetFreshDataLayout) {
     state.freshDataTransitionEpoch += 1;
   }
+  const dataChangeEpoch = state.dataChangeEpoch;
+  const freshDataTransitionEpoch = state.freshDataTransitionEpoch;
   const throttledOnScroll = useThrottledOnScroll(onScrollProp != null ? onScrollProp : noopOnScroll, scrollEventThrottle != null ? scrollEventThrottle : 0);
   const throttleScrollFn = scrollEventThrottle && onScrollProp ? throttledOnScroll : onScrollProp;
   const didAnchoredEndSpaceAnchorIndexChange = !isFirstLocal && !didDataChangeLocal && ((_q = state.props.anchoredEndSpace) == null ? void 0 : _q.anchorIndex) !== (anchoredEndSpace == null ? void 0 : anchoredEndSpace.anchorIndex);
@@ -8222,7 +8226,11 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     useDevChecks(props);
   }
   React3.useLayoutEffect(() => {
-    if (shouldResetFreshDataLayout) {
+    const didDataChange = handledDataChangeEpochRef.current !== dataChangeEpoch;
+    const didStartFreshData = handledFreshDataTransitionEpochRef.current !== freshDataTransitionEpoch;
+    handledDataChangeEpochRef.current = dataChangeEpoch;
+    handledFreshDataTransitionEpochRef.current = freshDataTransitionEpoch;
+    if (didStartFreshData) {
       resetInitialRenderState(ctx, {
         resetInitialScroll: !!initialScrollProp,
         resetLayout: true
@@ -8230,8 +8238,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     }
     handleInitialScrollDataChange(ctx, {
       dataLength: dataProp.length,
-      didDataChange: didDataChangeLocal,
-      didStartFreshData: shouldResetFreshDataLayout,
+      didDataChange,
+      didStartFreshData,
       initialScrollAtEnd,
       latestInitialScroll: initialScrollProp,
       latestInitialScrollSessionKind: initialScrollUsesOffsetOnly ? "offset" : "bootstrap",
@@ -8241,8 +8249,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   }, [
     dataProp.length,
     dataKey,
-    didDataChangeLocal,
-    shouldResetFreshDataLayout,
+    dataChangeEpoch,
+    freshDataTransitionEpoch,
     initialScrollAtEnd,
     stylePaddingEndState,
     usesBootstrapInitialScroll

package/react.mjs

@@ -8054,6 +8054,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     refState.current = ctx.state;
   }
   const state = refState.current;
+  const handledDataChangeEpochRef = useRef(state.dataChangeEpoch);
+  const handledFreshDataTransitionEpochRef = useRef(state.freshDataTransitionEpoch);
   const isFirstLocal = state.isFirst;
   const previousAdaptiveRender = state.props.adaptiveRender;
   const previousHideItemsUntilMeasured = state.props.hideItemsUntilMeasured;
@@ -8079,6 +8081,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   if (shouldResetFreshDataLayout) {
     state.freshDataTransitionEpoch += 1;
   }
+  const dataChangeEpoch = state.dataChangeEpoch;
+  const freshDataTransitionEpoch = state.freshDataTransitionEpoch;
   const throttledOnScroll = useThrottledOnScroll(onScrollProp != null ? onScrollProp : noopOnScroll, scrollEventThrottle != null ? scrollEventThrottle : 0);
   const throttleScrollFn = scrollEventThrottle && onScrollProp ? throttledOnScroll : onScrollProp;
   const didAnchoredEndSpaceAnchorIndexChange = !isFirstLocal && !didDataChangeLocal && ((_q = state.props.anchoredEndSpace) == null ? void 0 : _q.anchorIndex) !== (anchoredEndSpace == null ? void 0 : anchoredEndSpace.anchorIndex);
@@ -8201,7 +8205,11 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     useDevChecks(props);
   }
   useLayoutEffect(() => {
-    if (shouldResetFreshDataLayout) {
+    const didDataChange = handledDataChangeEpochRef.current !== dataChangeEpoch;
+    const didStartFreshData = handledFreshDataTransitionEpochRef.current !== freshDataTransitionEpoch;
+    handledDataChangeEpochRef.current = dataChangeEpoch;
+    handledFreshDataTransitionEpochRef.current = freshDataTransitionEpoch;
+    if (didStartFreshData) {
       resetInitialRenderState(ctx, {
         resetInitialScroll: !!initialScrollProp,
         resetLayout: true
@@ -8209,8 +8217,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
     }
     handleInitialScrollDataChange(ctx, {
       dataLength: dataProp.length,
-      didDataChange: didDataChangeLocal,
-      didStartFreshData: shouldResetFreshDataLayout,
+      didDataChange,
+      didStartFreshData,
       initialScrollAtEnd,
       latestInitialScroll: initialScrollProp,
       latestInitialScrollSessionKind: initialScrollUsesOffsetOnly ? "offset" : "bootstrap",
@@ -8220,8 +8228,8 @@ var LegendListInner = typedForwardRef(function LegendListInner2(props, forwarded
   }, [
     dataProp.length,
     dataKey,
-    didDataChangeLocal,
-    shouldResetFreshDataLayout,
+    dataChangeEpoch,
+    freshDataTransitionEpoch,
     initialScrollAtEnd,
     stylePaddingEndState,
     usesBootstrapInitialScroll