@capacitor-community/in-app-review

In App Review

@capacitor-community/in-app-review

Capacitor Plugin for prompting users to submit app store reviews.

[!NOTE] This repository is the successor to capacitor-rate-app by Nodonisko.

Please migrate for continued support and updates.

Introduction

This plugin lets you prompt users to submit app store ratings and reviews without the inconvenience of leaving your app. It uses the built-in native UI components that iOS and Android provide.

_{Example of the in-app review flow for a user on Android:}

[!IMPORTANT] To protect user privacy and avoid API misuse, there are strict guidelines that your app should follow.

_{Design guidelines Android: source
Design guidelines iOS: source, source, source, source}

[!IMPORTANT] If - during development and testing - the dialog is not shown, make sure all prerequisites have been met. Generally that means following the design guidelines and making sure your test environment is setup correctly.

_{Design guidelines: see explainer paragraph above
Test Environment setup Android: source
Test Environment setup iOS: source}

Installation

npm install @capacitor-community/in-app-review
npx cap sync

Usage

import { InAppReview } from '@capacitor-community/in-app-review';

InAppReview.requestReview();

Android

Variables

This plugin will use the following project variables (defined in your app's variables.gradle file):

• googleAndroidPlayReviewVersion: version of com.google.android.play:review (default: 2.0.2)

API

• requestReview()

requestReview()

requestReview() => Promise<void>