rn-apk-update

rn-apk-update is a React Native library designed to provide in-app update functionality for Android applications distributed outside the Google Play Store. This library allows you to check for updates, download APK files, and install them directly within your app, making it a perfect solution for apps distributed via APK files.

Demo

Watch the demo of rn-apk-update:

Features

• Check for updates from a remote server.
• Download APK files with a progress bar.
• Prompt users to update their app with a customizable modal.
• Install APKs directly from within the app.

Installation

To install the library, run the following command:

1yarn add rn-apk-update

or

1npm install rn-apk-update

Peer Dependencies

1yarn add react-native-blob-util@^0.19.11 react-native-device-info@^13.0.0 @react-native-community/progress-bar-android@^1.0.5

or

1npm install react-native-blob-util@^0.19.11 react-native-device-info@^13.0.0 @react-native-community/progress-bar-android@^1.0.5

Android Setup

In order to enable APK downloads and installation in your app, you need to add the following permissions to your AndroidManifest.xml:

1<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />
2<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" android:maxSdkVersion="32" /> 
3<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" android:maxSdkVersion="29" />

These permissions are required to:

Allow the app to request permission to install APKs from unknown sources. Handle APK files stored on external storage (depending on your app’s target SDK version).

Usage

Below is an example of how to use rn-apk-update in a React Native app:

1import { useState, useRef } from 'react';
2import { StyleSheet, View, Button } from 'react-native';
3import ApkUpdate, { type UpdatePromptMethods } from 'rn-apk-update';
4
5const App = () => {
6  const [downloadProgress, setDownloadProgress] = useState<number>(0);
7  const { checkForUpdate, UpdatePrompt, downloadAndInstallApk } = ApkUpdate();
8  const updatePromptRef = useRef<UpdatePromptMethods>(null);
9
10  const handleCheckForUpdates = async () => {
11    const isUpdateAvailable = await checkForUpdate('https://example.com/version.json');
12
13    if (isUpdateAvailable) {
14      updatePromptRef?.current?.prompt(
15        'Update Available', 'A new version of the app is available.\nDo you want to update?', [
16        {
17          title: 'Update',
18          onPress: () => downloadAndInstallApk('https://example.com/app.apk', {
19            onProgress(progress: number) {
20              setDownloadProgress(progress);
21            },
22            onProgressComplete() {
23              updatePromptRef?.current?.close();
24            },
25          }),
26        },
27        { title: 'Cancel', onPress: () => updatePromptRef?.current?.close() },
28      ]);
29    }
30  };
31
32  return (
33    <View style={styles.container}>
34      <UpdatePrompt ref={updatePromptRef} progress={downloadProgress} />
35
36      <Button
37        title="Check for Updates"
38        onPress={handleCheckForUpdates}
39      />
40    </View>
41  );
42};
43
44const styles = StyleSheet.create({
45  container: {
46    flex: 1,
47    alignItems: 'center',
48    justifyContent: 'center',
49  },
50});
51
52export default App;

Customization

Custom Styling For Update Prompt

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

---