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](https://github.com/Nodonisko).
>
> Please [migrate](https://github.com/capacitor-community/in-app-review/releases/tag/v6.0.0) 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](https://developer.android.com/guide/playcore/in-app-review)
>
> Design guidelines iOS: [source](https://developer.apple.com/documentation/storekit/skstorereviewcontroller/3566727-requestreview), [source](https://developer.apple.com/app-store/ratings-and-reviews/), [source](https://developer.apple.com/documentation/storekit/requesting_app_store_reviews), [source](https://developer.apple.com/design/human-interface-guidelines/ratings-and-reviews)
> [!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](https://developer.android.com/guide/playcore/in-app-review/test)
>
> Test Environment setup iOS: [source](https://developer.apple.com/documentation/storekit/skstorereviewcontroller/3566727-requestreview#4278434)
## Installation
```bash
npm install @capacitor-community/in-app-review
npx cap sync
```
## Usage
```ts
import { InAppReview } from '@capacitor-community/in-app-review';
InAppReview.requestReview();
```
## API
* [`requestReview()`](#requestreview)
### requestReview()
```typescript
requestReview() => Promise
```
--------------------