├── .github ├── FUNDING.yaml └── workflows │ └── release.yaml ├── .gitignore ├── .idea ├── .gitignore ├── .name ├── AndroidProjectSystem.xml ├── appInsightsSettings.xml ├── compiler.xml ├── deploymentTargetSelector.xml ├── gradle.xml ├── kotlinc.xml ├── migrations.xml ├── misc.xml ├── runConfigurations.xml └── vcs.xml ├── LICENSE ├── README.md ├── app ├── .gitignore ├── build.gradle.kts ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── com │ │ └── meticha │ │ └── permissionexample │ │ └── ExampleInstrumentedTest.kt │ ├── main │ ├── AndroidManifest.xml │ ├── java │ │ └── com │ │ │ └── meticha │ │ │ └── permissionexample │ │ │ ├── CustomRationaleDialog.kt │ │ │ ├── MainActivity.kt │ │ │ └── ui │ │ │ └── theme │ │ │ ├── Color.kt │ │ │ ├── Theme.kt │ │ │ └── Type.kt │ └── res │ │ ├── drawable │ │ ├── ic_launcher_background.xml │ │ └── ic_launcher_foreground.xml │ │ ├── mipmap-anydpi-v26 │ │ ├── ic_launcher.xml │ │ └── ic_launcher_round.xml │ │ ├── mipmap-hdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-mdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-xhdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-xxhdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-xxxhdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── values │ │ ├── colors.xml │ │ ├── strings.xml │ │ └── themes.xml │ │ └── xml │ │ ├── backup_rules.xml │ │ └── data_extraction_rules.xml │ └── test │ └── java │ └── com │ └── meticha │ └── permissionexample │ └── ExampleUnitTest.kt ├── banner.png ├── build.gradle.kts ├── gradle ├── libs.versions.toml └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── permissions-compose ├── .gitignore ├── build.gradle.kts ├── consumer-rules.pro ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── com │ │ └── meticha │ │ └── permissions_compose │ │ └── ExampleInstrumentedTest.kt │ ├── main │ ├── AndroidManifest.xml │ └── java │ │ └── com │ │ └── meticha │ │ └── permissions_compose │ │ ├── AppPermission.kt │ │ ├── CustomDialog.kt │ │ ├── DefaultDialogs.kt │ │ ├── PermissionLifecycleEffect.kt │ │ ├── PermissionState.kt │ │ └── PermissionUtils.kt │ └── test │ └── java │ └── com │ └── meticha │ └── permissions_compose │ └── ExampleUnitTest.kt ├── permissions.gif └── settings.gradle.kts /.github/FUNDING.yaml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [cavin-macwan] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 12 | polar: # Replace with a single Polar username 13 | buy_me_a_coffee: cavin.macwan 14 | thanks_dev: # Replace with a single thanks.dev username 15 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 16 | -------------------------------------------------------------------------------- /.github/workflows/release.yaml: -------------------------------------------------------------------------------- 1 | name: Release 2 | 3 | on: 4 | pull_request: 5 | types: [closed] 6 | branches: 7 | - main 8 | 9 | 10 | env: 11 | VERSION_NAME: 0.0.1+4 # Update this value for each release 12 | 13 | jobs: 14 | release: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - name: Checkout Repository 19 | uses: actions/checkout@v3 20 | with: 21 | token: ${{ secrets.TOKEN }} 22 | persist-credentials: true 23 | 24 | - name: Setup gradle.properties 25 | run: | 26 | # Create a minimal gradle.properties with only necessary properties for CI 27 | echo "android.useAndroidX=true" > gradle.properties 28 | echo "VERSION_NAME=${{ env.VERSION_NAME }}" >> gradle.properties 29 | 30 | - name: Set up JDK 17 31 | uses: actions/setup-java@v4 32 | with: 33 | distribution: temurin 34 | java-version: '17' 35 | 36 | - name: Build Compose Permissions Library 37 | run: ./gradlew :permissions-compose:assembleRelease -Dandroid.useAndroidX=true 38 | 39 | - name: Extract Version 40 | id: get_version 41 | run: | 42 | VERSION=$(grep "^VERSION_NAME=" gradle.properties | cut -d '=' -f2) 43 | echo "Version found: $VERSION" 44 | echo "version=$VERSION" >> $GITHUB_ENV 45 | echo "version=$VERSION" >> $GITHUB_OUTPUT 46 | 47 | - name: Generate Changelog 48 | id: generate_changelog 49 | run: | 50 | # Get the previous tag; if none exists, use the initial commit. 51 | PREV_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "") 52 | if [ -z "$PREV_TAG" ]; then 53 | echo "No previous tag found, using initial commit." 54 | PREV_TAG=$(git rev-list --max-parents=0 HEAD) 55 | fi 56 | echo "Previous tag: $PREV_TAG" 57 | CHANGELOG=$(git log ${PREV_TAG}..HEAD --pretty=format:"- %s") 58 | echo "changelog<> $GITHUB_OUTPUT 59 | echo "$CHANGELOG" >> $GITHUB_OUTPUT 60 | echo "EOF" >> $GITHUB_OUTPUT 61 | 62 | - name: Create Git Tag 63 | run: | 64 | git config --global user.email "cavinmacwan1@gmail.com" 65 | git config --global user.name "Cavin" 66 | git tag -a v${{ env.version }} -m "Release v${{ env.version }}" 67 | git push origin v${{ env.version }} 68 | 69 | - name: Create GitHub Release 70 | id: create_release 71 | uses: actions/create-release@v1 72 | env: 73 | GITHUB_TOKEN: ${{ secrets.TOKEN }} 74 | with: 75 | tag_name: v${{ env.version }} 76 | release_name: "Release v${{ env.version }}" 77 | body: | 78 | ## Changelog 79 | ${{ steps.generate_changelog.outputs.changelog }} 80 | draft: false 81 | prerelease: false 82 | 83 | - name: Upload Release Artifact 84 | uses: actions/upload-release-asset@v1 85 | env: 86 | GITHUB_TOKEN: ${{ secrets.TOKEN }} 87 | with: 88 | upload_url: ${{ steps.create_release.outputs.upload_url }} 89 | asset_path: permissions-compose/build/outputs/aar/permissions-compose-release.aar 90 | asset_name: permissions-compose-${{ env.version }}.aar 91 | asset_content_type: application/octet-stream 92 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | /local.properties 4 | /.idea/caches 5 | /.idea/libraries 6 | /.idea/modules.xml 7 | /.idea/workspace.xml 8 | /.idea/navEditor.xml 9 | /.idea/assetWizardSettings.xml 10 | .DS_Store 11 | /build 12 | /captures 13 | .externalNativeBuild 14 | .cxx 15 | local.properties 16 | gradle.properties 17 | /secring.kbx 18 | -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /shelf/ 3 | /workspace.xml 4 | -------------------------------------------------------------------------------- /.idea/.name: -------------------------------------------------------------------------------- 1 | Permission Example Jetpack Compose -------------------------------------------------------------------------------- /.idea/AndroidProjectSystem.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | -------------------------------------------------------------------------------- /.idea/appInsightsSettings.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 25 | 26 | -------------------------------------------------------------------------------- /.idea/compiler.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/deploymentTargetSelector.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9 | 10 | -------------------------------------------------------------------------------- /.idea/gradle.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 19 | 20 | -------------------------------------------------------------------------------- /.idea/kotlinc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | -------------------------------------------------------------------------------- /.idea/migrations.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 9 | 10 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 10 | -------------------------------------------------------------------------------- /.idea/runConfigurations.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 16 | 17 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Permission Manager for Compose 2 | 3 | ![jetpack-compose-permission-banner.png](banner.png) 4 | 5 | A lightweight Android library that simplifies runtime permission management in Jetpack Compose 6 | applications. This library provides a composable API to request, check, and handle App permissions 7 | with ease. It supports custom rationale and settings dialogs, manifest permission validation, and 8 | lifecycle-aware permission flows. 9 | 10 | ![Jetpack Compose](https://img.shields.io/badge/jetpack-compose-%237F52FF.svg?style=for-the-badge&logo=jetpack-compose&logoColor=white) 11 | ![Kotlin](https://img.shields.io/badge/kotlin-%237F52FF.svg?style=for-the-badge&logo=kotlin&logoColor=white) ![Android](https://img.shields.io/badge/Android-3DDC84?style=for-the-badge&logo=android&logoColor=white) 12 | 13 | [![Maven Central](https://img.shields.io/maven-central/v/com.meticha/permissions_compose)](https://central.sonatype.com/artifact/com.meticha/permissions_compose) ![Static Badge](https://img.shields.io/badge/minSdk-21-blue?link=https%3A%2F%2Fgithub.com%2Fmeticha%2Fpermissions-compose%2Fblob%2Fmain%2Fpermissions-compose%2Fbuild.gradle.kts%23L13) 14 | 15 | ## 📦 Features 16 | 17 | - **Composable Permission State**: Easily manage permissions with a stateful, composable API. 18 | - **Manifest Check**: Automatically verifies that all required permissions are declared in your 19 | app’s manifest. 20 | - **Customizable UI**: Configure custom rationale and settings dialogs to match your app’s style. 21 | - **Lifecycle Aware**: Automatically handles permission requests on lifecycle changes (e.g., when 22 | resuming from app settings). 23 | - **Flexible Permission Flow**: Seamlessly handles both required and optional permissions. 24 | 25 | ## ⬇️ Installation 26 | 27 | You can follow the implementation approach used in the App module. Alternatively, you can find a 28 | detailed explanation below. 29 | 30 | ### 🏴 Dependencies 31 | 32 | The library is now available on MavenCentral!!! Add the dependencies to your `libs.versions.toml` 33 | 34 | ``` 35 | [versions] 36 | ... 37 | permissionsCompose = "X.X.X" current release version 38 | 39 | [libraries] 40 | ... 41 | permissions-compose = { group = "com.meticha", name = "permissions_compose", version.ref = "permissionsCompose" } 42 | 43 | ``` 44 | 45 | In your `build.gradle.kts` implement this dependency: 46 | 47 | ``` 48 | ... 49 | dependencies { 50 | ... 51 | implementation(libs.permissions.compose) 52 | ``` 53 | 54 | ## 💬 Usage: 55 | 56 | ### 0. Add Permissions inside your `AndroidManifest.xml` 57 | 58 | Open `AndroidManifest.xml` file and add the permissions that you want to request: 59 | 60 | ```xml 61 | ... 62 | 63 | ... 64 | ``` 65 | 66 | ### 1. (OPTIONAL) Setup in MainActivity 67 | 68 | Set for configuring the custom UI for permission rationales (if desired) 69 | 70 | ```kotlin 71 | class MainActivity : ComponentActivity() { 72 | override fun onCreate(savedInstanceState: Bundle?) { 73 | super.onCreate(savedInstanceState) 74 | 75 | // Set a custom rationale UI globally 76 | PermissionManagerConfig.setCustomRationaleUI { permission, onDismiss, onConfirm -> 77 | CustomRationaleDialog( 78 | description = permission.description, 79 | onDismiss = onDismiss, 80 | onConfirm = onConfirm 81 | ) 82 | } 83 | 84 | setContent { 85 | DemoApplicationTheme { 86 | PermissionScreen() 87 | } 88 | } 89 | } 90 | } 91 | ``` 92 | 93 | ### 2. Implement Permissions from which you want to request 94 | 95 | Use the `rememberAppPermissionState` composable to manage your permissions within a Jetpack Compose 96 | screen. Here's a demo implementation of a screen. 97 | 98 | ```kotlin 99 | @Composable 100 | fun PermissionScreen() { 101 | val permissions = rememberAppPermissionState( 102 | permissions = listOf( 103 | AppPermission( 104 | permission = Manifest.permission.CAMERA, 105 | description = "Camera access is needed to take photos. Please grant this permission.", 106 | isRequired = true 107 | ), 108 | AppPermission( 109 | permission = Manifest.permission.RECORD_AUDIO, 110 | description = "Microphone access is needed for voice recording. Please grant this permission.", 111 | isRequired = false 112 | ), 113 | AppPermission( 114 | permission = Manifest.permission.READ_CONTACTS, 115 | description = "Contact access is needed to show the contacts in the App. Please grant this permission", 116 | isRequired = true 117 | ) 118 | // ... Add your permissions here that you want to request 119 | ) 120 | ) 121 | 122 | Column( 123 | modifier = Modifier 124 | .fillMaxSize() 125 | .padding(16.dp), 126 | horizontalAlignment = Alignment.CenterHorizontally, 127 | verticalArrangement = Arrangement.Center 128 | ) { 129 | // Display current permission statuses 130 | Text("Camera Permission: ${if (permissions.isGranted(Manifest.permission.CAMERA)) "Granted" else "Not Granted"}") 131 | Text("Audio Permission: ${if (permissions.isGranted(Manifest.permission.RECORD_AUDIO)) "Granted" else "Not Granted"}") 132 | Text("Contact Permission: ${if (permissions.isGranted(Manifest.permission.READ_CONTACTS)) "Granted" else "Not Granted"}") 133 | 134 | Button( 135 | onClick = { permissions.requestPermission() }, 136 | modifier = Modifier.padding(top = 16.dp) 137 | ) { 138 | Text("Request Permissions") 139 | } 140 | 141 | // Show content conditionally based on permission state 142 | if (permissions.allRequiredGranted()) { 143 | Text("All required permissions granted! You can now use the app.") 144 | } 145 | } 146 | } 147 | ``` 148 | 149 | ## ❓How It Works: 150 | 151 | ### PermissionState 152 | 153 | The core of the library is the PermissionState class, which: 154 | 155 | - Maintains the list of all and pending permissions. 156 | - Tracks the current permission being requested. 157 | - Manages UI state for displaying rationale and settings dialogs. 158 | - Progresses through the permission request queue using functions such as requestPermission() and 159 | next(). 160 | 161 | ## ♻️ Lifecycle Integration 162 | 163 | The `PermissionLifeCycleCheckEffect` composable observes lifecycle events (e.g., `ON_RESUME`). If 164 | the app resumes from settings, it automatically re-triggers the permission request flow. 165 | 166 | ## ✅ Manifest Verification 167 | 168 | Before launching a permission request, the library verifies that each permission is declared in your 169 | `AndroidManifest.xml`. If a permission is missing, a `PermissionNotAddedException` is thrown to 170 | alert 171 | you. 172 | 173 | ## ⚙️ Customization 174 | 175 | You can customize the permission dialogs globally via the `PermissionManagerConfig`: 176 | 177 | ```kotlin 178 | PermissionManagerConfig.setCustomRationaleUI { permission, onDismiss, onConfirm -> 179 | // Provide your custom rationale UI implementation here 180 | } 181 | ``` 182 | 183 | Similarly, custom settings dialogs can be implemented if needed. This flexibility allows you to 184 | tailor the user experience to match your app's design guidelines. 185 | 186 | ![permissions.gif](permissions.gif) 187 | 188 | # 🤝 Contributing 189 | 190 | Contributions are welcome! If you have suggestions, improvements, or bug fixes, please open an issue 191 | or submit a pull request. 192 | 193 | 1. Fork the repository. 194 | 2. Create a new branch (feature-branch) 195 | 3. Commit your changes. 196 | 4. Push to the branch and submit a pull request. 197 | 198 | # 📬 Contact 199 | 200 | For issues or suggestions, open an issue or reach out at cavin@meticha.com. 201 | 202 | # 📜 License 203 | 204 | Distributed under 205 | the [Apache Software License, Version 2.0.](https://www.apache.org/licenses/LICENSE-2.0) 206 | 207 | 208 | -------------------------------------------------------------------------------- /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /app/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | alias(libs.plugins.android.application) 3 | alias(libs.plugins.kotlin.android) 4 | alias(libs.plugins.kotlin.compose) 5 | } 6 | 7 | android { 8 | namespace = "com.meticha.permissionexample" 9 | compileSdk = 35 10 | 11 | defaultConfig { 12 | applicationId = "com.meticha.permissionexample" 13 | minSdk = 24 14 | targetSdk = 35 15 | versionCode = 1 16 | versionName = "1.0" 17 | 18 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" 19 | } 20 | 21 | buildTypes { 22 | release { 23 | isMinifyEnabled = false 24 | proguardFiles( 25 | getDefaultProguardFile("proguard-android-optimize.txt"), 26 | "proguard-rules.pro" 27 | ) 28 | } 29 | } 30 | compileOptions { 31 | sourceCompatibility = JavaVersion.VERSION_11 32 | targetCompatibility = JavaVersion.VERSION_11 33 | } 34 | kotlinOptions { 35 | jvmTarget = "11" 36 | } 37 | buildFeatures { 38 | compose = true 39 | } 40 | } 41 | 42 | dependencies { 43 | 44 | implementation(libs.permissions.compose) 45 | implementation(libs.androidx.core.ktx) 46 | implementation(libs.androidx.lifecycle.runtime.ktx) 47 | implementation(libs.androidx.activity.compose) 48 | implementation(platform(libs.androidx.compose.bom)) 49 | implementation(libs.androidx.ui) 50 | implementation(libs.androidx.ui.graphics) 51 | implementation(libs.androidx.ui.tooling.preview) 52 | implementation(libs.androidx.material3) 53 | testImplementation(libs.junit) 54 | androidTestImplementation(libs.androidx.junit) 55 | androidTestImplementation(libs.androidx.espresso.core) 56 | androidTestImplementation(platform(libs.androidx.compose.bom)) 57 | androidTestImplementation(libs.androidx.ui.test.junit4) 58 | debugImplementation(libs.androidx.ui.tooling) 59 | debugImplementation(libs.androidx.ui.test.manifest) 60 | } -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /app/src/androidTest/java/com/meticha/permissionexample/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package com.meticha.permissionexample 2 | 3 | import androidx.test.platform.app.InstrumentationRegistry 4 | import androidx.test.ext.junit.runners.AndroidJUnit4 5 | 6 | import org.junit.Test 7 | import org.junit.runner.RunWith 8 | 9 | import org.junit.Assert.* 10 | 11 | /** 12 | * Instrumented test, which will execute on an Android device. 13 | * 14 | * See [testing documentation](http://d.android.com/tools/testing). 15 | */ 16 | @RunWith(AndroidJUnit4::class) 17 | class ExampleInstrumentedTest { 18 | @Test 19 | fun useAppContext() { 20 | // Context of the app under test. 21 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext 22 | assertEquals("com.meticha.permissionexample", appContext.packageName) 23 | } 24 | } -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 24 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /app/src/main/java/com/meticha/permissionexample/CustomRationaleDialog.kt: -------------------------------------------------------------------------------- 1 | package com.meticha.permissionexample 2 | 3 | import androidx.compose.foundation.layout.Arrangement 4 | import androidx.compose.foundation.layout.Column 5 | import androidx.compose.foundation.layout.fillMaxWidth 6 | import androidx.compose.foundation.layout.padding 7 | import androidx.compose.foundation.shape.RoundedCornerShape 8 | import androidx.compose.material3.Button 9 | import androidx.compose.material3.Card 10 | import androidx.compose.material3.CardDefaults 11 | import androidx.compose.material3.MaterialTheme 12 | import androidx.compose.material3.Text 13 | import androidx.compose.runtime.Composable 14 | import androidx.compose.ui.Alignment 15 | import androidx.compose.ui.Modifier 16 | import androidx.compose.ui.unit.dp 17 | import androidx.compose.ui.window.Dialog 18 | 19 | @Composable 20 | fun CustomRationaleDialog( 21 | description: String, 22 | onDismiss: () -> Unit, 23 | onConfirm: () -> Unit 24 | ) { 25 | Dialog(onDismissRequest = onDismiss) { 26 | Card( 27 | modifier = Modifier 28 | .fillMaxWidth() 29 | .padding(16.dp), 30 | shape = RoundedCornerShape(16.dp), 31 | colors = CardDefaults.cardColors( 32 | containerColor = MaterialTheme.colorScheme.surface 33 | ) 34 | ) { 35 | Column( 36 | modifier = Modifier 37 | .padding(16.dp), 38 | horizontalAlignment = Alignment.CenterHorizontally, 39 | verticalArrangement = Arrangement.spacedBy(16.dp) 40 | ) { 41 | Text( 42 | text = "We Need Your Permission", 43 | style = MaterialTheme.typography.titleMedium, 44 | color = MaterialTheme.colorScheme.primary 45 | ) 46 | 47 | Text( 48 | text = description, 49 | style = MaterialTheme.typography.bodyMedium 50 | ) 51 | 52 | Button( 53 | onClick = onConfirm, 54 | modifier = Modifier.fillMaxWidth() 55 | ) { 56 | Text("Allow") 57 | } 58 | 59 | } 60 | } 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /app/src/main/java/com/meticha/permissionexample/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.meticha.permissionexample 2 | 3 | import android.Manifest 4 | import android.os.Bundle 5 | import androidx.activity.ComponentActivity 6 | import androidx.activity.compose.setContent 7 | import androidx.activity.enableEdgeToEdge 8 | import androidx.compose.foundation.layout.Arrangement 9 | import androidx.compose.foundation.layout.Column 10 | import androidx.compose.foundation.layout.Spacer 11 | import androidx.compose.foundation.layout.fillMaxSize 12 | import androidx.compose.foundation.layout.height 13 | import androidx.compose.foundation.layout.padding 14 | import androidx.compose.material3.Button 15 | import androidx.compose.material3.ExperimentalMaterial3Api 16 | import androidx.compose.material3.Scaffold 17 | import androidx.compose.material3.Text 18 | import androidx.compose.material3.TopAppBar 19 | import androidx.compose.runtime.Composable 20 | import androidx.compose.ui.Alignment 21 | import androidx.compose.ui.Modifier 22 | import androidx.compose.ui.unit.dp 23 | import com.meticha.permissionexample.ui.theme.PermissionExampleJetpackComposeTheme 24 | import com.meticha.permissions_compose.AppPermission 25 | import com.meticha.permissions_compose.PermissionManagerConfig 26 | import com.meticha.permissions_compose.rememberAppPermissionState 27 | 28 | class MainActivity : ComponentActivity() { 29 | override fun onCreate(savedInstanceState: Bundle?) { 30 | super.onCreate(savedInstanceState) 31 | enableEdgeToEdge() 32 | 33 | // Set a custom rationale UI globally (Optional) 34 | PermissionManagerConfig.setCustomRationaleUI { permission, onDismiss, onConfirm -> 35 | CustomRationaleDialog( 36 | description = permission.description, 37 | onDismiss = onDismiss, 38 | onConfirm = onConfirm 39 | ) 40 | } 41 | 42 | setContent { 43 | PermissionExampleJetpackComposeTheme { 44 | PermissionScreen() 45 | } 46 | } 47 | } 48 | } 49 | 50 | @OptIn(ExperimentalMaterial3Api::class) 51 | @Composable 52 | fun PermissionScreen() { 53 | val permissions = rememberAppPermissionState( 54 | permissions = listOf( 55 | AppPermission( 56 | permission = Manifest.permission.CAMERA, 57 | description = "Camera access is needed to take photos. Please grant this permission.", 58 | isRequired = true 59 | ), 60 | AppPermission( 61 | permission = Manifest.permission.RECORD_AUDIO, 62 | description = "Microphone access is needed for voice recording. Please grant this permission.", 63 | isRequired = false 64 | ), 65 | AppPermission( 66 | permission = Manifest.permission.READ_CONTACTS, 67 | description = "Contact access is needed to show the contacts in the App. Please grant this permission", 68 | isRequired = true 69 | ), 70 | ) 71 | ) 72 | 73 | 74 | Scaffold( 75 | topBar = { TopAppBar(title = { Text("Permission Example") }) } 76 | ) { 77 | Column( 78 | modifier = Modifier 79 | .fillMaxSize() 80 | .padding(it) 81 | .padding(16.dp), 82 | horizontalAlignment = Alignment.CenterHorizontally, 83 | verticalArrangement = Arrangement.Center 84 | ) { 85 | // Show current permission status 86 | Text("Camera Permission: ${if (permissions.isGranted(Manifest.permission.CAMERA)) "Granted" else "Not Granted"}") 87 | 88 | Spacer(modifier = Modifier.height(10.dp)) 89 | 90 | Text("Audio Permission: ${if (permissions.isGranted(Manifest.permission.RECORD_AUDIO)) "Granted" else "Not Granted"}") 91 | 92 | Spacer(modifier = Modifier.height(10.dp)) 93 | 94 | Text("Contact Permission: ${if (permissions.isGranted(Manifest.permission.READ_CONTACTS)) "Granted" else "Not Granted"}") 95 | 96 | Spacer(modifier = Modifier.height(20.dp)) 97 | 98 | Button( 99 | onClick = { permissions.requestPermission() }, 100 | ) { 101 | Text("Request Permissions") 102 | } 103 | 104 | Spacer(modifier = Modifier.height(10.dp)) 105 | 106 | // Conditionally show content based on permission state 107 | if (permissions.allRequiredGranted()) { 108 | Text("All required permissions granted! You can now use the app.") 109 | } 110 | } 111 | } 112 | } 113 | -------------------------------------------------------------------------------- /app/src/main/java/com/meticha/permissionexample/ui/theme/Color.kt: -------------------------------------------------------------------------------- 1 | package com.meticha.permissionexample.ui.theme 2 | 3 | import androidx.compose.ui.graphics.Color 4 | 5 | val Purple80 = Color(0xFFD0BCFF) 6 | val PurpleGrey80 = Color(0xFFCCC2DC) 7 | val Pink80 = Color(0xFFEFB8C8) 8 | 9 | val Purple40 = Color(0xFF6650a4) 10 | val PurpleGrey40 = Color(0xFF625b71) 11 | val Pink40 = Color(0xFF7D5260) -------------------------------------------------------------------------------- /app/src/main/java/com/meticha/permissionexample/ui/theme/Theme.kt: -------------------------------------------------------------------------------- 1 | package com.meticha.permissionexample.ui.theme 2 | 3 | import android.app.Activity 4 | import android.os.Build 5 | import androidx.compose.foundation.isSystemInDarkTheme 6 | import androidx.compose.material3.MaterialTheme 7 | import androidx.compose.material3.darkColorScheme 8 | import androidx.compose.material3.dynamicDarkColorScheme 9 | import androidx.compose.material3.dynamicLightColorScheme 10 | import androidx.compose.material3.lightColorScheme 11 | import androidx.compose.runtime.Composable 12 | import androidx.compose.ui.platform.LocalContext 13 | 14 | private val DarkColorScheme = darkColorScheme( 15 | primary = Purple80, 16 | secondary = PurpleGrey80, 17 | tertiary = Pink80 18 | ) 19 | 20 | private val LightColorScheme = lightColorScheme( 21 | primary = Purple40, 22 | secondary = PurpleGrey40, 23 | tertiary = Pink40 24 | 25 | /* Other default colors to override 26 | background = Color(0xFFFFFBFE), 27 | surface = Color(0xFFFFFBFE), 28 | onPrimary = Color.White, 29 | onSecondary = Color.White, 30 | onTertiary = Color.White, 31 | onBackground = Color(0xFF1C1B1F), 32 | onSurface = Color(0xFF1C1B1F), 33 | */ 34 | ) 35 | 36 | @Composable 37 | fun PermissionExampleJetpackComposeTheme( 38 | darkTheme: Boolean = isSystemInDarkTheme(), 39 | // Dynamic color is available on Android 12+ 40 | dynamicColor: Boolean = true, 41 | content: @Composable () -> Unit 42 | ) { 43 | val colorScheme = when { 44 | dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> { 45 | val context = LocalContext.current 46 | if (darkTheme) dynamicDarkColorScheme(context) else dynamicLightColorScheme(context) 47 | } 48 | 49 | darkTheme -> DarkColorScheme 50 | else -> LightColorScheme 51 | } 52 | 53 | MaterialTheme( 54 | colorScheme = colorScheme, 55 | typography = Typography, 56 | content = content 57 | ) 58 | } -------------------------------------------------------------------------------- /app/src/main/java/com/meticha/permissionexample/ui/theme/Type.kt: -------------------------------------------------------------------------------- 1 | package com.meticha.permissionexample.ui.theme 2 | 3 | import androidx.compose.material3.Typography 4 | import androidx.compose.ui.text.TextStyle 5 | import androidx.compose.ui.text.font.FontFamily 6 | import androidx.compose.ui.text.font.FontWeight 7 | import androidx.compose.ui.unit.sp 8 | 9 | // Set of Material typography styles to start with 10 | val Typography = Typography( 11 | bodyLarge = TextStyle( 12 | fontFamily = FontFamily.Default, 13 | fontWeight = FontWeight.Normal, 14 | fontSize = 16.sp, 15 | lineHeight = 24.sp, 16 | letterSpacing = 0.5.sp 17 | ) 18 | /* Other default text styles to override 19 | titleLarge = TextStyle( 20 | fontFamily = FontFamily.Default, 21 | fontWeight = FontWeight.Normal, 22 | fontSize = 22.sp, 23 | lineHeight = 28.sp, 24 | letterSpacing = 0.sp 25 | ), 26 | labelSmall = TextStyle( 27 | fontFamily = FontFamily.Default, 28 | fontWeight = FontWeight.Medium, 29 | fontSize = 11.sp, 30 | lineHeight = 16.sp, 31 | letterSpacing = 0.5.sp 32 | ) 33 | */ 34 | ) -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/meticha/permissions-compose/9a641790d6f0bd926b9923eca94de9efcc60f7be/app/src/main/res/mipmap-hdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/meticha/permissions-compose/9a641790d6f0bd926b9923eca94de9efcc60f7be/app/src/main/res/mipmap-hdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/meticha/permissions-compose/9a641790d6f0bd926b9923eca94de9efcc60f7be/app/src/main/res/mipmap-mdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/meticha/permissions-compose/9a641790d6f0bd926b9923eca94de9efcc60f7be/app/src/main/res/mipmap-mdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/meticha/permissions-compose/9a641790d6f0bd926b9923eca94de9efcc60f7be/app/src/main/res/mipmap-xhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/meticha/permissions-compose/9a641790d6f0bd926b9923eca94de9efcc60f7be/app/src/main/res/mipmap-xhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/meticha/permissions-compose/9a641790d6f0bd926b9923eca94de9efcc60f7be/app/src/main/res/mipmap-xxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/meticha/permissions-compose/9a641790d6f0bd926b9923eca94de9efcc60f7be/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/meticha/permissions-compose/9a641790d6f0bd926b9923eca94de9efcc60f7be/app/src/main/res/mipmap-xxxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/meticha/permissions-compose/9a641790d6f0bd926b9923eca94de9efcc60f7be/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #FF03DAC5 7 | #FF018786 8 | #FF000000 9 | #FFFFFFFF 10 | -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | Permission Example Jetpack Compose 3 | -------------------------------------------------------------------------------- /app/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |