Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/aravind3566/react-native-in-app-updates/llms.txt

Use this file to discover all available pages before exploring further.

react-native-in-app-updates is a lightweight React Native library that lets you prompt users to update your Android app without ever leaving it. Instead of directing users to the Play Store manually, you trigger Google Play’s native update UI directly from your JavaScript code — keeping users on the latest version with minimal friction. The library wraps Google Play Core’s In-App Updates API via the com.google.android.play:app-update and com.google.android.play:app-update-ktx packages (both at version 2.1.0). All interaction with the native layer is handled through a single exported function, checkForUpdate, and a companion UpdateFlow enum.
This library targets Android only. On iOS, checkForUpdate returns a rejected promise with the message "This library is only available on Android." — no crash, no unhandled exception. You can safely call it in shared code and catch the error gracefully.

​
Update flow types

Two update strategies are supported, matching the modes offered by the Play Core API: Flexible — The update downloads in the background while the user continues using the app. Once the download completes, you can prompt the user to restart and apply the update at a convenient moment. This is the recommended default for non-critical updates. Immediate — A full-screen interstitial blocks the app until the update is installed. The user must complete the update before they can proceed. Use this for security patches or breaking API changes where running an old version is not acceptable. Both flows are represented by the exported UpdateFlow enum: 
export enum UpdateFlow {
  IMMEDIATE = 'IMMEDIATE',
  FLEXIBLE = 'FLEXIBLE',
}

​
Get started

Installation

Add the package to your project and verify the native module is linked correctly.

Quickstart

A complete working example with imports, async call, and error handling in under a minute.

Flexible Update Guide

Deep-dive on background downloads, completion callbacks, and user prompting.

Immediate Update Guide

Force users to update before continuing, with cancellation handling.

​
Peer dependencies and versioning

The library declares open peer dependencies and works with any version of react and react-native. It has been developed and tested against React Native 0.76.5 and React 18.3.1, but no upper bound is enforced.
PackagePeer dependency
react*
react-native*
The current published version is 0.3.1.

​
License

react-native-in-app-updates is released under the MIT License. You are free to use, modify, and distribute it in both open-source and commercial projects.

Build docs developers (and LLMs) love

Get started for freeTalk to us