Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: inverted option causing sticky headers, ListEmptyComponent to appear inverted, and causing scroll direction to be inverted on web #1487

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Next Next commit
fix(web): scroll direction inverted when inverted is set
  • Loading branch information
mtourj committed Jan 23, 2025
commit c446319b134d86f2ba659659fb351bb3e404cda5
27 changes: 27 additions & 0 deletions src/FlashList.tsx
Original file line number Diff line number Diff line change
@@ -6,6 +6,7 @@ import {
NativeSyntheticEvent,
StyleSheet,
NativeScrollEvent,
Platform,
} from "react-native";
import {
BaseItemAnimator,
@@ -100,6 +101,8 @@ class FlashList<T> extends React.PureComponent<
private isEmptyList = false;
private viewabilityManager: ViewabilityManager<T>;

private hasInvertedWheelHandler = false;

private itemAnimator?: BaseItemAnimator;

static defaultProps = {
@@ -283,10 +286,26 @@ class FlashList<T> extends React.PureComponent<
}
};

private updateWebScrollHandler() {
if (Platform.OS !== "web" || !this.rlvRef) return;

if (this.props.inverted !== this.hasInvertedWheelHandler) {
if (this.props.inverted) {
PlatformConfig.addInvertedWheelHandler(this.rlvRef);
this.hasInvertedWheelHandler = true;
} else {
PlatformConfig.removeInvertedWheelHandler(this.rlvRef);
this.hasInvertedWheelHandler = false;
}
}
}

componentDidMount() {
if (this.props.data?.length === 0) {
this.raiseOnLoadEventIfNeeded();
}

this.updateWebScrollHandler();
}

componentWillUnmount() {
@@ -296,6 +315,14 @@ class FlashList<T> extends React.PureComponent<
if (this.itemSizeWarningTimeoutId !== undefined) {
clearTimeout(this.itemSizeWarningTimeoutId);
}

if (this.hasInvertedWheelHandler) {
PlatformConfig.removeInvertedWheelHandler(this.rlvRef);
}
}

componentDidUpdate() {
this.updateWebScrollHandler();
}

render() {
18 changes: 17 additions & 1 deletion src/native/config/PlatformHelper.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,26 @@
import { BaseItemAnimator } from "recyclerlistview";
import {
BaseItemAnimator,
RecyclerListView,
RecyclerListViewProps,
} from "recyclerlistview";
import { DefaultJSItemAnimator } from "recyclerlistview/dist/reactnative/platform/reactnative/itemanimators/defaultjsanimator/DefaultJSItemAnimator";

const PlatformConfig = {
defaultDrawDistance: 250,
invertedTransformStyle: { transform: [{ scaleY: -1 }] },
invertedTransformStyleHorizontal: { transform: [{ scaleX: -1 }] },
addInvertedWheelHandler: (
ref: RecyclerListView<RecyclerListViewProps, any> | undefined
): (() => void) | undefined => {
// (web-only)
return undefined;
},
removeInvertedWheelHandler: (
ref: RecyclerListView<RecyclerListViewProps, any> | undefined
): (() => void) | undefined => {
// (web-only)
return undefined;
},
};
const getCellContainerPlatformStyles = (
inverted: boolean,
50 changes: 48 additions & 2 deletions src/native/config/PlatformHelper.web.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,58 @@
import React from "react";
import { View } from "react-native";
import { BaseItemAnimator } from "recyclerlistview";
import { findNodeHandle, View } from "react-native";
import {
BaseItemAnimator,
RecyclerListView,
RecyclerListViewProps,
} from "recyclerlistview";
import { DefaultJSItemAnimator } from "recyclerlistview/dist/reactnative/platform/reactnative/itemanimators/defaultjsanimator/DefaultJSItemAnimator";

const invertedWheelEventHandler = (event: globalThis.WheelEvent) => {
const node = event.currentTarget as HTMLElement;

// For inverted lists, we want to scroll in the opposite direction
// So when deltaY is positive (scroll down), we want to scroll up
const deltaY = -event.deltaY;
const deltaX = -event.deltaX;

// Scroll by the inverted delta
node.scrollBy({
top: deltaY,
left: deltaX,
behavior: "auto",
});

// Prevent the default scroll
event.preventDefault();
};

const PlatformConfig = {
defaultDrawDistance: 2000,
invertedTransformStyle: { transform: [{ scaleY: -1 }] },
invertedTransformStyleHorizontal: { transform: [{ scaleX: -1 }] },
addInvertedWheelHandler: (
ref: RecyclerListView<RecyclerListViewProps, any> | undefined
): ((event: globalThis.WheelEvent) => void) | undefined => {
if (!ref) return undefined;
const node = findNodeHandle(ref) as unknown as HTMLElement;
if (node) {
node.addEventListener("wheel", invertedWheelEventHandler, {
passive: false,
});
return invertedWheelEventHandler;
}
return undefined;
},
removeInvertedWheelHandler: (
ref: RecyclerListView<RecyclerListViewProps, any> | undefined
): ((event: globalThis.WheelEvent) => void) | undefined => {
if (!ref) return undefined;
const node = findNodeHandle(ref) as unknown as HTMLElement;
if (node) {
node.removeEventListener("wheel", invertedWheelEventHandler);
}
return undefined;
},
};
const getCellContainerPlatformStyles = (
inverted: boolean,