Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icerockdev/moko-geo
Geolocation access for mobile (android & ios) Kotlin Multiplatform development
https://github.com/icerockdev/moko-geo
android ios kotlin kotlin-multiplatform kotlin-multiplatform-mobile kotlin-native moko
Last synced: 3 months ago
JSON representation
Geolocation access for mobile (android & ios) Kotlin Multiplatform development
- Host: GitHub
- URL: https://github.com/icerockdev/moko-geo
- Owner: icerockdev
- License: apache-2.0
- Created: 2019-12-23T05:30:25.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-07T17:10:35.000Z (4 months ago)
- Last Synced: 2024-07-12T20:08:44.445Z (4 months ago)
- Topics: android, ios, kotlin, kotlin-multiplatform, kotlin-multiplatform-mobile, kotlin-native, moko
- Language: Kotlin
- Homepage: https://moko.icerock.dev/
- Size: 157 KB
- Stars: 142
- Watchers: 6
- Forks: 17
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- mobile-awesome - moko-geo - Geolocation access for mobile (android & ios) Kotlin Multiplatform development. (Multiplatform / Multiplatform libraries)
- kmp-awesome - MOKO Geo - Location manager (Libraries / 📱 Device)
README
[](http://www.apache.org/licenses/LICENSE-2.0) [ ](https://repo1.maven.org/maven2/dev/icerock/moko/geo) 
# Mobile Kotlin geolocation module
This is a Kotlin Multiplatform library that provides geolocation to common code.
## Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Samples](#samples)
- [Set Up Locally](#set-up-locally)
- [Contributing](#contributing)
- [License](#license)
## Features
- **Geolocation tracking** - track user geolocation from common code;
- **Compose Multiplatform** support;
## Requirements
- Gradle version 6.0+
- Android API 16+
- iOS version 9.0+
## Installation
root build.gradle
```groovy
allprojects {
repositories {
mavenCentral()
}
}
```
project build.gradle
```groovy
dependencies {
commonMainApi("dev.icerock.moko:geo:0.6.0")
// Compose Multiplatform
commonMainApi("dev.icerock.moko:geo-compose:0.6.0")
}
```
## Usage
in common code:
```kotlin
class TrackerViewModel(
val locationTracker: LocationTracker
) : ViewModel() {
init {
viewModelScope.launch {
locationTracker.getLocationsFlow()
.distinctUntilChanged()
.collect { println("new location: $it") }
}
}
fun onStartPressed() {
viewModelScope.launch { locationTracker.startTracking() }
}
fun onStopPressed() {
locationTracker.stopTracking()
}
}
```
In Android:
```kotlin
// create ViewModel
val locationTracker = LocationTracker(
permissionsController = PermissionsController(applicationContext = applicationContext)
)
val viewModel = TrackerViewModel(locationTracker)
// bind tracker to lifecycle
viewModel.locationTracker.bind(lifecycle, this, supportFragmentManager)
```
In iOS:
```swift
let viewModel = TrackerViewModel(
locationTracker: LocationTracker(
permissionsController: PermissionsController(),
accuracy: kCLLocationAccuracyBest
)
)
```
## Samples
Please see more examples in the [sample directory](sample).
## Set Up Locally
- The [geo directory](geo) contains the `geo` library;
- In [sample directory](sample) contains sample apps for Android and iOS; plus the mpp-library connected to the apps.
## Contributing
All development (both new features and bug fixes) is performed in the `develop` branch. This way `master` always contains the sources of the most recently released version. Please send PRs with bug fixes to the `develop` branch. Documentation fixes in the markdown files are an exception to this rule. They are updated directly in `master`.
The `develop` branch is pushed to `master` on release.
For more details on contributing please see the [contributing guide](CONTRIBUTING.md).
## License
Copyright 2019 IceRock MAG Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.