https://github.com/capacitor-community/in-app-review

Let users rate your app using native review app dialog for both Android and iOS.
https://github.com/capacitor-community/in-app-review

capacitor capacitor-plugin cordova hacktoberfest ionic

Last synced: 5 days ago
JSON representation

Let users rate your app using native review app dialog for both Android and iOS.

• Host: GitHub
• URL: https://github.com/capacitor-community/in-app-review
• Owner: capacitor-community
• License: mit
• Created: 2019-09-16T17:54:35.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-09-03T05:02:15.000Z (3 months ago)
• Last Synced: 2024-11-30T03:42:46.401Z (13 days ago)
• Topics: capacitor, capacitor-plugin, cordova, hacktoberfest, ionic
• Language: TypeScript
• Homepage:
• Size: 2.2 MB
• Stars: 167
• Watchers: 8
• Forks: 20
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-capacitor - Rate app - Let users rate your app using native rate app dialog for both Android and iOS. (Other plugins)

README

        



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

```

--------------------