@onekeyfe/react-native-pager-view 6.7.0-alpha.324 → 6.7.0-alpha.335

package/src/CollapsiblePagerViewNativeComponent.ts

@@ -59,7 +59,7 @@ export interface NativeProps extends ViewProps {
   nativeSmoothHeaderScrollEnabled?: WithDefault<boolean, false>;
   headerHeight?: Int32;
   stickyHeaderHeight?: Int32;
-  topScrollEdgeHard?: WithDefault<boolean, false>;
+  topScrollEdgeEffect?: WithDefault<"none" | "hard" | "soft", "none">;
   topOverlayColorScheme?: string;
   topOverlayHeight?: WithDefault<Double, 0>;
   externalTopOverlayTag?: WithDefault<Int32, 0>;

package/src/NativeScroller.tsx

@@ -15,6 +15,7 @@ import {
 } from "react-native";
 
 import NativeScrollerHost, { Commands } from "./NativeScrollerNativeComponent";
+import type { ScrollEdgeEffect } from "./ScrollEdgeEffect";
 
 export const NATIVE_SCROLLER_NATIVE_ID_PREFIX =
   "rnc-collapsible-pager-native-scroller";
@@ -46,8 +47,8 @@ export interface NativeScrollerProps
   pagerScrollKey?: string;
   /** Fixed overlay above scrolling content on iOS 26 and newer. */
   topOverlay?: React.ReactNode;
-  /** Enables UIKit's hard top scroll-edge effect on iOS 26 and newer. */
-  topScrollEdgeEffect?: "hard";
+  /** Selects UIKit's top scroll-edge effect on iOS 26 and newer. */
+  topScrollEdgeEffect?: `${ScrollEdgeEffect}`;
   /** iOS only. Android retains AndroidX's native fling physics. */
   decelerationRate?: ScrollViewProps["decelerationRate"];
   /** Standard RefreshControl props are mapped to the independently owned native controller. */
@@ -118,7 +119,8 @@ export const NativeScroller = React.forwardRef<
   const [topOverlayHeight, setTopOverlayHeight] = React.useState(0);
   const hasTopOverlay =
     Platform.OS === "ios" && parseInt(String(Platform.Version), 10) >= 26 &&
-    topScrollEdgeEffect === "hard" && topOverlay != null;
+    (topScrollEdgeEffect === "hard" || topScrollEdgeEffect === "soft") &&
+    topOverlay != null;
   const [refreshEpoch, requestRefreshSync] = React.useReducer(
     (value: number) => value + 1,
     0
@@ -212,7 +214,7 @@ export const NativeScroller = React.forwardRef<
       contentInsetRight={contentInset?.right ?? 0}
       contentInsetBottom={contentInset?.bottom ?? 0}
       contentInsetLeft={contentInset?.left ?? 0}
-      topScrollEdgeHard={hasTopOverlay}
+      topScrollEdgeEffect={hasTopOverlay ? topScrollEdgeEffect : "none"}
       topOverlayHeight={hasTopOverlay ? topOverlayHeight : 0}
       decelerationRate={rate}
       keyboardShouldPersistTaps={persistTaps}

package/src/NativeScroller.web.tsx

@@ -13,19 +13,41 @@ export const NativeScroller = React.forwardRef<
 >(function NativeScroller(inputProps, ref) {
   const {
     dataSet,
-    pagerScrollKey: _pagerScrollKey,
+    pagerScrollKey,
     topOverlay: _topOverlay,
     topScrollEdgeEffect: _topScrollEdgeEffect,
     ...props
   } = inputProps as NativeScrollerWebProps;
+  const scrollRef = React.useRef<React.ElementRef<typeof ScrollView>>(null);
+  const setRef = React.useCallback(
+    (node: React.ElementRef<typeof ScrollView> | null) => {
+      scrollRef.current = node;
+      if (typeof ref === "function") ref(node);
+      else if (ref) ref.current = node;
+    },
+    [ref]
+  );
+  React.useLayoutEffect(() => {
+    const element = scrollRef.current?.getScrollableNode() as unknown as
+      | HTMLElement
+      | undefined;
+    const EventConstructor = element?.ownerDocument?.defaultView?.Event;
+    if (EventConstructor)
+      element.dispatchEvent(
+        new EventConstructor("ok-collapsible-pager-scroll-key-changed", {
+          bubbles: true,
+        })
+      );
+  }, [pagerScrollKey]);
   const webDataProps = {
     dataSet: {
       ...dataSet,
       collapsiblePagerScroll: "true",
+      collapsiblePagerScrollKey: pagerScrollKey ?? "",
     },
   };
 
-  return <ScrollView {...props} ref={ref} {...webDataProps} />;
+  return <ScrollView {...props} ref={setRef} {...webDataProps} />;
 });
 
 NativeScroller.displayName = "NativeScroller";

package/src/NativeScrollerNativeComponent.ts

@@ -47,7 +47,7 @@ export interface NativeProps extends ViewProps {
   contentInsetRight?: WithDefault<Double, 0>;
   contentInsetBottom?: WithDefault<Double, 0>;
   contentInsetLeft?: WithDefault<Double, 0>;
-  topScrollEdgeHard?: WithDefault<boolean, false>;
+  topScrollEdgeEffect?: WithDefault<"none" | "hard" | "soft", "none">;
   topOverlayHeight?: WithDefault<Double, 0>;
   refreshEnabled?: WithDefault<boolean, false>;
   refreshing?: WithDefault<boolean, false>;

package/src/ScrollEdgeEffect.ts

@@ -0,0 +1,4 @@
+export enum ScrollEdgeEffect {
+  Hard = "hard",
+  Soft = "soft",
+}

package/src/WebCollapsiblePagerPage.tsx

@@ -0,0 +1,258 @@
+import React from "react";
+
+export type WebCollapsiblePagerPageState = Readonly<{
+  isFocused: boolean;
+  isRouteActive: boolean;
+  owner: HTMLElement | null;
+  content: HTMLElement | null;
+  contentHeight?: number;
+  width: number;
+  height: number;
+  scrollTop: number;
+  pendingRouteScrollTop: number | null;
+  registerContent: (element: HTMLElement, explicitHeight?: number) => () => void;
+}>;
+
+export type WebCollapsiblePagerPageBridge = Readonly<{
+  setOwner: (owner: HTMLElement | null) => void;
+  requestMeasure: () => void;
+  setPendingRouteScrollTop: (top: number | null) => void;
+}>;
+
+const PageContext = React.createContext<WebCollapsiblePagerPageState | null>(null);
+
+export function useWebCollapsiblePagerPage() {
+  return React.useContext(PageContext);
+}
+
+export function WebCollapsiblePagerPage({
+  children,
+  pageKey,
+  isFocused,
+  isRouteActive,
+  headerHeight,
+  stickyHeaderHeight,
+  onBridge,
+  onGeometryChange,
+  onScroll,
+  onUserInput,
+}: React.PropsWithChildren<{
+  pageKey: string;
+  isFocused: boolean;
+  isRouteActive: boolean;
+  headerHeight: number;
+  stickyHeaderHeight: number;
+  onBridge: (key: string, bridge: WebCollapsiblePagerPageBridge | null) => void;
+  onGeometryChange: (key: string) => void;
+  onScroll: (key: string, top: number) => void;
+  onUserInput: (key: string) => void;
+}>) {
+  const [owner, setOwner] = React.useState<HTMLElement | null>(null);
+  const ownerRef = React.useRef<HTMLElement | null>(null);
+  const [registered, setRegistered] = React.useState<{
+    element: HTMLElement;
+    height?: number;
+  } | null>(null);
+  const registeredRef = React.useRef(registered);
+  const observerRef = React.useRef<ResizeObserver | null>(null);
+  const observedContentRef = React.useRef<HTMLElement | null>(null);
+  const frameRef = React.useRef<number | null>(null);
+  const disposedRef = React.useRef(false);
+  const [pendingRouteScrollTop, setPendingRouteScrollTop] = React.useState<
+    number | null
+  >(null);
+  const [metrics, setMetrics] = React.useState({
+    width: 0,
+    height: 0,
+    scrollTop: 0,
+  });
+  const inputsRef = React.useRef({
+    pageKey,
+    headerHeight,
+    stickyHeaderHeight,
+    onGeometryChange,
+    onScroll,
+    onUserInput,
+  });
+  inputsRef.current = {
+    pageKey,
+    headerHeight,
+    stickyHeaderHeight,
+    onGeometryChange,
+    onScroll,
+    onUserInput,
+  };
+
+  const measure = React.useCallback(() => {
+    frameRef.current = null;
+    if (disposedRef.current) return;
+    const current = ownerRef.current;
+    if (!current?.isConnected) return;
+    const ownerRect = current.getBoundingClientRect();
+    const candidate = registeredRef.current?.element;
+    const content = candidate?.isConnected && current.contains(candidate) ? candidate : null;
+    const contentRect = (content ?? current.firstElementChild)?.getBoundingClientRect();
+    const inputs = inputsRef.current;
+    const pinnedBottom =
+      ownerRect.top +
+      Math.max(0, inputs.headerHeight - current.scrollTop) +
+      inputs.stickyHeaderHeight;
+    const visibleTop = Math.max(
+      ownerRect.top,
+      pinnedBottom,
+      contentRect?.top ?? 0,
+    );
+    const next = {
+      width: current.clientWidth,
+      height: Math.max(0, ownerRect.bottom - visibleTop),
+      scrollTop: Math.max(0, pinnedBottom - (contentRect?.top ?? pinnedBottom)),
+    };
+    setMetrics((previous) =>
+      previous.width === next.width &&
+      previous.height === next.height &&
+      previous.scrollTop === next.scrollTop
+        ? previous
+        : next,
+    );
+    inputs.onGeometryChange(inputs.pageKey);
+  }, []);
+
+  const requestMeasure = React.useCallback(() => {
+    if (!disposedRef.current && frameRef.current === null)
+      frameRef.current = requestAnimationFrame(measure);
+  }, [measure]);
+
+  const syncContentObservation = React.useCallback(() => {
+    const observer = observerRef.current;
+    const current = ownerRef.current;
+    if (!observer || !current) return;
+    const candidate = registeredRef.current?.element;
+    const content = candidate?.isConnected && current.contains(candidate)
+      ? candidate
+      : current.firstElementChild;
+    const next =
+      typeof HTMLElement !== "undefined" && content instanceof HTMLElement
+        ? content
+        : null;
+    if (observedContentRef.current === next) return;
+    if (observedContentRef.current) observer.unobserve(observedContentRef.current);
+    observedContentRef.current = next;
+    if (next) observer.observe(next);
+  }, []);
+
+  const registerContent = React.useCallback<
+    WebCollapsiblePagerPageState["registerContent"]
+  >(
+    (element, height) => {
+      const entry = {
+        element,
+        height: height !== undefined && Number.isFinite(height) && height >= 0
+          ? height
+          : undefined,
+      };
+      registeredRef.current = entry;
+      setRegistered(entry);
+      syncContentObservation();
+      requestMeasure();
+      return () => {
+        if (registeredRef.current !== entry) return;
+        registeredRef.current = null;
+        setRegistered(null);
+        syncContentObservation();
+        requestMeasure();
+      };
+    },
+    [requestMeasure, syncContentObservation],
+  );
+
+  const bridge = React.useMemo<WebCollapsiblePagerPageBridge>(
+    () => ({
+      setOwner: (next) => {
+        if (ownerRef.current === next) return;
+        ownerRef.current = next;
+        setOwner(next);
+        requestMeasure();
+      },
+      requestMeasure,
+      setPendingRouteScrollTop,
+    }),
+    [requestMeasure],
+  );
+
+  React.useLayoutEffect(() => {
+    disposedRef.current = false;
+    return () => {
+      disposedRef.current = true;
+      if (frameRef.current !== null) cancelAnimationFrame(frameRef.current);
+      frameRef.current = null;
+    };
+  }, []);
+
+  React.useLayoutEffect(() => {
+    onBridge(pageKey, bridge);
+    return () => onBridge(pageKey, null);
+  }, [bridge, onBridge, pageKey]);
+
+  React.useLayoutEffect(() => {
+    if (!owner) return undefined;
+    const observer = new ResizeObserver(requestMeasure);
+    observerRef.current = observer;
+    observer.observe(owner);
+    syncContentObservation();
+    const handleScroll = () => {
+      if (ownerRef.current !== owner) return;
+      const inputs = inputsRef.current;
+      inputs.onScroll(inputs.pageKey, owner.scrollTop);
+      requestMeasure();
+    };
+    const handleKey = (event: KeyboardEvent) => {
+      if (
+        ["ArrowUp", "ArrowDown", "PageUp", "PageDown", "Home", "End", " "].includes(
+          event.key,
+        )
+      )
+        inputsRef.current.onUserInput(inputsRef.current.pageKey);
+    };
+    const handleUserInput = () =>
+      inputsRef.current.onUserInput(inputsRef.current.pageKey);
+    owner.addEventListener("scroll", handleScroll, { passive: true });
+    owner.addEventListener("touchstart", handleUserInput, { passive: true });
+    owner.addEventListener("pointerdown", handleUserInput);
+    owner.addEventListener("keydown", handleKey);
+    owner.addEventListener("ok-collapsible-pager-user-scroll", handleUserInput);
+    owner.addEventListener("ok-collapsible-pager-insets-changed", requestMeasure);
+    requestMeasure();
+    return () => {
+      observer.disconnect();
+      observerRef.current = null;
+      observedContentRef.current = null;
+      owner.removeEventListener("scroll", handleScroll);
+      owner.removeEventListener("touchstart", handleUserInput);
+      owner.removeEventListener("pointerdown", handleUserInput);
+      owner.removeEventListener("keydown", handleKey);
+      owner.removeEventListener("ok-collapsible-pager-user-scroll", handleUserInput);
+      owner.removeEventListener("ok-collapsible-pager-insets-changed", requestMeasure);
+      if (frameRef.current !== null) cancelAnimationFrame(frameRef.current);
+      frameRef.current = null;
+    };
+  }, [owner, requestMeasure, syncContentObservation]);
+
+  React.useLayoutEffect(requestMeasure, [isFocused, isRouteActive, headerHeight, stickyHeaderHeight, requestMeasure]);
+
+  const value = React.useMemo<WebCollapsiblePagerPageState>(
+    () => ({
+      isFocused,
+      isRouteActive,
+      owner,
+      content: registered?.element.isConnected && owner?.contains(registered.element)
+        ? registered.element
+        : null,
+      contentHeight: registered?.height,
+      ...metrics,
+      pendingRouteScrollTop,
+      registerContent,
+    }),
+    [isFocused, isRouteActive, owner, registered, metrics, pendingRouteScrollTop, registerContent],
+  );
+  return <PageContext.Provider value={value}>{children}</PageContext.Provider>;
+}

package/src/index.native.tsx

@@ -0,0 +1,30 @@
+import type * as ReactNative from "react-native";
+import { PagerView } from "./PagerView";
+export default PagerView;
+export * from "./usePagerView";
+export * from "./CollapsiblePagerView";
+export * from "./NativeScroller";
+import type {
+  OnPageScrollEventData as PagerViewOnPageScrollEventData,
+  OnPageSelectedEventData as PagerViewOnPageSelectedEventData,
+  OnPageScrollStateChangedEventData as PageScrollStateChangedNativeEventData,
+  NativeProps,
+} from "./PagerViewNativeComponent";
+
+export type {
+  PagerViewOnPageScrollEventData,
+  PagerViewOnPageSelectedEventData,
+  PageScrollStateChangedNativeEventData,
+  NativeProps as PagerViewProps,
+};
+
+export type PagerViewOnPageScrollEvent =
+  ReactNative.NativeSyntheticEvent<PagerViewOnPageScrollEventData>;
+
+export type PagerViewOnPageSelectedEvent =
+  ReactNative.NativeSyntheticEvent<PagerViewOnPageSelectedEventData>;
+
+export type PageScrollStateChangedNativeEvent =
+  ReactNative.NativeSyntheticEvent<PageScrollStateChangedNativeEventData>;
+
+export { ScrollEdgeEffect } from "./ScrollEdgeEffect";

package/src/index.tsx

@@ -4,6 +4,10 @@ export default PagerView;
 export * from './usePagerView';
 export * from './CollapsiblePagerView';
 export * from './NativeScroller';
+export { CollapsiblePagerView as WebCollapsiblePagerView } from './CollapsiblePagerView.web';
+export type { CollapsiblePagerViewProps as WebCollapsiblePagerViewProps } from './CollapsiblePagerView.web';
+export { useWebCollapsiblePagerPage } from './WebCollapsiblePagerPage';
+export type { WebCollapsiblePagerPageState } from './WebCollapsiblePagerPage';
 
 import type {
   OnPageScrollEventData as PagerViewOnPageScrollEventData,
@@ -27,3 +31,5 @@ export type PagerViewOnPageSelectedEvent =
 
 export type PageScrollStateChangedNativeEvent =
   ReactNative.NativeSyntheticEvent<PageScrollStateChangedNativeEventData>;
+
+export { ScrollEdgeEffect } from './ScrollEdgeEffect';

package/src/index.web.tsx

@@ -11,3 +11,9 @@ export type {
 export * from "./usePagerView";
 export * from "./CollapsiblePagerView.web";
 export * from "./NativeScroller.web";
+export { CollapsiblePagerView as WebCollapsiblePagerView } from "./CollapsiblePagerView.web";
+export type { CollapsiblePagerViewProps as WebCollapsiblePagerViewProps } from "./CollapsiblePagerView.web";
+export { useWebCollapsiblePagerPage } from "./WebCollapsiblePagerPage";
+export type { WebCollapsiblePagerPageState } from "./WebCollapsiblePagerPage";
+
+export { ScrollEdgeEffect } from "./ScrollEdgeEffect";