Skip to main content

Android Inline Install Capacitor plugin

Install app updates directly within the app without leaving to Play Store

Install

bun add @capgo/capacitor-android-inline-install bunx cap sync
npm, pnpm or yarn
  • npm install @capgo/capacitor-android-inline-install
  • pnpm add @capgo/capacitor-android-inline-install
  • yarn add @capgo/capacitor-android-inline-install

Guide

How to use Android Inline Install in Capacitor

Test on device

Download the Capgo app, then scan the QR code.

Android Inline Install plugin preview QR code

Using @capgo/capacitor-android-inline-install

Android Inline Install Plugin for triggering Google Play in-app install flows.

Install

bun add @capgo/capacitor-android-inline-install
bunx cap sync

bunx cap sync copies the plugin's native code into your native projects. Run it again after every plugin upgrade.

Import

import { AndroidInlineInstall } from '@capgo/capacitor-android-inline-install';

API at a glance

Method Description
startInlineInstall Start an inline install flow using the Google Play overlay.

Examples

startInlineInstall()

Start an inline install flow using the Google Play overlay.

import { AndroidInlineInstall } from '@capgo/capacitor-android-inline-install';

const result = await AndroidInlineInstall.startInlineInstall({
  id: 'com.example.app',
  referrer: 'my-referrer',
  overlay: true,
  fallback: true
});

if (result.started) {
  console.log('Install flow started');
  if (result.fallbackUsed) {
    console.log('Using fallback Play Store link');
  }
}

Full reference

Keep going from Using @capgo/capacitor-android-inline-install

If you are using Using @capgo/capacitor-android-inline-install to plan store approval and distribution, connect it with @capgo/capacitor-android-inline-install for the implementation detail in @capgo/capacitor-android-inline-install, Getting Started for the implementation detail in Getting Started, @capgo/capacitor-in-app-review for the implementation detail in @capgo/capacitor-in-app-review, Using @capgo/capacitor-in-app-review for the native capability in Using @capgo/capacitor-in-app-review, and @capgo/capacitor-native-market for the implementation detail in @capgo/capacitor-native-market.

FAQ

Android Inline Install plugin FAQ

How do I install the Android Inline Install plugin in a Capacitor app?

Run "bun add @capgo/capacitor-android-inline-install" (or "npm install @capgo/capacitor-android-inline-install"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-android-inline-install" in your app code.

Does @capgo/capacitor-android-inline-install work with React, Vue and Angular?

Yes. Android Inline Install is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Which Capacitor version does @capgo/capacitor-android-inline-install support?

Capgo plugins follow Capacitor's major version: use the plugin major version that matches your Capacitor major version (for example plugin v8 with Capacitor 8). The compatibility table in the GitHub README lists the maintained versions.

Is @capgo/capacitor-android-inline-install free and open source?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-android-inline-install/ and the package is free to install from npm. Bug reports and pull requests are welcome.

Can I update code that uses Android Inline Install without an App Store review?

Installing or upgrading the plugin changes native code, so it needs a new store build. After that, JavaScript, HTML and CSS changes that call the plugin can ship instantly with Capgo live updates.

Ship Android Inline Install changes without waiting for app review

Once the plugin is in your store build, Capgo live updates push your JavaScript, HTML and CSS changes to users in minutes.

Start with Capgo