--- description: Capacitor plugin to open native settings screens, including your app's settings, notification settings, and a catalog of Android system screens, to guide users through permission-recovery flows. Supports Android and iOS. title: Capacitor Settings Launcher Plugin - Capawesome image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/settings-launcher.png --- [Skip to content ](#capacitor-settings-launcher-plugin) [πŸ” Introducing the **Capacitor Vault** plugin β€” store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ Gyroscope ](/docs/sdks/capacitor/gyroscope/) * [ Haptics ](/docs/sdks/capacitor/haptics/) * [ In-App Browser ](/docs/sdks/capacitor/in-app-browser/) * [ Install Referrer ](/docs/sdks/capacitor/install-referrer/) * [ Keep Awake ](/docs/sdks/capacitor/keep-awake/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Localization ](/docs/sdks/capacitor/localization/) * [ Mail Composer ](/docs/sdks/capacitor/mail-composer/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Maps Launcher ](/docs/sdks/capacitor/maps-launcher/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ Network ](/docs/sdks/capacitor/network/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ Node.js ](/docs/sdks/capacitor/nodejs/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Passkeys ](/docs/sdks/capacitor/passkeys/) * [ Password Autofill ](/docs/sdks/capacitor/password-autofill/) * [ PDF Generator ](/docs/sdks/capacitor/pdf-generator/) * [ PDF Viewer ](/docs/sdks/capacitor/pdf-viewer/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Phone Dialer ](/docs/sdks/capacitor/phone-dialer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PixLive ](/docs/sdks/capacitor/pixlive/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Privacy Screen ](/docs/sdks/capacitor/privacy-screen/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Root Detection ](/docs/sdks/capacitor/root-detection/) * [ Screen Brightness ](/docs/sdks/capacitor/screen-brightness/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screen Reader ](/docs/sdks/capacitor/screen-reader/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * Settings Launcher [ Settings Launcher ](/docs/sdks/capacitor/settings-launcher/) * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Enums ](#enums) * [ Migrating from capacitor-native-settings ](#migrating-from-capacitor-native-settings) * [ iOS and the App-Prefs: URL scheme ](#ios-and-the-app-prefs-url-scheme) * [ Changelog ](#changelog) * [ License ](#license) * [ Shake ](/docs/sdks/capacitor/shake/) * [ Silent Mode ](/docs/sdks/capacitor/silent-mode/) * [ SIM ](/docs/sdks/capacitor/sim/) * [ SMS Composer ](/docs/sdks/capacitor/sms-composer/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ Text Zoom ](/docs/sdks/capacitor/text-zoom/) * [ Thermal State ](/docs/sdks/capacitor/thermal-state/) * [ Toast ](/docs/sdks/capacitor/toast/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Volume ](/docs/sdks/capacitor/volume/) * [ Wallet ](/docs/sdks/capacitor/wallet/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ Configuration ](#configuration) * [ Usage ](#usage) * [ API ](#api) * [ Enums ](#enums) * [ Migrating from capacitor-native-settings ](#migrating-from-capacitor-native-settings) * [ iOS and the App-Prefs: URL scheme ](#ios-and-the-app-prefs-url-scheme) * [ Changelog ](#changelog) * [ License ](#license) # Capacitor Settings Launcher Plugin[ΒΆ](#capacitor-settings-launcher-plugin "Permanent link") Capacitor plugin to open native settings screens. [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Features[ΒΆ](#features "Permanent link") * βš™οΈ **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](https://capawesome.io/docs/sdks/capacitor/app-language/) and [Android Battery Optimization](https://capawesome.io/docs/sdks/capacitor/android-battery-optimization/) plugins. Missing a feature? Just [open an issue](https://github.com/capawesome-team/capacitor-plugins/issues) and we'll take a look! ## Newsletter[ΒΆ](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[ΒΆ](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 0.x.x | \>=8.x.x | Active support | ## Installation[ΒΆ](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1) 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: `[](#%5F%5Fcodelineno-2-1)npm install @capawesome/capacitor-settings-launcher [](#%5F%5Fcodelineno-2-2)npx cap sync ` ### Android[ΒΆ](#android "Permanent link") No additional configuration is required for this plugin. ### iOS[ΒΆ](#ios "Permanent link") The `openNotificationSettings(...)` method requires iOS 16 or later. On older versions, the call rejects as unavailable. ## Configuration[ΒΆ](#configuration "Permanent link") No configuration required for this plugin. ## Usage[ΒΆ](#usage "Permanent link") `[](#%5F%5Fcodelineno-3-1)import { SettingsLauncher, AndroidSettingsPage } from '@capawesome/capacitor-settings-launcher'; [](#%5F%5Fcodelineno-3-2) [](#%5F%5Fcodelineno-3-3)const openAppSettings = async () => { [](#%5F%5Fcodelineno-3-4) await SettingsLauncher.openAppSettings(); [](#%5F%5Fcodelineno-3-5)}; [](#%5F%5Fcodelineno-3-6) [](#%5F%5Fcodelineno-3-7)const openNotificationSettings = async () => { [](#%5F%5Fcodelineno-3-8) await SettingsLauncher.openNotificationSettings(); [](#%5F%5Fcodelineno-3-9)}; [](#%5F%5Fcodelineno-3-10) [](#%5F%5Fcodelineno-3-11)const openAndroidSettings = async () => { [](#%5F%5Fcodelineno-3-12) await SettingsLauncher.openAndroidSettings({ [](#%5F%5Fcodelineno-3-13) page: AndroidSettingsPage.Wifi, [](#%5F%5Fcodelineno-3-14) }); [](#%5F%5Fcodelineno-3-15)}; ` ## API[ΒΆ](#api "Permanent link") * [openAndroidSettings(...)](#openandroidsettings) * [openAppSettings()](#openappsettings) * [openNotificationSettings()](#opennotificationsettings) * [Interfaces](#interfaces) * [Enums](#enums) ### openAndroidSettings(...)[ΒΆ](#openandroidsettings "Permanent link") `[](#%5F%5Fcodelineno-4-1)openAndroidSettings(options: OpenAndroidSettingsOptions) => Promise ` Open a specific Android system settings screen. Only available on Android. | Param | Type | | ----------- | --------------------------------------------------------- | | **options** | [OpenAndroidSettingsOptions](#openandroidsettingsoptions) | **Since:** 0.1.0 --- ### openAppSettings()[ΒΆ](#openappsettings "Permanent link") `[](#%5F%5Fcodelineno-5-1)openAppSettings() => Promise ` 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 "Permanent link") `[](#%5F%5Fcodelineno-6-1)openNotificationSettings() => Promise ` 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[ΒΆ](#interfaces "Permanent link") #### OpenAndroidSettingsOptions[ΒΆ](#openandroidsettingsoptions "Permanent link") | Prop | Type | Description | Since | | -------- | ------------------------------------------- | ------------------------------------------- | ----- | | **page** | [AndroidSettingsPage](#androidsettingspage) | The Android system settings screen to open. | 0.1.0 | ### Enums[ΒΆ](#enums "Permanent link") #### AndroidSettingsPage[ΒΆ](#androidsettingspage "Permanent link") | 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`[ΒΆ](#migrating-from-capacitor-native-settings "Permanent link") 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: '', optionIOS: '...' }) | openAndroidSettings({ 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[ΒΆ](#ios-and-the-app-prefs-url-scheme "Permanent link") 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. ## Changelog[ΒΆ](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/settings-launcher/CHANGELOG.md). ## License[ΒΆ](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/settings-launcher/LICENSE). July 7, 2026 Back to top ```json {"@context": "https://schema.org", "@graph": [{"@type": "TechArticle", "@id": "https://capawesome.io/docs/sdks/capacitor/settings-launcher/#article", "headline": "Capacitor Settings Launcher Plugin", "name": "Capacitor Settings Launcher Plugin", "description": "Capacitor plugin to open native settings screens, including your app's settings, notification settings, and a catalog of Android system screens, to guide users through permission-recovery flows. Supports Android and iOS.", "inLanguage": "en", "url": "https://capawesome.io/docs/sdks/capacitor/settings-launcher/", "mainEntityOfPage": "https://capawesome.io/docs/sdks/capacitor/settings-launcher/", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "about": {"@id": "https://capawesome.io/docs/sdks/capacitor/settings-launcher/#software"}}, {"@type": "SoftwareSourceCode", "@id": "https://capawesome.io/docs/sdks/capacitor/settings-launcher/#software", "name": "Capacitor Settings Launcher Plugin", "description": "Capacitor plugin to open native settings screens, including your app's settings, notification settings, and a catalog of Android system screens, to guide users through permission-recovery flows. Supports Android and iOS.", "url": "https://capawesome.io/docs/sdks/capacitor/settings-launcher/", "programmingLanguage": "TypeScript", "runtimePlatform": "Capacitor", "codeRepository": "https://github.com/capawesome-team", "author": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}, "publisher": {"@type": "Organization", "name": "Capawesome", "url": "https://capawesome.io", "logo": {"@type": "ImageObject", "url": "https://capawesome.io/assets/images/logo.svg"}}}]} ```