@capawesome/capacitor-settings-launcher
v0.1.1
Published
Capacitor plugin to open native settings screens on Android and iOS.
Maintainers
Readme
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.
- 📦 CocoaPods & SPM: Supports CocoaPods and Swift Package Manager for iOS.
- 🔁 Up-to-date: Always supports the latest Capacitor version.
- 🤝 Compatibility: Works alongside the App Language and Android Battery Optimization plugins.
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
| Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 0.x.x | >=8.x.x | Active support |
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-pluginsThen 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 syncAndroid
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(...)
openAndroidSettings(options: OpenAndroidSettingsOptions) => Promise<void>Open a specific Android system settings screen.
Only available on Android.
| Param | Type |
| ------------- | --------------------------------------------------------------------------------- |
| options | OpenAndroidSettingsOptions |
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
| Prop | Type | Description | Since |
| ---------- | ------------------------------------------------------------------- | ------------------------------------------- | ----- |
| page | AndroidSettingsPage | The Android system settings screen to open. | 0.1.0 |
Enums
AndroidSettingsPage
| Members | Value | Description | Since |
| ------------------------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------- | ----- |
| Accessibility | 'ACCESSIBILITY' | Show settings for accessibility modules. | 0.1.0 |
| AirplaneMode | 'AIRPLANE_MODE' | Show settings to allow entering/exiting airplane mode. | 0.1.0 |
| Apn | 'APN' | Show settings to allow configuration of APNs. | 0.1.0 |
| BatterySaver | 'BATTERY_SAVER' | Show settings to allow configuration of battery saver mode. | 0.1.0 |
| Bluetooth | 'BLUETOOTH' | Show settings to allow configuration of Bluetooth. | 0.1.0 |
| Captioning | 'CAPTIONING' | Show settings for video captioning. | 0.1.0 |
| CastSettings | 'CAST_SETTINGS' | Show settings to allow configuration of cast endpoints. | 0.1.0 |
| DataRoaming | 'DATA_ROAMING' | Show settings for selection of 2G/3G. | 0.1.0 |
| Date | 'DATE' | Show settings to allow configuration of date and time. | 0.1.0 |
| Development | 'DEVELOPMENT' | Show settings to allow configuration of application development settings. | 0.1.0 |
| DeviceInfo | 'DEVICE_INFO' | Show general device information settings (serial number, software version, phone number, etc.). | 0.1.0 |
| Display | 'DISPLAY' | Show settings to allow configuration of display. | 0.1.0 |
| Dream | 'DREAM' | Show Daydream settings. | 0.1.0 |
| Home | 'HOME' | Show settings for selecting the default home app. | 0.1.0 |
| IgnoreBatteryOptimization | 'IGNORE_BATTERY_OPTIMIZATION' | Show screen for controlling which apps can ignore battery optimizations. | 0.1.0 |
| InputMethod | 'INPUT_METHOD' | Show settings to configure input methods, in particular allowing the user to enable input methods. | 0.1.0 |
| InternalStorage | 'INTERNAL_STORAGE' | Show settings for internal storage. | 0.1.0 |
| Locale | 'LOCALE' | Show settings to allow configuration of locale. | 0.1.0 |
| Location | 'LOCATION' | Show settings to allow configuration of current location sources. | 0.1.0 |
| ManageAllApplications | 'MANAGE_ALL_APPLICATIONS' | Show settings to manage all applications. | 0.1.0 |
| ManageApplications | 'MANAGE_APPLICATIONS' | Show settings to manage installed applications. | 0.1.0 |
| MemoryCard | 'MEMORY_CARD' | Show settings for memory card storage. | 0.1.0 |
| Network | 'NETWORK' | Show settings for selecting the network operator. | 0.1.0 |
| Nfc | 'NFC' | Show settings to allow configuration of NFC. | 0.1.0 |
| NfcPayment | 'NFC_PAYMENT' | Show settings to allow configuration of tap and pay. | 0.1.0 |
| NotificationListener | 'NOTIFICATION_LISTENER' | Show settings for managing which apps have access to notification listener services. | 0.1.0 |
| Printing | 'PRINTING' | Show settings for printing. | 0.1.0 |
| Privacy | 'PRIVACY' | Show settings to allow configuration of privacy options. | 0.1.0 |
| Search | 'SEARCH' | Show settings to allow configuration of search. | 0.1.0 |
| Security | 'SECURITY' | Show settings to allow configuration of security and location privacy. | 0.1.0 |
| Sound | 'SOUND' | Show settings to allow configuration of sound and volume. | 0.1.0 |
| Sync | 'SYNC' | Show settings to allow configuration of sync settings. | 0.1.0 |
| Usage | 'USAGE' | Show screen for controlling which apps can access usage statistics. | 0.1.0 |
| UserDictionary | 'USER_DICTIONARY' | Show settings to manage the user input dictionary. | 0.1.0 |
| VoiceInput | 'VOICE_INPUT' | Show settings to configure input methods, in particular allowing the user to enable voice input services. | 0.1.0 |
| Vpn | 'VPN' | Show settings to allow configuration of VPN. | 0.1.0 |
| Wifi | 'WIFI' | Show settings to allow configuration of Wi-Fi. | 0.1.0 |
| Wireless | 'WIRELESS' | Show settings to allow configuration of wireless controls such as Wi-Fi, Bluetooth and mobile networks. | 0.1.0 |
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:
| capacitor-native-settings | Settings Launcher |
| ---------------------------------------------------------- | ---------------------------------------- |
| open({ optionAndroid: 'application_details', optionIOS: 'App' }) | openAppSettings() |
| open({ optionAndroid: 'app_notification', optionIOS: 'App' }) | openNotificationSettings() |
| open({ optionAndroid: '<page>', optionIOS: '...' }) | openAndroidSettings({ page: '<page>' }) |
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.
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
- App Language: Manage the app's own language override, independent of the device language.
- Android Battery Optimization: Manage battery optimization settings and request exemptions on Android.
- App Launcher: Check if an app can be opened and open it.
- Android Intent Launcher: Launch arbitrary Android intents.
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.
