react-native-keyboard-controller 1.21.0-beta.1 → 1.21.0-beta.2

package/src/components/ChatKit/TODO.md

@@ -0,0 +1,20 @@
+# Findings
+
+1. We can not translate whole `ScrollView` because interactive dismissal will have double scroll if we move it by `translateY` or content will be truncated if we don't do it (same with external container).
+2. So we need to move only content inside `ScrollView`.
+3. If we use a separate `scrollTo` we still may have a random jump. The only one way is to use `contentOffset` + `padding` on `ScrollView`.
+4. Input must be always in `KeyboardStickyView` because it's always pushing above the keyboard (unlike content, which may stay in place).
+5. Changing `contentOffset` on `ScrollView` will not work. On iOS it works, but on Android sometimes it doesn't scroll to correct position (when you scroll list to the end) and on paper architecture it is flickering.
+6. Next idea is to use `contentInset` on iOS and create custom `ClippingScrollView` on Android (with polyfill `contentInsetBottom` prop).
+
+## To Do
+
+- [x] check how `ClippingScrollView` works in `KeyboardAwareScrollView` on Android (seems to be working well)
+- [x] introduce `useCombinedRef` hook in separate PR
+- [x] make sure, that style property doesn't affect the behavior with/without `ClippingScrollView` (test on a ScrollView that doesn't tke full screen?) <-- tested by comparing iOS with Android + `ClippingScrollView` (`contentInsetBottom` never override `paddingBottom` from `style`/`contentContainerStyle` even if ScrollView has `maxHeight=150` and we have only 2 inputs limitation + also tested `ScrollView` without height restrictions, in this case `paddingBottom` on `style` is not getting applied (it doesn't have an effect on both iOS/Android), but `contentContainerStyle` + `paddingBottom` works as expected and if I add `contentInsetBottom` to `ClippingScrollView` it doesn't overwrite a padding and increases scrollable area)
+- [x] `ClippingScrollView` + `KeyboardAwareScrollView` check by e2e tests (seems to be working, though on Android emulator + e2e tests sometimes when keyboard disappear we still have keyboard space)
+- [x] introduce `ClippingScrollView` in separate PR
+- [x] create a polyfill-version of ScrollView `that` can add scrollable padding in the bottom of the content? How to wrap custom `ScrollView` with it (cause we may pass one from react-native-gesture-handler)? Should just adjust `contentInset` (scroll management should belong to `KeyboardAwareScrollView`) (ScrollViewWithKeyboardPadding/ScrollViewWithKeyboardSpace)
+- [x] use `ClippingScrollView` in `KeyboardAwareScrollView` in separate PR
+- [-] introduce `ChatKit`
+- [] create issue in reanimated repo about `scrollTo` performance regression

package/src/components/ChatKit/hooks.ts

@@ -0,0 +1,2 @@
+export { useChatKeyboard } from "./useChatKeyboard";
+export type { KeyboardLiftBehavior } from "./useChatKeyboard";

package/src/components/ChatKit/index.tsx

@@ -0,0 +1,63 @@
+import React, { forwardRef } from "react";
+import { useAnimatedRef, useAnimatedStyle } from "react-native-reanimated";
+import Reanimated from "react-native-reanimated";
+
+import useCombinedRef from "../hooks/useCombinedRef";
+import ScrollViewWithBottomPadding from "../ScrollViewWithBottomPadding";
+
+import { useChatKeyboard } from "./useChatKeyboard";
+
+import type { ChatKitScrollViewProps } from "./types";
+
+const ChatScrollView = forwardRef<
+  Reanimated.ScrollView,
+  React.PropsWithChildren<ChatKitScrollViewProps>
+>(
+  (
+    {
+      children,
+      ScrollViewComponent = Reanimated.ScrollView,
+      inverted = false,
+      keyboardLiftBehavior = "always",
+      freeze = false,
+      offset = 0,
+      ...rest
+    },
+    ref,
+  ) => {
+    const scrollViewRef = useAnimatedRef<Reanimated.ScrollView>();
+    const onRef = useCombinedRef(ref, scrollViewRef);
+
+    const { padding, contentOffsetY, containerTranslateY } = useChatKeyboard(
+      scrollViewRef,
+      { inverted, keyboardLiftBehavior, freeze, offset },
+    );
+
+    const containerStyle = useAnimatedStyle(
+      () => ({
+        transform: [{ translateY: containerTranslateY.value }],
+      }),
+      [],
+    );
+
+    return (
+      <ScrollViewWithBottomPadding
+        ref={onRef}
+        {...rest}
+        bottomPadding={padding}
+        containerStyle={containerStyle}
+        contentOffsetY={contentOffsetY}
+        inverted={inverted}
+        ScrollViewComponent={ScrollViewComponent}
+      >
+        {children}
+      </ScrollViewWithBottomPadding>
+    );
+  },
+);
+
+const ChatKit = {
+  ScrollView: ChatScrollView,
+};
+
+export default ChatKit;

package/src/components/ChatKit/types.ts

@@ -0,0 +1,50 @@
+import type { AnimatedScrollViewComponent } from "../ScrollViewWithBottomPadding";
+import type { ScrollViewProps } from "react-native";
+
+type KeyboardLiftBehavior = "always" | "whenAtEnd" | "persistent" | "never";
+
+export type ChatKitScrollViewProps = {
+  /** Custom component for `ScrollView`. Default is `ScrollView`. */
+  ScrollViewComponent: AnimatedScrollViewComponent;
+  /** Whether list are using `inverted` prop. Default is `false`. */
+  inverted?: boolean;
+  /**
+   * The distance (in pixels) between the bottom of the screen and the `ScrollView`.
+   * When the keyboard appears, the scroll view will only push content by the effective
+   * distance (`keyboardHeight - offset`) instead of the full keyboard height.
+   *
+   * Useful when the input is not at the very bottom of the screen (e.g., above safe area, above
+   * bottom tabs, etc. - in this case offset should be equal to the height of the elements between
+   * `ScrollView` and bottom of the screen).
+   *
+   * Default is `0`.
+   */
+  offset?: number;
+  /**
+   * Determines how the chat content should behave when the keyboard appears, specifically whether
+   * the scroll view should automatically lift its content to keep it visible above the keyboard.
+   *
+   * Possible values:
+   * - `'always'`: The content always lifts along with the keyboard, ensuring the messages from the bottom part of screen
+   * remain visible regardless of the current scroll position. This is the default behavior for most chat applications (used in Telegram).
+   * - `'whenAtEnd'`: The content lifts only if the scroll view is at the end (i.e., the last message
+   * is visible or near the bottom). This prevents unnecessary adjustments when the user is scrolling
+   * through older messages (ChatGPT mobile app behavior).
+   * - `'persistent'`: The content always lifts when the keyboard appears (similar to `'always'`), but
+   * does not reset (lower) when the keyboard hides. This mimics behaviors where the view remains adjusted
+   * after keyboard dismissal to maintain focus on the latest content without shifting back (Claude mobile app behavior).
+   * - `'never'`: The content does not lift at all when the keyboard appears. Use this for scenarios
+   * when you don't want to disturb user attention with animations (Perplexity mobile app behavior).
+   *
+   * Default is `'always'`.
+   */
+  keyboardLiftBehavior?: KeyboardLiftBehavior;
+  /**
+   * When `true`, freezes all keyboard-driven layout changes (padding, content offset, scroll position).
+   * Useful when dismissing the keyboard to open a bottom sheet — prevents visual disruption
+   * while the sheet is visible.
+   *
+   * Default is `false`.
+   */
+  freeze?: boolean;
+} & ScrollViewProps;

package/src/components/ChatKit/useChatKeyboard/helpers.ts

@@ -0,0 +1,118 @@
+type KeyboardLiftBehavior = "always" | "whenAtEnd" | "persistent" | "never";
+
+const AT_END_THRESHOLD = 20;
+
+/**
+ * Check whether the scroll view is at the end of its content.
+ *
+ * @param scrollOffset - Current vertical scroll offset.
+ * @param layoutHeight - Visible height of the scroll view.
+ * @param contentHeight - Total height of the scrollable content.
+ * @returns `true` if the scroll position is within the threshold of the content end.
+ * @example
+ * ```ts
+ * const atEnd = isScrollAtEnd(100, 800, 920); // true (100 + 800 >= 920 - 20)
+ * ```
+ */
+export function isScrollAtEnd(
+  scrollOffset: number,
+  layoutHeight: number,
+  contentHeight: number,
+): boolean {
+  "worklet";
+
+  return scrollOffset + layoutHeight >= contentHeight - AT_END_THRESHOLD;
+}
+
+/**
+ * Decide whether content should be shifted based on the keyboard lift behavior.
+ *
+ * @param behavior - The configured keyboard lift behavior.
+ * @param isAtEnd - Whether the scroll view is currently at the end.
+ * @returns `true` if content should be shifted.
+ * @example
+ * ```ts
+ * shouldShiftContent("always", false); // true
+ * shouldShiftContent("whenAtEnd", false); // false
+ * ```
+ */
+export function shouldShiftContent(
+  behavior: KeyboardLiftBehavior,
+  isAtEnd: boolean,
+): boolean {
+  "worklet";
+
+  switch (behavior) {
+    case "always":
+      return true;
+    case "never":
+      return false;
+    case "whenAtEnd":
+      return isAtEnd;
+    case "persistent":
+      return true;
+  }
+}
+
+/**
+ * Compute the clamped scroll target for non-inverted lists.
+ *
+ * @param offsetBeforeScroll - Scroll position before keyboard appeared.
+ * @param keyboardHeight - Current keyboard height.
+ * @param contentHeight - Total height of the scrollable content.
+ * @param layoutHeight - Visible height of the scroll view.
+ * @returns Clamped scroll target between 0 and maxScroll.
+ * @example
+ * ```ts
+ * clampedScrollTarget(100, 300, 1000, 800); // 400
+ * ```
+ */
+export function clampedScrollTarget(
+  offsetBeforeScroll: number,
+  keyboardHeight: number,
+  contentHeight: number,
+  layoutHeight: number,
+): number {
+  "worklet";
+
+  const maxScroll = Math.max(contentHeight - layoutHeight + keyboardHeight, 0);
+
+  return Math.min(Math.max(offsetBeforeScroll + keyboardHeight, 0), maxScroll);
+}
+
+/**
+ * Compute contentOffset.y for iOS lists.
+ *
+ * @param relativeScroll - Scroll position relative to current inset.
+ * @param keyboardHeight - Target keyboard height.
+ * @param contentHeight - Total height of the scrollable content.
+ * @param layoutHeight - Visible height of the scroll view.
+ * @param inverted - Whether the list is inverted.
+ * @returns The absolute contentOffset.y to set.
+ * @example
+ * ```ts
+ * computeIOSContentOffset(100, 300, 1000, 800, false); // 400
+ * ```
+ */
+export function computeIOSContentOffset(
+  relativeScroll: number,
+  keyboardHeight: number,
+  contentHeight: number,
+  layoutHeight: number,
+  inverted: boolean,
+): number {
+  "worklet";
+
+  if (inverted) {
+    const maxScroll = Math.max(contentHeight - layoutHeight, 0);
+
+    return Math.max(
+      Math.min(relativeScroll - keyboardHeight, maxScroll),
+      -keyboardHeight,
+    );
+  }
+
+  const maxScroll = Math.max(contentHeight - layoutHeight + keyboardHeight, 0);
+
+  return Math.min(Math.max(keyboardHeight + relativeScroll, 0), maxScroll);
+}

package/src/components/ChatKit/useChatKeyboard/index.ts

@@ -0,0 +1,228 @@
+import { Platform } from "react-native";
+import { interpolate, scrollTo, useSharedValue } from "react-native-reanimated";
+
+import { useKeyboardHandler } from "../../../hooks";
+import useScrollState from "../../hooks/useScrollState";
+
+import {
+  clampedScrollTarget,
+  computeIOSContentOffset,
+  isScrollAtEnd,
+  shouldShiftContent,
+} from "./helpers";
+
+import type { AnimatedRef, SharedValue } from "react-native-reanimated";
+import type Reanimated from "react-native-reanimated";
+
+const OS = Platform.OS;
+
+type KeyboardLiftBehavior = "always" | "whenAtEnd" | "persistent" | "never";
+
+type UseChatKeyboardOptions = {
+  inverted: boolean;
+  keyboardLiftBehavior: KeyboardLiftBehavior;
+  freeze: boolean;
+  offset: number;
+};
+
+type UseChatKeyboardReturn = {
+  /** Extra scrollable space (= keyboard height). Used as contentInset on iOS, contentInsetBottom on Android. */
+  padding: SharedValue<number>;
+  /** Absolute Y content offset for iOS (set once in onStart). `undefined` on Android. */
+  contentOffsetY: SharedValue<number> | undefined;
+  /** TranslateY for the container wrapper on Android inverted lists. 0 otherwise. */
+  containerTranslateY: SharedValue<number>;
+};
+
+/**
+ * Hook that manages keyboard-driven scrolling for chat-style scroll views.
+ * Calculates padding (extra scrollable space) and content shift values,
+ * using the optimal strategy per platform.
+ *
+ * @param scrollViewRef - Animated ref to the scroll view.
+ * @param options - Configuration for inverted and keyboardLiftBehavior.
+ * @returns Shared values for padding, contentOffsetY (iOS), and containerTranslateY (Android inverted).
+ * @example
+ * ```tsx
+ * const { padding, contentOffsetY, containerTranslateY } = useChatKeyboard(ref, {
+ *   inverted: false,
+ *   keyboardLiftBehavior: "always",
+ * });
+ * ```
+ */
+function useChatKeyboard(
+  scrollViewRef: AnimatedRef<Reanimated.ScrollView>,
+  options: UseChatKeyboardOptions,
+): UseChatKeyboardReturn {
+  const { inverted, keyboardLiftBehavior, freeze, offset } = options;
+
+  const padding = useSharedValue(0);
+  const contentOffsetY = useSharedValue(0);
+  const containerTranslateY = useSharedValue(0);
+  const offsetBeforeScroll = useSharedValue(0);
+  const targetKeyboardHeight = useSharedValue(0);
+
+  const { layout, size, offset: scroll } = useScrollState(scrollViewRef);
+
+  const getEffectiveHeight = (height: number): number => {
+    "worklet";
+
+    if (offset === 0 || targetKeyboardHeight.value === 0) {
+      return height;
+    }
+
+    return interpolate(
+      height,
+      [0, targetKeyboardHeight.value],
+      [0, Math.max(targetKeyboardHeight.value - offset, 0)],
+    );
+  };
+
+  useKeyboardHandler(
+    {
+      onStart: (e) => {
+        "worklet";
+
+        if (freeze) {
+          return;
+        }
+
+        if (e.height > 0) {
+          // eslint-disable-next-line react-compiler/react-compiler
+          targetKeyboardHeight.value = e.height;
+        }
+
+        const effective = getEffectiveHeight(e.height);
+
+        const atEnd = isScrollAtEnd(
+          scroll.value,
+          layout.value.height,
+          size.value.height,
+        );
+
+        if (OS === "ios") {
+          // iOS: set padding + contentOffset once in onStart
+          const relativeScroll = inverted
+            ? scroll.value + padding.value
+            : scroll.value - padding.value;
+
+          padding.value = effective;
+
+          if (!shouldShiftContent(keyboardLiftBehavior, atEnd)) {
+            return;
+          }
+
+          if (
+            keyboardLiftBehavior === "persistent" &&
+            effective < padding.value
+          ) {
+            return;
+          }
+
+          contentOffsetY.value = computeIOSContentOffset(
+            relativeScroll,
+            effective,
+            size.value.height,
+            layout.value.height,
+            inverted,
+          );
+        } else if (e.height > 0) {
+          // Android: keyboard opening — set padding + capture scroll position
+          padding.value = effective;
+          offsetBeforeScroll.value = scroll.value;
+
+          if (keyboardLiftBehavior === "whenAtEnd" && !atEnd) {
+            // Sentinel: don't scroll in onMove
+            offsetBeforeScroll.value = -1;
+          }
+        } else {
+          // Android: keyboard closing — re-capture from current position
+          // so onMove smoothly scrolls back from where the user is now
+          offsetBeforeScroll.value = scroll.value - padding.value;
+        }
+      },
+      onMove: (e) => {
+        "worklet";
+
+        if (freeze) {
+          return;
+        }
+
+        // iOS doesn't need per-frame updates (contentOffset handles it)
+        if (OS === "ios") {
+          return;
+        }
+
+        if (!shouldShiftContent(keyboardLiftBehavior, true)) {
+          return;
+        }
+
+        // "whenAtEnd" sentinel check
+        if (offsetBeforeScroll.value === -1) {
+          return;
+        }
+
+        const effective = getEffectiveHeight(e.height);
+
+        if (inverted) {
+          // Android inverted: translateY on container
+          if (
+            keyboardLiftBehavior === "persistent" &&
+            effective < Math.abs(containerTranslateY.value)
+          ) {
+            return;
+          }
+
+          containerTranslateY.value = -effective;
+        } else {
+          // Android non-inverted: scrollTo per-frame
+          if (
+            keyboardLiftBehavior === "persistent" &&
+            effective < scroll.value - offsetBeforeScroll.value
+          ) {
+            return;
+          }
+
+          const target = clampedScrollTarget(
+            offsetBeforeScroll.value,
+            effective,
+            size.value.height,
+            layout.value.height,
+          );
+
+          scrollTo(scrollViewRef, 0, target, false);
+        }
+      },
+      onEnd: (e) => {
+        "worklet";
+
+        if (freeze) {
+          return;
+        }
+
+        const effective = getEffectiveHeight(e.height);
+
+        padding.value = effective;
+
+        if (
+          OS !== "ios" &&
+          inverted &&
+          e.height === 0 &&
+          keyboardLiftBehavior !== "persistent"
+        ) {
+          containerTranslateY.value = 0;
+        }
+      },
+    },
+    [inverted, keyboardLiftBehavior, freeze, offset],
+  );
+
+  return {
+    padding,
+    contentOffsetY: OS === "ios" ? contentOffsetY : undefined,
+    containerTranslateY,
+  };
+}
+
+export { useChatKeyboard };
+export type { KeyboardLiftBehavior };

package/src/components/KeyboardAwareScrollView/index.tsx

@@ -149,7 +149,6 @@ const KeyboardAwareScrollView = forwardRef<
     const lastSelection =
       useSharedValue<FocusedInputSelectionChangedEvent | null>(null);
     const ghostViewSpace = useSharedValue(-1);
-    const pendingSelectionForFocus = useSharedValue(false);
 
     const { height } = useWindowDimensions();
 
@@ -325,18 +324,7 @@ const KeyboardAwareScrollView = forwardRef<
         lastSelection.value = e;
 
         if (e.target !== lastTarget) {
-          if (pendingSelectionForFocus.value) {
-            // selection arrived after onStart - complete the deferred setup
-            pendingSelectionForFocus.value = false;
-            updateLayoutFromSelection();
-
-            // if keyboard was already visible (focus change, no onMove expected),
-            // perform the deferred scroll now
-            if (!keyboardWillAppear.value && keyboardHeight.value > 0) {
-              position.value += maybeScroll(keyboardHeight.value, true);
-            }
-          }
-
+          // ignore this event, because "focus changed" event handled in `useSmoothKeyboardHandler`
           return;
         }
         // caret in the end + end coordinates has been changed -> we moved to a new line
@@ -354,12 +342,7 @@ const KeyboardAwareScrollView = forwardRef<
 
         onChangeTextHandler();
       },
-      [
-        scrollFromCurrentPosition,
-        onChangeTextHandler,
-        updateLayoutFromSelection,
-        maybeScroll,
-      ],
+      [scrollFromCurrentPosition, onChangeTextHandler],
     );
 
     useFocusedInputHandler(
@@ -392,7 +375,6 @@ const KeyboardAwareScrollView = forwardRef<
             // on back transition need to interpolate as [0, keyboardHeight]
             initialKeyboardSize.value = 0;
             scrollPosition.value = scrollBeforeKeyboardMovement.value;
-            pendingSelectionForFocus.value = false;
           }
 
           if (
@@ -409,31 +391,17 @@ const KeyboardAwareScrollView = forwardRef<
           // focus was changed
           if (focusWasChanged) {
             tag.value = e.target;
-
-            if (lastSelection.value?.target === e.target) {
-              // selection arrived before onStart - use it to update layout
-              updateLayoutFromSelection();
-              pendingSelectionForFocus.value = false;
-            } else {
-              // selection hasn't arrived yet for the new target.
-              // use input layout as-is; will be refined when selection arrives.
-              if (input.value) {
-                layout.value = input.value;
-              }
-              pendingSelectionForFocus.value = true;
-            }
-
+            // save position of focused text input when keyboard starts to move
+            updateLayoutFromSelection();
             // save current scroll position - when keyboard will hide we'll reuse
             // this value to achieve smooth hide effect
             scrollBeforeKeyboardMovement.value = position.value;
           }
 
           if (focusWasChanged && !keyboardWillAppear.value) {
-            if (!pendingSelectionForFocus.value) {
-              // update position on scroll value, so `onEnd` handler
-              // will pick up correct values
-              position.value += maybeScroll(e.height, true);
-            }
+            // update position on scroll value, so `onEnd` handler
+            // will pick up correct values
+            position.value += maybeScroll(e.height, true);
           }
 
           ghostViewSpace.value =
@@ -467,10 +435,6 @@ const KeyboardAwareScrollView = forwardRef<
           keyboardHeight.value = e.height;
           scrollPosition.value = position.value;
 
-          if (e.height === 0) {
-            lastSelection.value = null;
-          }
-
           syncKeyboardFrame(e);
         },
       },

package/src/components/KeyboardStickyView/index.tsx

@@ -58,17 +58,16 @@ const KeyboardStickyView = forwardRef<
       outputRange: [closed, opened],
     });
 
-    const styles = useMemo(
-      () => [
+    const styles = useMemo(() => {
+      return [
         {
           transform: [
             { translateY: enabled ? Animated.add(height, offset) : closed },
           ],
         },
         style,
-      ],
-      [closed, enabled, height, offset, style],
-    );
+      ];
+    }, [closed, enabled, height, offset, style]);
 
     return (
       <Animated.View ref={ref} style={styles} {...props}>