Keep every user on the latest version.

Mandatory update (default)

useInAppUpdate(); // same as useInAppUpdate({ mandatory: true })

How it behaves on Android:

Flexible update

Let users keep using the app while the update downloads, then ask them to restart.

import { useInAppUpdate } from '@nameisjayant/react-native-in-app-update';

function UpdateBanner() {
  const { status, progress, completeUpdate } = useInAppUpdate({
    mandatory: false,
  });

  if (status === 'downloading') {
    return <Text>Downloading update… {Math.round(progress * 100)}%</Text>;
  }

  if (status === 'downloaded') {
    return (
      <Snackbar
        text="An update has been downloaded"
        action="Restart"
        onPress={completeUpdate} // installs and restarts the app
      />
    );
  }

  return null;
}

Imperative API

Decide yourself when and how to update, for example only for high-priority releases.

import {
  checkForUpdate,
  startUpdate,
  completeUpdate,
  addInstallStateListener,
} from '@nameisjayant/react-native-in-app-update';

const info = await checkForUpdate();

if (info.updateAvailability === 'available' && info.updatePriority >= 4) {
  if (info.isImmediateAllowed) {
    const result = await startUpdate('immediate'); // 'accepted' | 'canceled' | 'failed'
  }
}

// Track a flexible download
const sub = addInstallStateListener((state) => {
  console.log(state.installStatus, state.bytesDownloaded, state.totalBytesToDownload);
  if (state.installStatus === 'downloaded') completeUpdate();
});

// later
sub.remove();

iOS behaviour

iOS has no equivalent of Play's in-app updates, so the library does what most iOS apps do: compare against the App Store and show your store page in-app. The same hook works unchanged.

Differences from Android

• availableVersion and releaseNotes are filled in. availableVersionCode and updatePriority are always 0.
• clientVersionStalenessDays is days since the App Store release, so you can force an update after a grace period.
• startUpdate() always resolves 'canceled' once the page closes. Apple doesn't tell apps whether the user updated.
• type, completeUpdate() and addInstallStateListener() don't apply. They're accepted and do nothing.
• Apple's lookup can lag a few hours behind a new release.

In-app updates only work for an app installed from Google Play. Use internal app sharing to test without publishing.

1. Set up. In Play Console, enable internal app sharing and add your Google account as a tester. On the device, open Play Store → Settings → About, tap Play Store version 7 times, then turn on Internal app sharing.
2. Install v1. Build a release APK/AAB with versionCode 1, upload it to internal app sharing, open the link on the device and install it.
3. Publish v2. Bump to versionCode 2, build and upload again. Open the new link but don't tap Update. Just let Play see it.
4. Try it. Open the app from step 2. The Play update screen appears; press back and it appears again.

The check uses your app's live App Store listing, so there's nothing to upload.

1. Set the app's bundle ID to one that's live on the App Store.
2. Set its Version (CFBundleShortVersionString) lower than the App Store version, e.g. 0.0.1.
3. Run it on a device or simulator. The App Store page appears; close it and it appears again.