@capawesome/capacitor-app-review

Capacitor plugin that allows users to submit app store reviews and ratings.

Installation

npm install @capawesome/capacitor-app-review
npx cap sync

Android

Variables

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

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

Configuration

No configuration required for this plugin.

Usage

import { AppReview } from '@capawesome/capacitor-app-review';

const openAppStore = async () => {
  await AppReview.openAppStore();
};

const requestReview = async () => {
  await AppReview.requestReview();
};

API

• openAppStore(...)
• requestReview()
• Interfaces

openAppStore(...)

openAppStore(options?: OpenAppStoreOptions | undefined) => Promise<void>

Open the App Store page for the current app and, if possible, open the dialog to leave a review.

Only available on Android and iOS.

| Param | Type | | ------------- | ------------------------------------------------------------------- | | options | OpenAppStoreOptions |

Since: 6.0.0

requestReview()

requestReview() => Promise<void>

Request an in-app review.

Attention: On iOS, review requests are limited to 3 requests per year.

Only available on Android and iOS (14+).

Since: 6.0.0

Interfaces

OpenAppStoreOptions

| Prop | Type | Description | Since | | ----------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | appId | string | The app ID of the app to open in the App Store. On iOS, this is the Apple ID of your app (e.g. 123456789). You can find the ID in the URL of your app store entry (e.g. https://apps.apple.com/app/id123456789). Only available on iOS. | 6.0.1 |

Testing

In order to test the In-App Review functionality, you need to follow the instructions provided by the respective platform:

• Android
• iOS

Changelog

See CHANGELOG.md.

License

See LICENSE.