@capacitor-community/in-app-review
v6.0.0
Published
Lets you prompt users to submit app store ratings and reviews without leaving your app - using platform native dialogs.
Downloads
71,945
Maintainers
Readme
[!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();
API
requestReview()
requestReview() => Promise<void>