PermissionsSwiftUI displays and handles permissions in SwiftUI. It is largely inspired by SPPermissions. The UI is highly customizable and resembles an Apple style. If you like the project, please star ★.

• Installation
• Quickstart

• Cheatsheet
• Supported Permissions
• Contribute

(You don’t need to add CorePermissionsSwiftUI or PermissionsSwiftUI)

5. Click Finish
6. You are all set, thank you for using PermissionsSwiftUI!

You can also install PermissionsSwiftUI with Cocoapods. Add pod 'PermissionsSwiftUI' in your podfile:

🚀 Quickstart

v1.4 is here! If you encounter any issues, please check out the migration guide designed to help developers resolve any deprecations and API updates.

To use PermissionsSwiftUI, simply add the JMModal modifier to any view:

Pass in a Binding<Bool> to show the modal view, and add whatever permissions you want to show. For example:

The alert style is equally gorgeous, and allows for more versatile use. It is recommended when you have less than 3 permissions.
To show a permission pop up alert, use:

.JMAlert(showModal: $showModal, for: [.locationAlways, .photo])

Similar to the previous JMPermissions, you need to pass in a Binding<Bool> to show the view, and add whatever permissions you want to show. To quickly glance at all of PermissionsSwiftUI’s customization and configurations, check out the cheatsheet!

To customize permission texts, use the modifier setPermissionComponent() For example, you can change title, description, and image icon:

and the result:

Or only change 1 of title and description:

• The parameters you don’t provide will show the default text
• Add the setPermissionComponent modifier on your root level view, after JMPermissions modifier

The image parameter accepts AnyView, so feel free to use SF Symbols or your custom asset:

Even full SwiftUI views will work😱:

You can use custom text and icons for all the supported permissions, with a single line of code.

To customize the header title, use the modifier changeHeaderTo:

To customize the header description, use the modifier changeHeaderDescriptionTo

To customize the bottom description, use the modifier changeBottomDescriptionTo

To customize the header title, use the modifier changeHeaderTo:

You might find it incredibly useful to execute your code, or perform some update action when a PermissionsSwiftUI view appears and disappears.
You can perform some action when PermissionsSwiftUI view appears or disappears by:

The onAppear and onDisappear closure parameters will be executed everytime PermissionsSwiftUI view appears and disappears.
The same view modifier closure for state changes are available for the JMAlert modifier:

PermissionsSwiftUI by default will automatically check for authorization status. It will only show permissions that are currently notDetermined status. (the iOS system prevents developers from asking for denied permissions. Allowed permissions will also be ignored by PermissionsSwiftUI). If all permissions are allowed or denied, PermissionsSwiftUI will not show the modal or alert at all. To set auto check authorization, use the autoCheckAuthorization parameter:

PermissionsSwiftUI by default will not have any auto dismiss behavior. You can override this behavior to make it automatically dismiss the modal or alert after the user allows the last permission item. (All permissions must be ALLOWED, if any is DENIED, it will not auto dismiss).

Pass in true or false to select whether to automatically dismiss the view.

Using PermissionSwiftUI’s capabilities, developers and designers can customize all the UI colors with incredible flexibility. You can fully configure all color at all states with your custom colors.
To easily change the accent color:

To change the primary (default Apple blue) and tertiary (default Apple red) colors:

⚠️ .setAccentColor() and .setAllowButtonColor() should never be used at the same time.

To unleash the full customization of all button colors under all states, you need to pass in the AllButtonColors struct:

For more information regarding the above method, reference the official documentation.

PermissionsSwiftUI will by default, prevent the user from dismissing the modal and alert before all permissions have been interacted with. This means if the user has not explicitly denied or allowed EVERY permission shown, they will not be able to dismiss the PermissionsSwiftUI view. This restricts dismissal behavior can be overridden by the var restrictModalDismissal: Bool or var restrictAlertDismissal: Bool properties. To disable the default restrict dismiss behavior:

You can also configure with the model:

Unlike all the other permissions, the configuration for health permission is a little different. Because Apple requires developers to explicitly set read and write types, PermissionsSwiftUI greatly simplifies the process.

The structure HKAccess is required when initializing health permission’s enum associated values. It encapsulates the read and write type permissions for the health permission.

To set read and write health types (activeEnergyBurned is used as example here):

To set read or write individually:

You may also set only read or write type:

Customize overall accent color:

Customize title:

Customize top description:

Customize each permission’s displayed text & image:

Customize allow button’s colors:

Automatically dismiss after last

autoDismiss: Bool

Check authorization before showing modal or alert

Prevent dismissing before all permissions interacted

Do something right before view appear

Do something right before view disappear

Here is a list of all the permissions PermissionsSwiftUI supports. Yup, even the newest tracking permission for iOS 14 so you can stay on top of your game. All permissions in PermissionsSwiftUI come with a default name, description, and a stunning Apple native SF Symbols icon.

Support for FaceID permission is work in progress and coming soon! If you don’t find a permission you need, open an issue. Even better, build it yourself and open a pull request, you can follow this step-by-step guide on adding new permissions.

GitHub

View Github