capacitor-native-settings

v6.0.1

Capacitor plugin to open native settings screens for android and iOS For more information about how to use this package see README

Latest version published 4 months ago

License: MIT

NPM

GitHub

Package Health Score

77 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
6.0.1	\|	07/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.0.1	\|	08/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.0.3	\|	11/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.1	\|	06/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.1	\|	03/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (8,560)

GitHub Stars: 92
Forks: 31
Contributors: 20

Direct Usage Popularity

The npm package capacitor-native-settings receives a total of 8,560 downloads a week. As such, we scored capacitor-native-settings popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package capacitor-native-settings, we found that it has been starred 92 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the capacitor-native-settings repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like capacitor-native-settings is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Sustainable

Commit Frequency

Open Issues: 5
Open PR: 2
Last Release: 4 months ago
Last Commit: 4 months ago

Further analysis of the maintenance status of capacitor-native-settings based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that capacitor-native-settings demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 4 years
Dependencies: 0 Direct
Versions: 16
Install Size: 148 kB
Dist-tags: 1
# of Files: 27
Maintainers: 2
TS Typings: No

capacitor-native-settings has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Capacitor Native Settings

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

Plugin versions

Capacitor version	Plugin version
v6	>= v6.0.0
v5	>= v5.0.0
v4	>= v4.0.0
v3	<= v2.0.1

Install

npm install capacitor-native-settings
npx cap sync

Example

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

/**
 * Note that the only supported option by Apple is "App".
 * Using other options might break in future iOS versions
 * or have your app rejected from the App Store.
 */
NativeSettings.open({
  optionAndroid: AndroidSettings.ApplicationDetails, 
  optionIOS: IOSSettings.App
})

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

/**
 * Note that the only supported option by Apple is "App".
 * Using other options might break in future iOS versions
 * or have your app rejected from the App Store.
 */
NativeSettings.openIOS({
  option: IOSSettings.App,
});

API

open(...)

open(option: PlatformOptions) =&gt; Promise&lt;{ status: boolean; }&gt;

Opens the specified options on android & ios. Note that the only supported option by Apple is "App". Using other options might break in future iOS versions or have your app rejected in the App Store.

Param	Type	Description
`option`	`PlatformOptions`	PlatformOptions

Returns: Promise<{ status: boolean; }>

openAndroid(...)

openAndroid(option: AndroidOptions) =&gt; Promise&lt;{ status: boolean; }&gt;

Opens the specified option in android. Only use this if you have made sure the user is on android. This can be done by checking the platform before hand.

Param	Type	Description
`option`	`AndroidOptions`	AndroidOptions

Returns: Promise<{ status: boolean; }>

openIOS(...)

openIOS(option: IOSOptions) =&gt; Promise&lt;{ status: boolean; }&gt;

Opens the specified option on iOS. Only use this if you have made sure the user is on iOS. This can be done by checking the platform before hand.

Note that the only supported option by Apple is "App". Using other options might break in future iOS versions or have your app rejected in the App Store.

Param	Type	Description
`option`	`IOSOptions`	IOSOptions

Returns: Promise<{ status: boolean; }>

Interfaces

PlatformOptions

Prop	Type
`optionAndroid`	`AndroidSettings`
`optionIOS`	`IOSSettings`

AndroidOptions

Prop	Type
`option`	`AndroidSettings`

IOSOptions

Prop	Type
`option`	`IOSSettings`

Enums

AndroidSettings

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

IOSSettings

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

capacitor-native-settings development dependencies

@capacitor/android @capacitor/core @capacitor/docgen @capacitor/ios @ionic/eslint-config @ionic/prettier-config @ionic/swiftlint-config eslint prettier prettier-plugin-java rimraf rollup swiftlint typescript

FAQs

What is capacitor-native-settings?

Capacitor plugin to open native settings screens for android and iOS. Visit Snyk Advisor to see a full health score report for capacitor-native-settings, including popularity, security, maintenance & community analysis.

Is capacitor-native-settings popular?

The npm package capacitor-native-settings receives a total of 8,560 weekly downloads. As such, capacitor-native-settings popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is capacitor-native-settings well maintained?

We found indications that capacitor-native-settings maintenance is sustainable demonstrating some project activity. We saw a total of 20 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is capacitor-native-settings safe to use?

The npm package capacitor-native-settings was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 12 November-2024, at 05:34 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (8,560)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Capacitor Native Settings

Plugin versions

Install

Example

API

open(...)

openAndroid(...)

openIOS(...)

Interfaces

PlatformOptions

AndroidOptions

IOSOptions

Enums

AndroidSettings

IOSSettings

capacitor-native-settings development dependencies

FAQs

What is capacitor-native-settings?

Is capacitor-native-settings popular?

Is capacitor-native-settings well maintained?

Is capacitor-native-settings safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues