Capacitor Settings Launcher Plugin

Capacitor plugin to open native settings screens.

Features

• ⚙️ App settings: Open the settings screen of your app to guide users to grant a denied permission.
• 🔔 Notification settings: Open the notification settings screen of your app.
• 🤖 Android settings: Open a large catalog of Android system settings screens.
• 🔒 App Store safe: Uses only official platform APIs — no private URL schemes.
• 🤝 Compatibility: Works alongside the App Language and Android Battery Optimization plugins.
• 📦 CocoaPods & SPM: Supports CocoaPods and Swift Package Manager for iOS.
• 🔁 Up-to-date: Always supports the latest Capacitor version.

Missing a feature? Just open an issue and we'll take a look!

Use Cases

The Settings Launcher plugin is typically used to guide users to the right system settings screen, for example:

• Permission recovery: Open your app's settings screen so users can grant a previously denied permission.
• Notification opt-in: Guide users to your app's notification settings when notifications are disabled.
• Connectivity troubleshooting: Open the Wi-Fi, Bluetooth, or airplane mode settings on Android when your app requires a connection.
• Onboarding flows: Send users to Android settings screens such as locale, location, or NFC to enable features your app depends on.

Compatibility

Installation

You can use our AI-Assisted Setup to install the plugin. Add the Capawesome Skills to your AI tool using the following command:

npx skills add capawesome-team/skills --skill capacitor-plugins

Then use the following prompt:

 Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capawesome/capacitor-settings-launcher` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

npm install @capawesome/capacitor-settings-launcher
npx cap sync

Android

No additional configuration is required for this plugin.

iOS

The openNotificationSettings(...) method requires iOS 16 or later. On older versions, the call rejects as unavailable.

Configuration

No configuration required for this plugin.

Usage

The following examples show how to open your app's settings screen, open your app's notification settings, and open an Android system settings screen.

Open the settings screen of your app

Open your app's settings screen, for example to guide users to grant a previously denied permission. Only available on Android and iOS:

import { SettingsLauncher } from '@capawesome/capacitor-settings-launcher';

const openAppSettings = async () => {
  await SettingsLauncher.openAppSettings();
};

Open the notification settings of your app

Open your app's notification settings screen, for example when the user has disabled notifications. On iOS, this method requires iOS 16 or later and rejects on older versions. Only available on Android and iOS:

import { SettingsLauncher } from '@capawesome/capacitor-settings-launcher';

const openNotificationSettings = async () => {
  await SettingsLauncher.openNotificationSettings();
};

Open an Android system settings screen

Use the AndroidSettingsPage enum to open one of the many supported Android system settings screens, such as Wi-Fi, Bluetooth, or location. Only available on Android:

import { SettingsLauncher, AndroidSettingsPage } from '@capawesome/capacitor-settings-launcher';

const openAndroidSettings = async () => {
  await SettingsLauncher.openAndroidSettings({
    page: AndroidSettingsPage.Wifi,
  });
};

API

• openAndroidSettings(...)
• openAppSettings()
• openNotificationSettings()
• Interfaces
• Enums

openAndroidSettings(...)

openAndroidSettings(options: OpenAndroidSettingsOptions) => Promise<void>

Open a specific Android system settings screen.

Only available on Android.

Since: 0.1.0

openAppSettings()

openAppSettings() => Promise<void>

Open the settings screen of your app.

This is the recommended way to guide users to grant a previously denied permission.

Only available on Android and iOS.

Since: 0.1.0

openNotificationSettings()

openNotificationSettings() => Promise<void>

Open the notification settings screen of your app.

On iOS, this method requires iOS 16 or later and rejects on older versions.

Only available on Android and iOS.

Since: 0.1.0

Interfaces

OpenAndroidSettingsOptions

Enums

AndroidSettingsPage

Migrating from capacitor-native-settings

This plugin replaces the single open(...) method of capacitor-native-settings with three explicit methods. Instead of passing an optionAndroid and optionIOS to a single method, call the method that matches your intent:

On iOS, openAppSettings() and openNotificationSettings() cover the officially supported destinations. The various optionIOS deep links into specific iOS settings sections are intentionally not supported (see below).

iOS and the App-Prefs: URL scheme

This plugin deliberately does not provide deep links into specific iOS system settings sections (e.g. Wi-Fi, Bluetooth, Location). Those links rely on the private App-Prefs: URL scheme, which is not part of the public iOS API. Apps that use it risk rejection during App Store review, and Apple may break it without notice between iOS releases.

Instead, this plugin only uses official Apple APIs: UIApplication.openSettingsURLString (your app's settings) and openNotificationSettingsURLString (your app's notification settings, iOS 16+). This is a deliberate design decision to keep your app App Store safe.

FAQ

How is this plugin different from other similar plugins?

It opens native settings screens through three explicit, fully typed methods — your app's settings, your app's notification settings, and a large catalog of Android system screens such as Wi-Fi, Bluetooth, and location — so each call clearly matches your intent. It relies only on official Apple and Android APIs and deliberately avoids the private App-Prefs: URL scheme, which keeps your app App Store safe. Actively maintained against the latest Capacitor version, it is built to guide users to exactly the right settings screen on Android and iOS.

How can I guide users to grant a previously denied permission?

Call the openAppSettings method to open the settings screen of your app. This is the recommended way to let users grant a permission that they previously denied, since neither Android nor iOS shows the permission prompt again after a denial. See the usage example above.

How does this plugin work with the Permissions plugin?

Use the Permissions plugin's checkPermissions() method to detect a denied permission state, then call openAppSettings() from this plugin to send the user straight to your app's settings screen to grant it manually. The two plugins are commonly used together for this check-then-recover flow.

Why can't I open specific iOS settings sections like Wi-Fi or Bluetooth?

Deep links into specific iOS system settings sections rely on the private App-Prefs: URL scheme, which is not part of the public iOS API. Apps that use it risk rejection during App Store review, and Apple may break it without notice between iOS releases. This plugin deliberately only uses official Apple APIs to keep your app App Store safe (see iOS and the App-Prefs: URL scheme).

Why does openNotificationSettings reject on iOS?

The openNotificationSettings(...) method requires iOS 16 or later. On older iOS versions, the call rejects as unavailable. The openAppSettings() method works on all supported iOS versions and also gives users access to the notification settings of your app.

Which Android settings screens can I open?

The openAndroidSettings(...) method supports a large catalog of Android system settings screens, including Wi-Fi, Bluetooth, location, locale, NFC, display, sound, and many more. See the AndroidSettingsPage enum in the API reference for the complete list. This method is only available on Android.

How do I migrate from capacitor-native-settings?

This plugin replaces the single open(...) method of capacitor-native-settings with three explicit methods: openAppSettings(), openNotificationSettings() and openAndroidSettings(...). See the migration guide above for a mapping table.

Can I use this plugin with Ionic, React, Vue or Angular?

Yes, the plugin is framework-agnostic. It works in any Capacitor app regardless of the web framework, including Ionic with Angular, React, or Vue, as well as plain JavaScript projects.

Related Plugins

• Android Battery Optimization: Manage battery optimization settings and request exemptions on Android.
• Android Intent Launcher: Launch arbitrary Android intents.
• App Language: Manage the app's own language override, independent of the device language.
• App Launcher: Check if an app can be opened and open it.
• Permissions: Check and request device permissions with a unified API.

Newsletter

Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our Capawesome Newsletter.

Changelog

See CHANGELOG.md.

License

See LICENSE.