node package manager



This plugin provide the rate this app functionality into your Cordova/Phonegap application

Donate with PayPal

Preview iPad

Some Articles on the Importance of App Reviews and Ratings

Supported platforms

  • iOS
  • Android
  • Windows (experimental)
  • Blackberry (experimental)
  • Windows8 (experimental)


Phonegap / Cordova 3.0.0 or later


  • From apache cordova plugins registry: cordova plugins add cordova-plugin-apprate
  • From github repository: cordova plugins add
  • From phonegap build add the following to your config.xml: <gap:plugin name="cordova-plugin-apprate" />

Customization and usage


All %@ patterns in customLocale object will be automatically replaced to your application title

Available preferences options

Option Type Default Description
useLanguage {String} null custom BCP 47 language tag
displayAppName {String} '' custom application title
promptAgainForEachNewVersion {Boolean} true show dialog again when application version will be updated
usesUntilPrompt {Integer} 3 count of runs of application before dialog will be displayed
openStoreInApp {Boolean} false leave app or no when application page opened in app store (now supported only for iOS)
useCustomRateDialog {Boolean} false use custom view for rate dialog
callbacks.onButtonClicked {Function} null call back function. called when user clicked on rate-dialog buttons
callbacks.onRateDialogShow {Function} null call back function. called when rate-dialog showing
storeAppURL.ios {String} null application id in AppStore {String} null application URL in GooglePlay {String} null application URL in Windows Store
storeAppURL.blackberry {String} null application URL in AppWorld
storeAppURL.windows8 {String} null application URL in WindowsStore
customLocale {Object} null custom locale object


Simple setup and call

AppRate.preferences.storeAppURL = {
  ios: '<my_app_id>',
  android: 'market://details?id=<package_name>',
  windows: 'ms-windows-store://pdp/?ProductId=<the apps Store ID>',
  blackberry: 'appworld://content/[App Id]/',
  windows8: 'ms-windows-store:Review?name=<the Package Family Name of the application>'

Don't Call rate dialog immediately


If false is not present it will ignore usesUntilPrompt, promptAgainForEachNewVersion, and button logic, it will prompt every time.

Override dialog button callback

AppRate.preferences.callbacks.onButtonClicked = function(buttonIndex) {
  console.log("onButtonClicked -> " + buttonIndex);

Set custom language

AppRate.preferences.useLanguage = 'ru';

Set custom Locale object

AppRate.preferences.customLocale = {
  title: "Rate %@";
  message: "If you enjoy using %@, would you mind taking a moment to rate it? It won’t take more than a minute. Thanks for your support!";
  cancelButtonLabel: "No, Thanks";
  laterButtonLabel: "Remind Me Later";
  rateButtonLabel: "Rate It Now";

Full setup

AppRate.preferences = {
  openStoreInApp: true,
  displayAppName: 'My custom app title',
  usesUntilPrompt: 5,
  promptAgainForEachNewVersion: false,
  storeAppURL: {
    ios: '<my_app_id>',
    android: 'market://details?id=<package_name>',
    windows: 'ms-windows-store://pdp/?ProductId=<the apps Store ID>',
    blackberry: 'appworld://content/[App Id]/',
    windows8: 'ms-windows-store:Review?name=<the Package Family Name of the application>'
  customLocale: {
    title: "Rate %@",
    message: "If you enjoy using %@, would you mind taking a moment to rate it? It won’t take more than a minute. Thanks for your support!",
    cancelButtonLabel: "No, Thanks",
    laterButtonLabel: "Remind Me Later",
    rateButtonLabel: "Rate It Now"

Callbacks setup and use custom rate-dialog

AppRate.preferences = {
  useCustomRateDialog: true,
  callbacks: {
    onRateDialogShow: function(callback){
      callback(1) // cause immediate click on 'Rate Now' button 
    onButtonClicked: function(buttonIndex){
      console.log("onButtonClicked -> " + buttonIndex);

Already included translations

Access to locales

// Getting list of names for available locales 
// Getting locale object by name