Mobile Kotlin maps module

This is a Kotlin Multiplatform library that provides controls of maps to common code.

Features
Requirements
Versions
Installation
Usage
Samples
Set Up Locally
Contributing
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 5.6.4+
Android API 16+
iOS version 9.0+

Versions

kotlin 1.3.61
- 0.1.0
- 0.1.1
- 0.2.0
- 0.2.1
- 0.3.0
- 0.4.0-dev-1
kotlin 1.3.70
- 0.4.0-dev-2
- 0.4.0-dev-3
- 0.4.0-dev-4

Installation

root build.gradle

allprojects {
    repositories {
        maven { url = "https://dl.bintray.com/icerockdev/moko" }
        maven { url = "https://kotlin.bintray.com/native-xcode" }
    }
}

project build.gradle

dependencies {
    commonMainApi("dev.icerock.moko:maps:0.4.0-dev-4")
    commonMainApi("dev.icerock.moko:maps-google:0.4.0-dev-4")
    commonMainApi("dev.icerock.moko:maps-mapbox:0.4.0-dev-4")
}

kotlin {
    targets
        .filterIsInstance<org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget>()
        .flatMap { it.binaries }
        .filterIsInstance<org.jetbrains.kotlin.gradle.plugin.mpp.Framework>()
        .forEach { 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)
        }
}

project Podfile

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

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

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.

Set Up Locally

The maps directory contains the base classes for all maps providers;
The maps-google directory contains the Google Maps implementation;
The maps-mapbox directory contains the mapbox implementation;
In sample directory contains sample apps for Android and iOS; plus the mpp-library connected to the apps;
For local testing use the ./publishToMavenLocal.sh script - so that sample apps use the locally published version.

./gradlew -PlibraryPublish :maps:publishToMavenLocal # build core classes
(cd sample/ios-app && pod install) && ./gradlew -PprovidersPublish :maps-google:publishToMavenLocal # install pods with GoogleMaps (required for cinterop of maps-google) and build GoogleMaps integration lib 
./gradlew :sample:mpp-library:syncMultiPlatformLibraryDebugFrameworkIosX64 # try build sample

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.

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.

prokopishin/moko-maps