Skip to main content
@capgo/capacitor-intent-launcher Device APIs Open source

Intent Launcher Capacitor plugin

Launch Android intents, open system settings, and interact with other apps using the Intent system

Install

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

Guide

How to use Intent Launcher in Capacitor

Test on device

Download the Capgo app, then scan the QR code.

Intent Launcher plugin preview QR code

Using @capgo/capacitor-intent-launcher

Capacitor Intent Launcher Plugin for launching Android intents and opening system settings on both Android and iOS.

Install

bun add @capgo/capacitor-intent-launcher
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 { IntentLauncher } from '@capgo/capacitor-intent-launcher';

API at a glance

Method Description
startActivityAsync Starts an Android activity for the given action.
openIOSSettings Opens iOS settings screen.
openApplication Opens an application by its package name.
getApplicationIconAsync Gets the application icon as a base64-encoded PNG string.

Examples

startActivityAsync()

Starts an Android activity for the given action.

import { IntentLauncher, ActivityAction } from '@capgo/capacitor-intent-launcher';

// Open location settings
const result = await IntentLauncher.startActivityAsync({
  action: ActivityAction.LOCATION_SOURCE_SETTINGS
});

// Open a specific app settings
const result = await IntentLauncher.startActivityAsync({
  action: ActivityAction.APPLICATION_DETAILS_SETTINGS,
  data: 'package:com.example.app'
});

openIOSSettings()

Opens iOS settings screen.

import { IntentLauncher, IOSSettings } from '@capgo/capacitor-intent-launcher';

// Open app settings (recommended - officially supported by Apple)
await IntentLauncher.openIOSSettings({ option: IOSSettings.App });

// Open WiFi settings (may not work in all iOS versions)
await IntentLauncher.openIOSSettings({ option: IOSSettings.WiFi });

openApplication()

Opens an application by its package name.

import { IntentLauncher } from '@capgo/capacitor-intent-launcher';

// Open Gmail app
await IntentLauncher.openApplication({ packageName: 'com.google.android.gm' });

getApplicationIconAsync()

Gets the application icon as a base64-encoded PNG string.

import { IntentLauncher } from '@capgo/capacitor-intent-launcher';

const { icon } = await IntentLauncher.getApplicationIconAsync({
  packageName: 'com.google.android.gm'
});
if (icon) {
  const img = document.createElement('img');
  img.src = icon;
}

Full reference

Keep going from Using @capgo/capacitor-intent-launcher

If you are using Using @capgo/capacitor-intent-launcher to plan dashboard and API operations, connect it with @capgo/capacitor-intent-launcher for the implementation detail in @capgo/capacitor-intent-launcher, Getting Started for the implementation detail in Getting Started, API Overview for the implementation detail in API Overview, Introduction for the implementation detail in Introduction, and API Keys for the implementation detail in API Keys.

FAQ

Intent Launcher plugin FAQ

How do I install the Intent Launcher plugin in a Capacitor app?

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

Does @capgo/capacitor-intent-launcher work with React, Vue and Angular?

Yes. Intent Launcher 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-intent-launcher 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-intent-launcher free and open source?

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

Can I update code that uses Intent Launcher 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 Intent Launcher 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