Capacitor Native Settings

Capacitor plugin to open native settings screens for Android and iOS.

Plugin versions

Install

npm install capacitor-native-settings
npx cap sync

Example

import { NativeSettings, AndroidSettings, IOSSettings } from 'capacitor-native-settings';

/**
 * ⚠️ iOS limitation
 *
 * Apple officially supports opening only the app-specific settings screen.
 * Other options rely on undocumented URL schemes and may stop working
 * or cause App Store rejection.
 */
NativeSettings.open({
  optionAndroid: AndroidSettings.ApplicationDetails, 
  optionIOS: IOSSettings.App
})

NativeSettings.openAndroid({
  option: AndroidSettings.ApplicationDetails,
});

/**
 * ⚠️ iOS limitation
 *
 * Apple officially supports opening only the app-specific settings screen.
 * Other options rely on undocumented URL schemes and may stop working
 * or cause App Store rejection.
 */
NativeSettings.openIOS({
  option: IOSSettings.App,
});

API

• open(...)
• openAndroid(...)
• openIOS(...)
• Interfaces
• Enums

Capacitor NativeSettings plugin interface.

Provides access to native Android and iOS system settings screens.

open(...)

open(options: PlatformOptions) => Promise<{ status: boolean; }>

Opens the specified settings option on the current platform.

Returns: Promise<{ status: boolean; }>

openAndroid(...)

openAndroid(options: AndroidOptions) => Promise<{ status: boolean; }>

Opens the specified Android settings screen.

Returns: Promise<{ status: boolean; }>

openIOS(...)

openIOS(options: IOSOptions) => Promise<{ status: boolean; }>

Opens the specified iOS settings screen.

Returns: Promise<{ status: boolean; }>

Interfaces

PlatformOptions

Platform-specific options.

AndroidOptions

Android-only options.

IOSOptions

iOS-only options.

Enums

AndroidSettings