Home

Awesome

<p align="center"><br><img src="https://user-images.githubusercontent.com/236501/85893648-1c92e880-b7a8-11ea-926d-95355b8175c7.png" width="128" height="128" /></p> <h3 align="center">In App Review</h3> <p align="center"><strong><code>@capacitor-community/in-app-review</code></strong></p> <p align="center"> Capacitor Plugin for prompting users to submit app store reviews. </p> <p align="center"> <img src="https://img.shields.io/maintenance/yes/2024?style=flat-square" /> <a href="https://www.npmjs.com/package/@capacitor-community/in-app-review"><img src="https://img.shields.io/npm/l/@capacitor-community/in-app-review?style=flat-square" /></a> <br> <a href="https://www.npmjs.com/package/@capacitor-community/in-app-review"><img src="https://img.shields.io/npm/dw/@capacitor-community/in-app-review?style=flat-square" /></a> <a href="https://www.npmjs.com/package/@capacitor-community/in-app-review"><img src="https://img.shields.io/npm/v/@capacitor-community/in-app-review?style=flat-square" /></a> </p>

[!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.

<sub>Example of the in-app review flow for a user on Android:</sub> <br> <img src="https://github.com/capacitor-community/privacy-screen/assets/35837839/11ec6398-20df-46f3-9687-2c7f0990fc37" width="640" /> <br>

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

<sub>Design guidelines Android: source</sub> <br> <sub>Design guidelines iOS: source, source, source, source</sub>

[!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.

<sub>Design guidelines: see explainer paragraph above</sub> <br> <sub>Test Environment setup Android: source</sub> <br> <sub>Test Environment setup iOS: source</sub>

Installation

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

Usage

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

InAppReview.requestReview();

API

<docgen-index> </docgen-index> <docgen-api> <!--Update the source file JSDoc comments and rerun docgen to update the docs below-->

requestReview()

requestReview() => Promise<void>
</docgen-api>