Getting Started

Copy a setup prompt with the install steps and the full markdown guide for this plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-in-app-review`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/in-app-review/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Install

bun add @capgo/capacitor-in-app-review
bunx cap sync

Import

import { CapgoInAppReview } from '@capgo/capacitor-in-app-review';

API Overview

`requestReview`

Request an in-app review from the user.

This method triggers the native in-app review dialog provided by the platform. On iOS, it uses SKStoreReviewController. On Android, it uses the Play In-App Review API.

Important Notes:

The review dialog may not be displayed every time this method is called. Both Apple and Google have guidelines that limit how often the prompt can appear.
There is no guarantee that the user will see the review prompt.
The method resolves successfully even if the dialog was not shown.
Do not call this in response to a user action like a button tap. Instead, call it at natural points in your app’s user flow.

import { CapgoInAppReview } from '@capgo/capacitor-in-app-review';

// Request a review at an appropriate moment in your app
await CapgoInAppReview.requestReview();

Source Of Truth

This page is generated from the plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.