KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #cli #claude-code #codex #developer-tools #open-source #agent-skills #ai #dsh-plugin #llm #windows

capacitor-native-settings

★ 139 Open GitHub ↗

Capacitor plugin to open native settings screens for android and iOS

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Capacitor Native Settings

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

## Plugin versions

| Capacitor version | Plugin version |
| ----------------- | -------------- |
| v8                | >= v8.0.0      |
| v7                | >= v7.0.1      |
| v6                | >= v6.0.0      |
| v5                | >= v5.0.0      |
| v4                | >= v4.0.0      |
| v3                | <= v2.0.1      |

## Install

```bash
npm install capacitor-native-settings
npx cap sync
```

## Example

```js
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,
});

## API

<docgen-index>

* [`open(...)`](#open)
* [`openAndroid(...)`](#openandroid)
* [`openIOS(...)`](#openios)
* [Interfaces](#interfaces)
* [Enums](#enums)

</docgen-index>

<docgen-api>

Capacitor NativeSettings plugin interface.

Provides access to native Android and iOS system settings screens.

### open(...)

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

Opens the specified settings option on the current platform.

| Param         | Type                                                        | Description                         |
| ------------- | ----------------------------------------------------------- | ----------------------------------- |
| **`options`** | <code><a href="#platformoptions">PlatformOptions</a></code> | Platform-specific settings options. |

**Returns:** <code>Promise&lt;{ status: boolean; }&gt;</code>

--------------------

### openAndroid(...)

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

Opens the specified Android settings screen.

| Param         | Type                                                      | Description               |
| ------------- | --------------------------------------------------------- | ------------------------- |
| **`options`** | <code><a href="#androidoptions">AndroidOptions</a></code> | Android settings options. |

**Returns:** <code>Promise&lt;{ status: boolean; }&gt;</code>

--------------------

### openIOS(...)

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

Opens the specified iOS settings screen.

| Param         | Type                                              | Description           |
| ------------- | ------------------------------------------------- | --------------------- |
| **`options`** | <code><a href="#iosoptions">IOSOptions</a></code> | iOS settings options. |

**Returns:** <code>Promise&lt;{ status: boolean; }&gt;</code>

--------------------

### Interfaces

#### PlatformOptions

Platform-specific options.

| Prop                | Type                                                        |
| ------------------- | ----------------------------------------------------------- |
| **`optionAndroid`** | <code><a href="#androidsettings">AndroidSettings</a></code> |
| **`optionIOS`**     | <code><a href="#iossettings">IOSSettings</a></code>         |

#### AndroidOptions

Android-only options.

| Prop         | Type                                                        |
| ------------ | ----------------------------------------------------------- |
| **`option`** | <code><a href="#androidsettings">AndroidSettings</a></code> |

#### IOSOptions

iOS-only options.

| Prop         | Type                                                |
| ------------ | --------------------------------------------------- |
| **`option`** | <code><a href="#iossettings">IOSSettings</a></code> |

### Enums

#### AndroidSettings

| Members                      | Value                                   | Description                                                                                                                                                   |
| ---------------------------- | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **`Accessibility`**          | <code>'accessibility'</code>            | Show settings for accessibility modules                                                                                                                       |
| **`Account`**                | <code>'account'</code>                  | Show add account screen for creating a new account                                                                                                            |
| **`AirplaneMode`**           | <code>'airplane_mode'</code>            | Show settings to allow entering/exiting airplane mode                                                                                                         |
| **`Apn`**                    | <code>'apn'</code>                      | Show settings to allow configuration of APNs                                                                                                                  |
| **`ApplicationDetails`**     | <code>'application_details'</code>      | Show screen of details about a particular application                                                                                                         |
| **`ApplicationDevelopment`** | <code>'application_development'</code>  | Show settings to allow configuration of application development-related settings                                                                              |
| **`Application`**            | <code>'application'</code>              | Show settings to allow configuration of application-related settings                                                                                          |
| **`AppNotification`**        | <code>'app_notification'</code>         | Show settings to allow configuration of application-specific notifications                                                                                    |
| **`BatteryOptimization`**    | <code>'battery_optimization'</code>     | Show screen for controlling which apps can ignore battery optimizations                                                                                       |
| **`Bluetooth`**              | <code>'bluetooth'</code>                | Show settings to allow configuration of Bluetooth                                                                                                             |
| **`Captioning`**             | <code>'captioning'</code>               | Show settings for video captioning                                                                                                                            |
| **`Cast`**                   | <code>'cast'</code>                     | Show settings to allow configuration of cast endpoints                                                                                                        |
| **`DataRoaming`**            | <code>'data_roaming'</code>             | Show settings for selection of 2G/3G/4G                                                                                                                       |
| **`Date`**                   | <code>'date'</code>                     | Show settings to allow configuration of date and time                                                                                                         |
| **`Display`**                | <code>'display'</code>                  | Show settings to allow configuration of display                                                                                                               |
| **`Dream`**                  | <code>'dream'</code>                    | Show Daydream settings                                                                                                                                        |
| **`Home`**                   | <code>'home'</code>                     | Show Home selection settings                                                                                                                                  |
| **`Keyboard`**               | <code>'keyboard'</code>                 | Show settings to configure input methods, in particular allowing the user to enable input methods                                                             |
| **`KeyboardSubType`**        | <code>'keyboard_subtype'</code>         | Show settings to enable/disable input method subtypes                                                                                                         |
| **`Locale`**                 | <code>'locale'</code>                   | Show settings to allow configuration of locale                                                                                                                |
| **`Location`**               | <code>'location'</code>                 | Show settings to allow configuration of current location sources                                                                                              |
| **`ManageApplications`**     | <code>'manage_applications'</code>      | Show settings to manage installed applications                                                                                                                |
| **`ManageAllApplications`**  | <code>'manage_all_applications'</code>  | Show settings to manage all applications                                                                                                                      |
| **`MemoryCard`**             | <code>'memory_card'</code>              | Show settings for memory card storage                                                                                                                         |
| **`Network`**                | <code>'network'</code>                  | Show settings for selecting the network operator                                                                                                              |
| **`NfcSharing`**             | <code>'nfcsharing'</code>               | Show NFC Sharing settings                                                                                                                                     |
| **`NfcPayment`**             | <code>'nfc_payment'</code>              | Show NFC Tap & Pay settings                                                                                                                                   |
| **`NfcSettings`**            | <code>'nfc_settings'</code>             | Show NFC settings                                                                                                                                             |
| **`Print`**                  | <code>'print'</code>                    | Show the top level print settings                                                                                                                             |
| **`Privacy`**                | <code>'privacy'</code>                  | Show settings to allow configuration of privacy options                                                                                                       |
| **`QuickLaunch`**            | <code>'quick_launch'</code>             | Show settings to allow configuration of quick launch shortcuts                                                                                                |
| **`Search`**                 | <code>'search'</code>                   | Show settings for global search                                                                                                                               |
| **`Security`**               | <code>'security'</code>                 | Show settings to allow configuration of security and location privacy                                                                                         |
| **`Settings`**               | <code>'settings'</code>                 | Show system settings                                                                                                                                          |
| **`ShowRegulatoryInfo`**     | <code>'show_regulatory_info'</code>     | Show the regulatory information screen for the device                                                                                                         |
| **`Sound`**                  | <code>'sound'</code>                    | Show settings to a llow configuration of sound and volume                                                                                                     |
| **`Storage`**                | <code>'storage'</code>                  | Show settings for internal storage                                                                                                                            |
| **`Sync`**                   | <code>'sync'</code>                     | Show settings to allow configuration of sync settings                                                                                                         |
| **`TextToSpeech`**           | <code>'text_to_speech'</code>           | Show settings for configuring Text-to-Speech (TTS) output                                                                                                     |
| **`Usage`**                  | <code>'usage'</code>                    | Show settings to control access to usage information                                                                                                          |
| **`UserDictionary`**         | <code>'user_dictionary'</code>          | Show settings to manage the user input dictionary                                                                                                             |
| **`VoiceInput`**             | <code>'voice_input'</code>              | Show settings to configure input methods, in particular allowing the user to enable input methods                                                             |
| **`VPN`**                    | <code>'vpn'</code>                      | Show settings to allow configuration of VPN                                                                                                                   |
| **`Wifi`**                   | <code>'wifi'</code>                     | Show settings to allow configuration of Wi-Fi                                                                                                                 |
| **`WifiIp`**                 | <code>'wifi_ip'</code>                  | Show settings to allow configuration of a static IP address for Wi-Fi                                                                                         |
| **`Wireless`**               | <code>'wireless'</code>                 | Show settings to allow configuration of wireless controls such as Wi-Fi, Bluetooth and Mobile networks                                                        |
| **`ZenMode`**                | <code>'zen_mode'</code>                 | Zen mode settings.                                                                                                                                            |
| **`ZenModePriority`**        | <code>'zen_mode_priority'</code>        | Zen mode priority settings. Note that this may not work on every single device. See: https://github.com/RaphaelWoude/capacitor-native-settings/pull/63        |
| **`ZenModeBlockedEffects`**  | <code>'zen_mode_blocked_effects'</code> | Zen mode blocked effects settings. Note that this may not work on every single device. See: https://github.com/RaphaelWoude/capacitor-native-settings/pull/63 |

#### IOSSettings

| Members                        | Value                                   | Description                                                                                                               |
| ------------------------------ | --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| **`About`**                    | <code>'about'</code>                    | Settings &gt; About page                                                                                                  |
| **`App`**                      | <code>'app'</code>                      | Opens your app-specific settings screen. Note that this is the only officially supported settings screen by Apple.        |
| **`AppNotification`**          | <code>'appNotification'</code>          | Opens app-specific notification settings screen for iOS 15.4+; opens general app-specific settings for earlier versions." |
| **`AutoLock`**                 | <code>'autoLock'</code>                 | Used to set if and when the screen should be automatically locked.                                                        |
| **`Bluetooth`**                | <code>'bluetooth'</code>                | Bluetooth settings. Allows the users to enable/disable bluetooth and to search for devices.                               |
| **`DateTime`**                 | <code>'dateTime'</code>                 | Date and time settings.                                                                                                   |
| **`FaceTime`**                 | <code>'facetime'</code>                 | FaceTime settings.                                                                                                        |
| **`General`**                  | <code>'general'</code>                  | Opens iOS general settings screen.                                                                                        |
| **`Keyboard`**                 | <code>'keyboard'</code>                 | Keyboard settings.                                                                                                        |
| **`ICloud`**                   | <code>'iCloud'</code>                   | iCloud settings.                                                                                                          |
| **`ICloudStorageBackup`**      | <code>'iCloudStorageBackup'</code>      | iCloud Storage and Backup settings.                                                                                       |
| **`International`**            | <code>'international'</code>            | Language and region settings.                                                                                             |
| **`LocationServices`**         | <code>'locationServices'</code>         | Show settings to allow configuration of current location sources                                                          |
| **`Music`**                    | <code>'music'</code>                    | Music settings.                                                                                                           |
| **`Notes`**                    | <code>'notes'</code>                    | Notes settings.                                                                                                           |
| **`Notifications`**            | <code>'notifications'</code>            | Notifications settings.                                                                                                   |
| **`Phone`**                    | <code>'phone'</code>                    | Phone settings.                                                                                                           |
| **`Photos`**                   | <code>'photos'</code>                   | Photos settings.                                                                                                          |
| **`ManagedConfigurationList`** | <code>'managedConfigurationList'</code> | Allows the user to manage configuration profiles that are installed on the phone.                                         |
| **`Reset`**                    | <code>'reset'</code>                    | Screen where the user can reset the phone to factory settings.                                                            |
| **`Ringtone`**                 | <code>'ringtone'</code>                 | Ringtone settings.                                                                                                        |
| **`Sounds`**                   | <code>'sounds'</code>                   | Used to set phone volume, vibration settings, etc.                                                                        |
| **`SoftwareUpdate`**           | <code>'softwareUpdate'</code>           | Software update screen.                                                                                                   |
| **`Store`**                    | <code>'store'</code>                    | Store settings.                                                                                                           |
| **`Tracking`**                 | <code>'tracking'</code>                 | Tracking settings.                                                                                                        |
| **`VPN`**                      | <code>'vpn'</code>                      | VPN settings.                                                                                                             |
| **`Wallpaper`**                | <code>'wallpaper'</code>                | Wallpaper settings.                                                                                                       |
| **`WiFi`**                     | <code>'wifi'</code>                     | WiFi settings.                                                                                                            |
| **`Tethering`**                | <code>'tethering'</code>                | Tethering settings (used to create a hotspot with mobile data).                                                           |
| **`DoNotDisturb`**             | <code>'doNotDisturb'</code>             | Do Not Disturb settings.                                                                                                  |
| **`TouchIdPasscode`**          | <code>'touchIdPasscode'</code>          | Touch id passcode settings.                                                                                               |
| **`ScreenTime`**               | <code>'screenTime'</code>               | Screen Time settings.                                                                                                     |
| **`Accessibility`**            | <code>'accessibility'</code>            | Accessibility settings.                                                                                                   |

</docgen-api>

capacitor-native-settings

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README