react-native-in-app-review

Depending on your user status and package manager, use one of the following methods to install the package.

For Free Users (Public Registry)

Use standard installation commands:

npm install react-native-in-app-review

OR

yarn add react-native-in-app-review

For Paid Users (Latest Version via PayDevs)

To access the latest version and fixed issues, you must register at paydevs.com and point your package manager to the PayDevs registry.

Using npm or pnpm:

npm set registry https://npm.paydevs.com/
npm login
npm update

Using yarn:

yarn config set registry https://npm.paydevs.com/
yarn login
yarn upgrade

To test your integration on iOS:

• Development Mode: When running the app in development mode, the rating/review request view is always displayed, allowing you to test the UI and UX.
• TestFlight: The method has no effect when calling it from an app distributed via TestFlight.

Device Requirements

In-app reviews work on:

• Android devices (phones and tablets) running Android 5.0 (API level 21) or higher with Google Play Store installed.
• Chrome OS devices with Google Play Store installed.

Testing Integration

You do not need to publish your app to production to test. You can use:

• Internal test tracks
• Internal app sharing

Note: Your applicationID must be available in at least the internal testing track for testing to work.

To ensure a positive user experience and avoid API limitations, follow these guidelines:

• Timing: Trigger the review flow after a user has experienced enough of your app to provide meaningful feedback.
• Frequency: Do not prompt users excessively. Excessive prompting leads to user frustration and may hit API quotas.
• Avoid Leading Questions: Do not ask questions before or during the review process (e.g., "Do you like the app?" or "Would you rate us 5 stars?"). Let the system handle the rating interface.
• Handle Quotas Gracefully: Google Play enforces a quota on how often a review dialog is shown. Do not rely on a specific UI element (like a 'Rate Us' button) to trigger the flow, as the dialog may not appear if the user has reached their quota.

If you follow all guidelines but the popup still does not show, try these steps:

1. Ensure the latest Google Play Store update is installed.
2. Avoid GSuite IDs: The popup may not work if signed in with a GSuite ID. Switch to a standard @gmail address.
3. Single Account: Ensure there is only one Google account on the test device.
4. Tester Status: Ensure the user is explicitly added as a tester if using a testing track.
5. Clear Data: Clear CACHE and STORAGE from the Google Play Store app.
6. Remove Existing Rating: Remove any existing app ratings in the Play Store.
7. Reinstall: Remove the app and reinstall it after performing the steps above.

Since this is a native module, you must mock it to run Jest tests. You may need to mock the return value as a resolved Promise to avoid TypeError: Cannot read property 'then' of undefined.

// Option 1: In a __mocks__/react-native-in-app-review.js file
module.exports = {
  RequestInAppReview: jest.fn().mockImplementation(() => {
    return Promise.resolve();
  }),
  isAvailable: jest.fn(),
};

// Option 2: In a jest.setup.js file
jest.mock('react-native-in-app-review', () => ({
  RequestInAppReview: jest.fn().mockImplementation(() => {
    return Promise.resolve();
  }),
  isAvailable: jest.fn(),
}));

To use Huawei App Gallery reviews, ensure you have integrated HMS into your project, your app is officially released on AppGallery, and users are using AppGallery 11.3.2.302 or later with HUAWEI IDs.

Use requestInAppCommentAppGallery() to trigger the UI. A resultCode of 102 or 103 indicates a rating or comment was successfully submitted.

import InAppReview from 'react-native-in-app-review';

InAppReview.requestInAppCommentAppGallery()
  .then((resultCode) => {
    // resultCode 102 or 103 means Rating or Comment submitted
    console.log('in app comment app gallery', resultCode);
  })
  .catch((error) => {
    console.log(error);
  });