react-native-keyboard-controller/lib/module/components/KeyboardAwareScrollView/index.js

Keyboard manager which works in identical way on both iOS and Android

function _extends() { return _extends = Object.assign ? Object.assign.bind() : function (n) { for (var e = 1; e < arguments.length; e++) { var t = arguments[e]; for (var r in t) ({}).hasOwnProperty.call(t, r) && (n[r] = t[r]); } return n; }, _extends.apply(null, arguments); }
import React, { forwardRef, useCallback, useEffect, useImperativeHandle, useMemo } from "react";
import Reanimated, { clamp, interpolate, runOnUI, scrollTo, useAnimatedReaction, useAnimatedRef, useAnimatedStyle, useScrollViewOffset, useSharedValue } from "react-native-reanimated";
import { useFocusedInputHandler, useReanimatedFocusedInput, useWindowDimensions } from "../../hooks";
import { findNodeHandle } from "../../utils/findNodeHandle";
import { useSmoothKeyboardHandler } from "./useSmoothKeyboardHandler";
import { debounce, scrollDistanceWithRespectToSnapPoints } from "./utils";
// Everything begins from `onStart` handler. This handler is called every time,
// when keyboard changes its size or when focused `TextInput` was changed. In
// this handler we are calculating/memoizing values which later will be used
// during layout movement. For that we calculate:
// - layout of focused field (`layout`) - to understand whether there will be overlap
// - initial keyboard size (`initialKeyboardSize`) - used in scroll interpolation
// - future keyboard height (`keyboardHeight`) - used in scroll interpolation
// - current scroll position (`scrollPosition`) - used to scroll from this point
//
// Once we've calculated all necessary variables - we can actually start to use them.
// It happens in `onMove` handler - this function simply calls `maybeScroll` with
// current keyboard frame height. This functions makes the smooth transition.
//
// When the transition has finished we go to `onEnd` handler. In this handler
// we verify, that the current field is not overlapped within a keyboard frame.
// For full `onStart`/`onMove`/`onEnd` flow it may look like a redundant thing,
// however there could be some cases, when `onMove` is not called:
// - on iOS when TextInput was changed - keyboard transition is instant
// - on Android when TextInput was changed and keyboard size wasn't changed
// So `onEnd` handler handle the case, when `onMove` wasn't triggered.
//
// ====================================================================================================================+
// -----------------------------------------------------Flow chart-----------------------------------------------------+
// ====================================================================================================================+
//
// +============================+       +============================+        +==================================+
// +  User Press on TextInput   +   =>  +  Keyboard starts showing   +   =>   + As keyboard moves frame by frame +  =>
// +                            +       +       (run `onStart`)      +        +    `onMove` is getting called    +
// +============================+       +============================+        +==================================+
//
// +============================+       +============================+        +=====================================+
// + Keyboard is shown and we   +   =>  +    User moved focus to     +   =>   + Only `onStart`/`onEnd` maybe called +
// +    call `onEnd` handler    +       +     another `TextInput`    +        +    (without involving `onMove`)     +
// +============================+       +============================+        +=====================================+
//

/**
 * A ScrollView component that automatically handles keyboard appearance and disappearance
 * by adjusting its content position to ensure the focused input remains visible.
 *
 * The component uses a sophisticated animation system to smoothly handle keyboard transitions
 * and maintain proper scroll position during keyboard interactions.
 *
 * @returns A ScrollView component that handles keyboard interactions.
 * @see {@link https://kirillzyusko.github.io/react-native-keyboard-controller/docs/api/components/keyboard-aware-scroll-view|Documentation} page for more details.
 * @example
 * ```tsx
 * <KeyboardAwareScrollView bottomOffset={20}>
 *   <TextInput placeholder="Enter text" />
 *   <TextInput placeholder="Another input" />
 * </KeyboardAwareScrollView>
 * ```
 */
const KeyboardAwareScrollView = /*#__PURE__*/forwardRef(({
  children,
  onLayout,
  bottomOffset = 0,
  disableScrollOnKeyboardHide = false,
  enabled = true,
  extraKeyboardSpace = 0,
  ScrollViewComponent = Reanimated.ScrollView,
  snapToOffsets,
  ...rest
}, ref) => {
  const scrollViewAnimatedRef = useAnimatedRef();
  const scrollViewRef = React.useRef(null);
  const scrollViewTarget = useSharedValue(null);
  const scrollPosition = useSharedValue(0);
  const position = useScrollViewOffset(scrollViewAnimatedRef);
  const currentKeyboardFrameHeight = useSharedValue(0);
  const keyboardHeight = useSharedValue(0);
  const keyboardWillAppear = useSharedValue(false);
  const tag = useSharedValue(-1);
  const initialKeyboardSize = useSharedValue(0);
  const scrollBeforeKeyboardMovement = useSharedValue(0);
  const {
    input,
    update
  } = useReanimatedFocusedInput();
  const layout = useSharedValue(null);
  const lastSelection = useSharedValue(null);
  const {
    height
  } = useWindowDimensions();
  const onRef = useCallback(assignedRef => {
    scrollViewRef.current = assignedRef;
    scrollViewAnimatedRef(assignedRef);
  }, []);
  const onScrollViewLayout = useCallback(e => {
    scrollViewTarget.value = findNodeHandle(scrollViewAnimatedRef.current);
    onLayout === null || onLayout === void 0 || onLayout(e);
  }, [onLayout]);

  /**
   * Function that will scroll a ScrollView as keyboard gets moving.
   */
  const maybeScroll = useCallback((e, animated = false) => {
    "worklet";

    var _layout$value, _layout$value2, _layout$value3;
    if (!enabled) {
      return 0;
    }

    // input belongs to ScrollView
    if (((_layout$value = layout.value) === null || _layout$value === void 0 ? void 0 : _layout$value.parentScrollViewTarget) !== scrollViewTarget.value) {
      return 0;
    }
    const visibleRect = height - keyboardHeight.value;
    const absoluteY = ((_layout$value2 = layout.value) === null || _layout$value2 === void 0 ? void 0 : _layout$value2.layout.absoluteY) || 0;
    const inputHeight = ((_layout$value3 = layout.value) === null || _layout$value3 === void 0 ? void 0 : _layout$value3.layout.height) || 0;
    const point = absoluteY + inputHeight;
    if (visibleRect - point <= bottomOffset) {
      const relativeScrollTo = keyboardHeight.value - (height - point) + bottomOffset;
      const interpolatedScrollTo = interpolate(e, [initialKeyboardSize.value, keyboardHeight.value], [0, scrollDistanceWithRespectToSnapPoints(relativeScrollTo + scrollPosition.value, snapToOffsets) - scrollPosition.value]);
      const targetScrollY = Math.max(interpolatedScrollTo, 0) + scrollPosition.value;
      scrollTo(scrollViewAnimatedRef, 0, targetScrollY, animated);
      return interpolatedScrollTo;
    }
    if (point < 0) {
      const positionOnScreen = visibleRect - bottomOffset;
      const topOfScreen = scrollPosition.value + point;
      scrollTo(scrollViewAnimatedRef, 0, topOfScreen - positionOnScreen, animated);
    }
    return 0;
  }, [bottomOffset, enabled, height, snapToOffsets]);
  const performScrollWithPositionRestoration = useCallback(newPosition => {
    "worklet";

    const prevScroll = scrollPosition.value;

    // eslint-disable-next-line react-compiler/react-compiler
    scrollPosition.value = newPosition;
    maybeScroll(keyboardHeight.value, true);
    scrollPosition.value = prevScroll;
  }, [scrollPosition, keyboardHeight, maybeScroll]);
  const syncKeyboardFrame = useCallback(e => {
    "worklet";

    const keyboardFrame = interpolate(e.height, [0, keyboardHeight.value], [0, keyboardHeight.value + extraKeyboardSpace]);
    currentKeyboardFrameHeight.value = keyboardFrame;
  }, [extraKeyboardSpace]);
  const updateLayoutFromSelection = useCallback(() => {
    "worklet";

    var _lastSelection$value, _input$value;
    const customHeight = (_lastSelection$value = lastSelection.value) === null || _lastSelection$value === void 0 ? void 0 : _lastSelection$value.selection.end.y;
    if (!((_input$value = input.value) !== null && _input$value !== void 0 && _input$value.layout) || !customHeight) {
      return false;
    }
    layout.value = {
      ...input.value,
      layout: {
        ...input.value.layout,
        // when we have multiline input with limited amount of lines, then custom height can be very big
        // so we clamp it to max input height
        height: clamp(customHeight, 0, input.value.layout.height)
      }
    };
    return true;
  }, [input, lastSelection, layout]);
  const scrollFromCurrentPosition = useCallback(() => {
    "worklet";

    const prevLayout = layout.value;
    if (!updateLayoutFromSelection()) {
      return;
    }
    performScrollWithPositionRestoration(position.value);
    layout.value = prevLayout;
  }, [performScrollWithPositionRestoration]);
  const onChangeText = useCallback(() => {
    "worklet";

    scrollFromCurrentPosition();
  }, [scrollFromCurrentPosition]);
  const onChangeTextHandler = useMemo(() => debounce(onChangeText, 200), [onChangeText]);
  const onSelectionChange = useCallback(e => {
    "worklet";

    var _lastSelection$value2, _lastSelection$value3;
    const lastTarget = (_lastSelection$value2 = lastSelection.value) === null || _lastSelection$value2 === void 0 ? void 0 : _lastSelection$value2.target;
    const latestSelection = (_lastSelection$value3 = lastSelection.value) === null || _lastSelection$value3 === void 0 ? void 0 : _lastSelection$value3.selection;
    lastSelection.value = e;
    if (e.target !== lastTarget) {
      // 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
    // so input may grow
    if (e.selection.end.position === e.selection.start.position && (latestSelection === null || latestSelection === void 0 ? void 0 : latestSelection.end.y) !== e.selection.end.y) {
      return scrollFromCurrentPosition();
    }
    // selection has been changed
    if (e.selection.start.position !== e.selection.end.position) {
      return scrollFromCurrentPosition();
    }
    onChangeTextHandler();
  }, [scrollFromCurrentPosition, onChangeTextHandler]);
  useFocusedInputHandler({
    onSelectionChange: onSelectionChange
  }, [onSelectionChange]);
  useSmoothKeyboardHandler({
    onStart: e => {
      "worklet";

      const keyboardWillChangeSize = keyboardHeight.value !== e.height && e.height > 0;
      keyboardWillAppear.value = e.height > 0 && keyboardHeight.value === 0;
      const keyboardWillHide = e.height === 0;
      const focusWasChanged = tag.value !== e.target && e.target !== -1 || keyboardWillChangeSize;
      if (keyboardWillChangeSize) {
        initialKeyboardSize.value = keyboardHeight.value;
      }
      if (keyboardWillHide) {
        // on back transition need to interpolate as [0, keyboardHeight]
        initialKeyboardSize.value = 0;
        scrollPosition.value = scrollBeforeKeyboardMovement.value;
      }
      if (keyboardWillAppear.value || keyboardWillChangeSize || focusWasChanged) {
        // persist scroll value
        scrollPosition.value = position.value;
        // just persist height - later will be used in interpolation
        keyboardHeight.value = e.height;
      }

      // focus was changed
      if (focusWasChanged) {
        tag.value = e.target;
        // 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) {
        // update position on scroll value, so `onEnd` handler
        // will pick up correct values
        position.value += maybeScroll(e.height, true);
      }
    },
    onMove: e => {
      "worklet";

      syncKeyboardFrame(e);

      // if the user has set disableScrollOnKeyboardHide, only auto-scroll when the keyboard opens
      if (!disableScrollOnKeyboardHide || keyboardWillAppear.value) {
        maybeScroll(e.height);
      }
    },
    onEnd: e => {
      "worklet";

      keyboardHeight.value = e.height;
      scrollPosition.value = position.value;
      syncKeyboardFrame(e);
    }
  }, [maybeScroll, disableScrollOnKeyboardHide, syncKeyboardFrame]);
  const synchronize = useCallback(async () => {
    await update();
    runOnUI(() => {
      "worklet";

      scrollFromCurrentPosition();
    })();
  }, [update, scrollFromCurrentPosition]);
  useImperativeHandle(ref, () => {
    const scrollView = scrollViewRef.current;
    const existingMethods = scrollView ? {
      ...scrollView
    } : {};
    return {
      ...existingMethods,
      assureFocusedInputVisible: () => {
        synchronize();
      }
    };
  }, [synchronize]);
  useEffect(() => {
    synchronize();
  }, [bottomOffset]);
  useAnimatedReaction(() => input.value, (current, previous) => {
    if ((current === null || current === void 0 ? void 0 : current.target) === (previous === null || previous === void 0 ? void 0 : previous.target) && (current === null || current === void 0 ? void 0 : current.layout.height) !== (previous === null || previous === void 0 ? void 0 : previous.layout.height)) {
      // input has changed layout - let's check if we need to scroll
      // may happen when you paste text, then onSelectionChange will be
      // fired earlier than text actually changes its layout
      scrollFromCurrentPosition();
    }
  }, []);
  const view = useAnimatedStyle(() => enabled ? {
    // animations become choppy when scrolling to the end of the `ScrollView` (when the last input is focused)
    // this happens because the layout recalculates on every frame. To avoid this we slightly increase padding
    // by `+1`. In this way we assure, that `scrollTo` will never scroll to the end, because it uses interpolation
    // from 0 to `keyboardHeight`, and here our padding is `keyboardHeight + 1`. It allows us not to re-run layout
    // re-calculation on every animation frame and it helps to achieve smooth animation.
    // see: https://github.com/kirillzyusko/react-native-keyboard-controller/pull/342
    paddingBottom: currentKeyboardFrameHeight.value + 1
  } : {}, [enabled]);
  return /*#__PURE__*/React.createElement(ScrollViewComponent, _extends({
    ref: onRef
  }, rest, {
    scrollEventThrottle: 16,
    onLayout: onScrollViewLayout
  }), children, enabled && /*#__PURE__*/React.createElement(Reanimated.View, {
    style: view
  }));
});
export default KeyboardAwareScrollView;
//# sourceMappingURL=index.js.map