react / react/react-native

`View` inside `ScrollView` makes scroll-to-top when multiline input grows

Open
#48,412 7 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component: ScrollView Issue: Author Provided Repro Needs: Attention Newer Patch Available
Dominant language
C++
Stars
127k
Forks
25.3k
Avg merge
1d 23h
Merged PRs (30d)
4

Description

Description

I use this component:

import React, { forwardRef } from "react";

import {
  ScrollView,
  ScrollViewProps,
  View,  
} from "react-native";

export type KeyboardAwareScrollViewProps = {
  /** The distance between keyboard and focused `TextInput` when keyboard is shown. Default is `0`. */
  bottomOffset?: number;
  /** Prevents automatic scrolling of the `ScrollView` when the keyboard gets hidden, maintaining the current screen position. Default is `false`. */
  disableScrollOnKeyboardHide?: boolean;
  /** Controls whether this `KeyboardAwareScrollView` instance should take effect. Default is `true` */
  enabled?: boolean;
  /** Adjusting the bottom spacing of KeyboardAwareScrollView. Default is `0` */
  extraKeyboardSpace?: number;
  /** Custom component for `ScrollView`. Default is `ScrollView` */
  ScrollViewComponent?: React.ComponentType<ScrollViewProps>;
} & ScrollViewProps;

const KeyboardAwareScrollView = forwardRef<
  ScrollView,
  React.PropsWithChildren<KeyboardAwareScrollViewProps>
>(
  (
    {
      children,
      ...rest
    },
    ref,
  ) => {

    return (
      <>
      <ScrollView {...rest} scrollEventThrottle={16}>
        {children}
        <View style={{height: 336, backgroundColor: 'red'}} />
      </ScrollView>
      
      </>
    );
  },
);

export default KeyboardAwareScrollView;

And I use it the code:

import React, { useCallback, useEffect, useRef, useState } from "react";
import { Button, Platform, Switch, Text, View, TextInput, StyleSheet } from "react-native";

export default function AwareScrollView() {
  const [_, setText] = useState("");

  return (
    <View style={styles.main}>
        <KeyboardAwareScrollView>
          <View style={styles.contentContainer}>
            <TextInput
              style={styles.contentText}
              multiline
              value={_}
              onChangeText={(value) => setText(value)}
              scrollEnabled={false}
            />
          </View>
        </KeyboardAwareScrollView>
      </View>
  );
}

export const styles = StyleSheet.create({
  safeAreaView: {
    flex: 1,
  },

  main: {
    flex: 1,
    marginBottom: 0,
  },

  contentContainer: {
    padding: 15,
    flexGrow: 1,
  },

  contentText: {
    width: "100%",
    backgroundColor: "#bcbcbc",
    flex: 1,
    fontSize: 16,
    minHeight: 60,
    textAlignVertical: "top",
  },
});
Steps to reproduce
  1. Type a long message in multiline input (you can simply press Enter/move to the next line to speed up the process)
  2. When TextInput gets obscured by keyboard scroll till the bottom to make sure the bottom of TextInput is visible
  3. Start to type a long message (you can use predictive text to speed up the process)
  4. When text goes to a new line ScrollView suddenly scrolls to top

Expected result is that ScrollView should remain its position.

React Native Version

0.76.2

Affected Platforms

Runtime - iOS

Output of npx react-native info
System:
  OS: macOS 15.1
  CPU: (10) arm64 Apple M1 Pro
  Memory: 118.81 MB / 32.00 GB
  Shell:
    version: "5.9"
    path: /bin/zsh
Binaries:
  Node:
    version: 20.18.0
    path: ~/.nvm/versions/node/v20.18.0/bin/node
  Yarn:
    version: 1.22.22
    path: ~/.nvm/versions/node/v20.18.0/bin/yarn
  npm:
    version: 10.8.2
    path: ~/.nvm/versions/node/v20.18.0/bin/npm
  Watchman:
    version: 2024.10.21.00
    path: /opt/homebrew/bin/watchman
Managers:
  CocoaPods:
    version: 1.14.3
    path: /usr/local/bin/pod
SDKs:
  iOS SDK:
    Platforms:
      - DriverKit 24.1
      - iOS 18.1
      - macOS 15.1
      - tvOS 18.1
      - visionOS 2.1
      - watchOS 11.1
  Android SDK: Not Found
IDEs:
  Android Studio: 2024.2 AI-242.23339.11.2421.12483815
  Xcode:
    version: 16.1/16B40
    path: /usr/bin/xcodebuild
Languages:
  Java:
    version: 17.0.9
    path: /usr/bin/javac
  Ruby:
    version: 2.7.6
    path: /Users/kirylziusko/.rbenv/shims/ruby
npmPackages:
  "@react-native-community/cli":
    installed: 15.0.1
    wanted: 15.0.1
  react:
    installed: 18.3.1
    wanted: 18.3.1
  react-native:
    installed: 0.76.2
    wanted: 0.76.2
  react-native-macos: Not Found
npmGlobalPackages:
  "*react-native*": Not Found
Android:
  hermesEnabled: true
  newArchEnabled: false
iOS:
  hermesEnabled: true
  newArchEnabled: false
Stacktrace or Logs
I don't have any logs, bug from what I debugged in XCode methods like `scrollToOffset`/`scrollToEnd`/`scrollViewShouldScrollToTop` are not getting called.
Reproducer

https://github.com/kirillzyusko/react-native-keyboard-controller/blob/main/example/src/screens/Examples/AwareScrollView/index.tsx

Screenshots and Videos

https://github.com/user-attachments/assets/48078f8b-a1cc-42c2-8637-deeaa5a28346

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by running the linked reproducer at example/src/screens/Examples/AwareScrollView/index.tsx on iOS with React Native 0.76.2, using the multiline TextInput inside ScrollView described in the issue. Inspect the ScrollView and TextInput behavior when the input grows while scrolled near the bottom. Done means the ScrollView remains at its current position when the TextInput reaches a new line.

Written by the indexing model from the issue text.

Assessment

Tech stack
ios, react-native, typescript
Domain
mobile
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.