Handles runtime permission requests on mobile devices, supporting a variety of permissions with lifecycle safety and exceptions for denied permissions. Includes Compose Multiplatform support and sample code.
moko-permissions - Kotlin MultiPlatform library for providing runtime permissions on iOS & Android.
root build.gradle
allprojects {
repositories {
mavenCentral()
}
}
project build.gradle
dependencies {
commonMainApi("dev.icerock.moko:permissions:0.20.1")
// specific permissions support
commonMainImplementation("dev.icerock.moko:permissions-bluetooth:0.20.1")
commonMainImplementation("dev.icerock.moko:permissions-camera:0.20.1")
commonMainImplementation("dev.icerock.moko:permissions-contacts:0.20.1")
commonMainImplementation("dev.icerock.moko:permissions-gallery:0.20.1")
commonMainImplementation("dev.icerock.moko:permissions-location:0.20.1")
commonMainImplementation("dev.icerock.moko:permissions-microphone:0.20.1")
commonMainImplementation("dev.icerock.moko:permissions-motion:0.20.1")
commonMainImplementation("dev.icerock.moko:permissions-notifications:0.20.1")
commonMainImplementation("dev.icerock.moko:permissions-storage:0.20.1")
// compose multiplatform
commonMainApi("dev.icerock.moko:permissions-compose:0.20.1") // permissions api + compose extensions
commonTestImplementation("dev.icerock.moko:permissions-test:0.20.1")
}
Common code:
class ViewModel(val permissionsController: PermissionsController): ViewModel() {
fun onPhotoPressed() {
viewModelScope.launch {
try {
permissionsController.providePermission(Permission.GALLERY)
// Permission has been granted successfully.
} catch(deniedAlways: DeniedAlwaysException) {
// Permission is always denied.
} catch(denied: DeniedException) {
// Permission was denied.
}
}
}
}
Android:
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
val viewModel = getViewModel {
// Pass the platform implementation of the permission controller to a common code.
ViewModel(PermissionsController())
}
// Binds the permissions controller to the activity lifecycle.
viewModel.permissionsController.bind(activity)
}
Compose:
@Composable
fun TestScreen() {
val viewModel = getViewModel {
// Pass the platform implementation of the permission controller to a common code.
ViewModel(PermissionsController())
}
// Binds the permissions controller to the LocalLifecycleOwner lifecycle.
BindEffect(viewModel.permissionsController)
}
iOS:
// Just pass the platform implementation of the permission controller to a common code.
let viewModel = ViewModel(permissionsController: PermissionsController())
@Composable
fun Sample() {
val factory: PermissionsControllerFactory = rememberPermissionsControllerFactory()
val controller: PermissionsController = remember(factory) { factory.createPermissionsController() }
val coroutineScope: CoroutineScope = rememberCoroutineScope()
Button(
onClick = {
coroutineScope.launch {
controller.providePermission(Permission.REMOTE_NOTIFICATION)
}
}
) {
Text(text = "give permissions")
}
}
Or with moko-mvvm with correct configuration change handle on android:
@Composable
fun Sample() {
val factory: PermissionsControllerFactory = rememberPermissionsControllerFactory()
val viewModel: PermissionsViewModel = getViewModel(
key = "permissions-screen",
factory = viewModelFactory { PermissionsViewModel(factory.createPermissionsController()) }
)
BindEffect(viewModel.permissionsController)
Button(onClick = viewModel::onButtonClick) {
Text(text = )
}
}
(
permissionsController: PermissionsController
) : ViewModel() {
{
viewModelScope.launch {
permissionsController.providePermission(Permission.REMOTE_NOTIFICATION)
}
}
}
More examples can be found in the sample directory.
permissions library;All development (both new features and bug fixes) is performed in develop branch. This way master sources always contain sources of the most recently released version. Please send PRs with bug fixes to develop branch. Fixes to documentation in markdown files are an exception to this rule. They are updated directly in master.
The develop branch is pushed to master during release.
More detailed guide for contributors see in contributing guide.
Copyright 2019 IceRock MAG Inc
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.
dev.icerock.moko:permissions-bluetooth
dev.icerock.moko:permissions-camera
dev.icerock.moko:permissions-contacts
dev.icerock.moko:permissions-gallery
dev.icerock.moko:permissions-location
dev.icerock.moko:permissions-microphone
dev.icerock.moko:permissions-motion
dev.icerock.moko:permissions-notifications
dev.icerock.moko:permissions-storage
Surfaced from shared tags and platforms — no rankings paid for.