react / react/react-native

`KeyboardAvoidingView` infinitely updates on Android

Open
#45,192 11 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API: Keyboard Component: KeyboardAvoidingView Issue: Author Provided Repro Platform: Android Resolution: PR Submitted
Dominant language
C++
Stars
127k
Forks
25.3k
Avg merge
1d 23h
Merged PRs (30d)
4

Description

Description

The bottom state of the KeyboardAvoidingView component infinitely updates on Android. This is visible when inspecting KeyboardAvoidingView's state in React Native DevTools, it continuously changes value. Or when a component is rendered just above the keyboard, it flickers and/or bounces up and down.

Steps to reproduce
Prerequisites
  1. App from reproducer repo is built and open. Reproduction 1 is on branch example-1. Reproduction 2 is on branch example-2. For each branch, checkout, yarn install then yarn android.
  2. React Native DevTools is running.
Reproduction 1

Reproduction 1 is a text input and footer fixed to the bottom wrapped in a KeyboardAvoidingView. While the bottom state changes, the change is so small (<1 px) that it is not noticeable in the UI.

Steps
  1. Inspect KeyboardAvoidingView in the React Native DevTools.
  2. Focus on text input in app.
  3. Check bottom state in DevTools.
  4. Unfocus text input in app.
  5. Check bottom state in DevTools.
Expected behaviour

The bottom state should not continuously change.

Actual behaviour

The bottom state continuously changes.

Reproduction 2

Reproduction 2 is the same as reproduction 1 but with two screens to show the effect on the UI as the bottom state change is much larger.

Steps
  1. Focus on text input in the app.
  2. Tap "Go to screen 2".
  3. Inspect Screen2's KeyboardAvoidingView in the React Native DevTools.
Expected behaviour

The bottom state should not continuously change. The footer should not be flickering.

Actual behaviour

The bottom state continuously changes. The footer is flickering.

React Native Version

0.74.2

Affected Platforms

Runtime - Android

Output of npx react-native info
System:
  OS: macOS 14.5
  CPU: (8) arm64 Apple M1
  Memory: 100.70 MB / 16.00 GB
  Shell:
    version: 3.7.0
    path: /opt/homebrew/bin/fish
Binaries:
  Node:
    version: 20.11.1
    path: ~/.local/share/mise/installs/node/20/bin/node
  Yarn:
    version: 3.6.4
    path: ~/.local/share/mise/installs/node/20/bin/yarn
  npm:
    version: 10.2.4
    path: ~/.local/share/mise/installs/node/20/bin/npm
  Watchman:
    version: 2024.01.22.00
    path: /opt/homebrew/bin/watchman
Managers:
  CocoaPods:
    version: 1.15.2
    path: /usr/local/bin/pod
SDKs:
  iOS SDK:
    Platforms:
      - DriverKit 23.5
      - iOS 17.5
      - macOS 14.5
      - tvOS 17.5
      - visionOS 1.2
      - watchOS 10.5
  Android SDK:
    API Levels:
      - "33"
      - "34"
    Build Tools:
      - 29.0.2
      - 30.0.2
      - 30.0.3
      - 31.0.0
      - 33.0.1
      - 34.0.0
    System Images:
      - android-33 | Google APIs ARM 64 v8a
      - android-34 | ARM 64 v8a
      - android-34 | Google Play ARM 64 v8a
    Android NDK: Not Found
IDEs:
  Android Studio: 2023.2 AI-232.10227.8.2321.11479570
  Xcode:
    version: 15.4/15F31d
    path: /usr/bin/xcodebuild
Languages:
  Java:
    version: 17.0.10
    path: /opt/homebrew/opt/openjdk@17/bin/javac
  Ruby:
    version: 2.6.10
    path: /usr/bin/ruby
npmPackages:
  "@react-native-community/cli": Not Found
  react:
    installed: 18.2.0
    wanted: 18.2.0
  react-native:
    installed: 0.74.2
    wanted: 0.74.2
  react-native-macos: Not Found
npmGlobalPackages:
  "*react-native*": Not Found
Android:
  hermesEnabled: true
  newArchEnabled: false
iOS:
  hermesEnabled: Not found
  newArchEnabled: false
Stacktrace or Logs
N/A
Reproducer

https://github.com/winghouchan/react-native-keyboardavoidingview-infinite-update-mcve

Screenshots and Videos
Reproduction 1

https://github.com/facebook/react-native/assets/6061021/4c89d653-2030-4a65-bf47-8a2ec895fd39

Reproduction 2

https://github.com/facebook/react-native/assets/6061021/43f2a203-232a-425d-a537-91f4f96ea8b5

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 checking out the linked reproducer's example-1 and example-2 branches, running yarn install and yarn android, then inspect KeyboardAvoidingView in React Native DevTools. Compare Android behavior while focusing and unfocusing the input and navigating to Screen2; done means the bottom state remains stable and the footer no longer flickers or bounces.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.