djaramilloj / capacitor-apprate-plugin

Capacitor in app rating plugin

Capacitor Rate App

Let users rate your app using native rate app dialog for both Android and iOS.

Please be aware of iOS limitations, read below!

Installation

$ npm i --save capacitor-rate-app

or

$ yarn add capacitor-rate-app

Don't forget run cap sync command afterwards.

Android configuration

In file android/app/src/main/java/**/**/MainActivity.java, add the plugin to the initialization list:

import com.capacitor.rateApp.CapacitorRateApp;
[...]
this.init(savedInstanceState, new ArrayList<Class<? extends Plugin>>() {{
  [...]
  add(CapacitorRateApp.class);
  [...]
}});

iOS configuration

No configuration needed, works out-of-box.

iOS limitations - IMPORTANT!

1. You should only call request review when it makes sense in the user experience flow of your app, and then call the method only after the user has demonstrated some engagements on an app.
2. You have no control over exactly what’s happening and the dialog displayed or its callbacks, that is determined entirely by the system.
3. The system may or may not show a rating prompt, it’s not appropriate to call the API in response to a button tap or other user action because it is not going to happen every time.
4. No matter how many times you call the API, the system will only show up to a maximum of 3 prompts to the same user in a 365-day period.
5. The App Store defaults to showing ratings and reviews only for your app’s most recent version.
6. The User can turn off this in settings.
7. Apple might mandate this flow in future.
8. In dev env, dialog is always shown, but you can't submit review.

Usage

import { RateApp } from "capacitor-rate-app";

RateApp.requestReview()

Demo

For more detailed example check demo app check demo app.