Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icerockdev/moko-maps
Control your map from common code for mobile (android & ios) Kotlin Multiplatform development
https://github.com/icerockdev/moko-maps
android ios kotlin kotlin-multiplatform kotlin-native moko
Last synced: 3 months ago
JSON representation
Control your map from common code for mobile (android & ios) Kotlin Multiplatform development
- Host: GitHub
- URL: https://github.com/icerockdev/moko-maps
- Owner: icerockdev
- License: apache-2.0
- Created: 2019-12-23T09:59:18.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-04-12T11:29:25.000Z (over 2 years ago)
- Last Synced: 2024-07-12T20:08:51.954Z (4 months ago)
- Topics: android, ios, kotlin, kotlin-multiplatform, kotlin-native, moko
- Language: Kotlin
- Homepage: https://moko.icerock.dev/
- Size: 399 KB
- Stars: 77
- Watchers: 7
- Forks: 16
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
- kmp-awesome - MOKO Maps - Google/Mapbox maps manager (Libraries / 📱 Device)
README
[](http://www.apache.org/licenses/LICENSE-2.0) [ ](https://repo1.maven.org/maven2/dev/icerock/moko/maps) 
# Mobile Kotlin maps module
This is a Kotlin Multiplatform library that provides controls of maps 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
- **Markers** - add markers to map from common code;
- **Route** - draw route by waypoints from common code;
- **Camera** - control camera (zoom, location) from common code.
## Requirements
- Gradle version 6.0+
- Android API 16+
- iOS version 9.0+
## Installation
root build.gradle
```groovy
allprojects {
repositories {
mavenCentral()
maven { url = "https://mapbox.bintray.com/mapbox" } // if mapbox required
}
}
```
project build.gradle
```groovy
dependencies {
commonMainApi("dev.icerock.moko:maps:0.6.0")
commonMainApi("dev.icerock.moko:maps-google:0.6.0")
commonMainApi("dev.icerock.moko:maps-mapbox:0.6.0")
}
kotlin.targets
.matching { it is org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget }
.configureEach {
val target = this as org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
target.binaries
.matching { it is org.jetbrains.kotlin.gradle.plugin.mpp.Framework }
.configureEach {
val framework = this as org.jetbrains.kotlin.gradle.plugin.mpp.Framework
val frameworks = listOf("Base", "Maps").map { frameworkPath ->
project.file("../ios-app/Pods/GoogleMaps/$frameworkPath/Frameworks").path.let { "-F$it" }
}.plus(
project.file("../ios-app/Pods/Mapbox-iOS-SDK/dynamic").path.let { "-F$it" }
)
framework.linkerOpts(frameworks)
}
}
```
With [mobile-multiplatform-gradle-plugin](https://github.com/icerockdev/mobile-multiplatform-gradle-plugin) cocoapods configuration simplest:
`build.gradle.kts`:
```kotlin
cocoaPods {
podsProject = file("ios-app/Pods/Pods.xcodeproj")
precompiledPod(
scheme = "GoogleMaps",
onlyLink = true
) { podsDir ->
listOf(
File(podsDir, "GoogleMaps/Base/Frameworks"),
File(podsDir, "GoogleMaps/Maps/Frameworks")
)
}
precompiledPod(
scheme = "Mapbox",
onlyLink = true
) { podsDir ->
listOf(File(podsDir, "Mapbox-iOS-SDK/dynamic"))
}
}
```
project Podfile
```ruby
pod 'GoogleMaps', '3.7.0'
pod 'Mapbox-iOS-SDK', '5.5.0'
# GoogleMaps is static library that already linked in moko-maps-google. Remove duplicated linking.
post_install do |installer|
host_targets = installer.aggregate_targets.select { |aggregate_target|
aggregate_target.name.include? "Pods-"
}
host_targets.each do |host_target|
host_target.xcconfigs.each do |config_name, config_file|
config_file.frameworks.delete("GoogleMaps")
config_file.frameworks.delete("GoogleMapsBase")
config_file.frameworks.delete("GoogleMapsCore")
xcconfig_path = host_target.xcconfig_path(config_name)
config_file.save_as(xcconfig_path)
end
end
end
```
## Usage
### Markers
```kotlin
class MarkerViewModel(
val mapsController: GoogleMapController
) : ViewModel() {
fun start() {
viewModelScope.launch {
val marker1 = mapsController.addMarker(
image = MR.images.marker,
latLng = LatLng(
latitude = 55.045853,
longitude = 82.920154
),
rotation = 0.0f
) {
println("marker 1 pressed!")
}
marker1.rotation = 90.0f
}
}
}
```
### Route
```kotlin
class MarkerViewModel(
val mapsController: GoogleMapController
) : ViewModel() {
fun start() {
viewModelScope.launch {
val route = mapsController.buildRoute(
points = listOf(
LatLng(
latitude = 55.032200,
longitude = 82.889360
),
LatLng(
latitude = 55.030853,
longitude = 82.920154
),
LatLng(
latitude = 55.013109,
longitude = 82.926480
)
),
lineColor = Color(0xCCCC00FF),
markersImage = MR.images.marker
)
}
}
}
```
## Samples
Please see more examples in the [sample directory](sample).
## Set Up Locally
Before open project need to setup `gradle.properties` with tokens:
```
# mapbox tokens by guide https://docs.mapbox.com/android/maps/guides/install/
mapbox.secretToken=YOUR_SECRET_MAPBOX_KEY
mapbox.publicToken=YOUR_PUBLIC_MAPBOX_KEY
# google maps api key by guide https://developers.google.com/maps/documentation/android-sdk/get-api-key
googleMaps.apiKey=YOUR_API_KEY
```
# ios info.plist setup with tokens:
```
MGLMapboxAccessToken=YOUR_PUBLIC_MAPBOX_KEY
GoogleAPIkey=YOUR_API_KEY
```
add the following entry to your `.netrc` file:
```
machine api.mapbox.com
login mapbox
password YOUR_SECRET_MAPBOX_KEY
```
- The [maps directory](maps) contains the base classes for all maps providers;
- The [maps-google directory](maps-google) contains the Google Maps implementation;
- The [maps-mapbox directory](maps-mapbox) contains the mapbox implementation;
- In [sample directory](sample) contains sample apps for Android and iOS; plus the mpp-library connected to the apps.
*before compilation of iOS target required `pod install` in `sample/ios-app` directory*
## 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.