Baseflow / Baseflow/flutter-permission-handler

[Enhancement proposal]: Permission Table Documentation

Open
#1,204 2 comments 0 reactions 0 assignees View on GitHub
P3 refactor type: documentation
Dominant language
Dart
Stars
2.2k
Forks
970
Avg merge
14h 22m
Merged PRs (30d)
2

Description

### Please check the following before submitting a new issue.

- [X] I have searched the [existing issues](https://github.com/baseflow/flutter-permission-handler/issues).
- [X] I have carefully [read the documentation](https://github.com/baseflow/flutter-permission-handler/blob/main/permission_handler/README.md) and verified I have added the required platform-specific configuration.

### Please select affected platform(s)

- [X] Android
- [X] iOS
- [X] Windows

### Proposal

![Untitled](https://github.com/Baseflow/flutter-permission-handler/assets/3123741/62cef900-c8ba-4a52-aa6e-185f7b019a10)

I was collecting information regarding permissions that I need to support the app I am working on. I think it would be amazing for this library to support such information as a table.

### Example Table
| Permission | OS | Supporting API | Related Doc | Permission Name | Permission Status |
| :---: | :---: | :---: | :---: | :---: | :---: |
| `Notification` | Android | API Level 33 or higher | [Doc](https://developer.android.com/develop/ui/views/notifications/notification-permission) | `notification` | `granted, denied, permanentlyDenied` |
| `Do Not Disturb` | Android | API Level 23 or higher | [Doc](https://developer.android.com/reference/android/app/NotificationManager#setInterruptionFilter(int)) | `accessNotificationPolicy` | `granted, denied` |

### Pitch

iOS, Android, Windows, etc permissions is one of the most confusing features to support for not only engineers but product managers or even designers. It would be a great contribution to the community if there is a single source that accumulates all the information in one place. The whole front-end development community will be beneficial out of this.

It will also be helpful for this library to maintain permission easier.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.