Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/line/abc-kmm-location
Location Service Manager for Kotlin Multiplatform Mobile iOS and Android
https://github.com/line/abc-kmm-location
android corelocation fusedlocationapi googleservice ios kotlin-multiplatform location-service
Last synced: 2 months ago
JSON representation
Location Service Manager for Kotlin Multiplatform Mobile iOS and Android
- Host: GitHub
- URL: https://github.com/line/abc-kmm-location
- Owner: line
- License: apache-2.0
- Created: 2021-10-15T01:32:50.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-20T22:41:19.000Z (over 1 year ago)
- Last Synced: 2024-09-27T00:01:51.271Z (3 months ago)
- Topics: android, corelocation, fusedlocationapi, googleservice, ios, kotlin-multiplatform, location-service
- Language: Kotlin
- Homepage:
- Size: 190 KB
- Stars: 86
- Watchers: 10
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- kmp-awesome - abc-kmm-Location - Location manager (Libraries / 📱 Device)
README
[](http://kotlinlang.org)
[](https://plugins.jetbrains.com/plugin/14936-kotlin-multiplatform-mobile)
[](https://developer.android.com/studio/releases/gradle-plugin)
[](https://gradle.org)
[](https://img.shields.io/badge/platform-ios-lightgray.svg?style=flat)
Location Service Manager for Kotlin Multiplatform Mobile iOS and android
## Features
- Super easy to use location capability in one interface
- Provides simple permission settings and management
- Dramatically reduce code to write
- Common interface available on KMM Shared
## Usage
### Register handlers for permissions
- Android
```kotlin
ABCLocation
.onPermissionUpdated(this) { isGranted ->
println("onPermissionUpdated -> isGranted: $isGranted")
}
.onLocationUnavailable(this) {
println("onLocationUnavailable")
}
```
- iOS
```swift
ABCLocation.Companion()
.onPermissionUpdated(target: self) { isGranted ->
print("onPermissionUpdated -> isGranted: \(isGranted)")
}
.onLocationUnavailable(target: self) {
print("onLocationUnavailable")
}
.onAlwaysAllowsPermissionRequired(target: self) {
print("onAlwaysAllowsPermissionRequired")
}
```
### To get current location just once
- Android
```kotlin
ABCLocation.currentLocation { data ->
println("currentLocation -> data: $data")
}
```
- iOS
```swift
ABCLocation.Companion().currentLocation { data in
print("currentLocation -> data: \(data)")
}
```
### To get current location whenever location changes
- Android
```kotlin
ABCLocation
.onLocationUpdated(this) { data ->
println("onLocationUpdated -> data: $data")
}
.startLocationUpdating()
```
- iOS
```swift
ABCLocation.Companion()
.onLocationUpdated(target: self) { data in
print("onLocationUpdated -> data: \(data)")
}
.startLocationUpdating()
```
### To stop location updating
- Android
```kotlin
ABCLocation.stopLocationUpdating()
```
- iOS
```swift
ABCLocation.Companion().stopLocationUpdating()
```
## Installation
### Gradle Settings
Add below gradle settings into your KMP (Kotlin Multiplatform Project)
#### build.gradle.kts in shared
```kotlin
plugins {
id("com.android.library")
kotlin("multiplatform")
}
val abcLocationLib = "com.linecorp.abc:kmm-location:0.2.4"
kotlin {
android()
ios {
binaries
.filterIsInstance()
.forEach {
it.baseName = "shared"
it.transitiveExport = true
it.export(abcLocationLib)
}
}
sourceSets {
val commonMain by getting {
dependencies {
implementation(abcLocationLib)
}
}
val commonTest by getting {
dependencies {
implementation(kotlin("test-common"))
implementation(kotlin("test-annotations-common"))
}
}
val androidMain by getting {
dependencies {
implementation("com.google.android.material:material:1.2.1")
implementation(abcLocationLib)
}
}
val androidTest by getting {
dependencies {
implementation(kotlin("test-junit"))
implementation("junit:junit:4.13.2")
implementation("androidx.test:core:1.0.0")
implementation("androidx.test:runner:1.1.0")
implementation("org.robolectric:robolectric:4.2")
}
}
val iosMain by getting {
dependencies {
implementation(abcLocationLib)
}
}
val iosTest by getting
}
}
```
### Project Settings
Android
- You can use right now without other settings.
iOS
1. Create `Podfile` with below setting in your project root.
```bash
use_frameworks!
platform :ios, '10.0'
install! 'cocoapods', :deterministic_uuids => false
target 'iosApp' do
pod 'shared', :path => '../shared/'
end
```
2. Run command `pod install` on the terminal
## Requirements
- iOS
- Deployment Target 10.0 or higher
- Android
- minSdkVersion 21