yandex-mapkit-kmp

KO | EN

gitlite — search

#python #ai #typescript #rust #deep-learning #nodejs #windows #awesome #kubernetes #vue #security #ios #mcp #open-source

yandex-mapkit-kmp

(★ 69)

Kotlin-first SDK for Yandex MapKit. It's API is similar to the Yandex MapKit SDK but also supports multiplatform projects and compose multiplaform, enabling you to use MapKit directly from your common source targeting iOS or Android.

yandex-mapkit-kmp 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Yandex MapKit KMP SDK

[![CI](https://github.com/SuLG-ik/yandex-mapkit-kmp/actions/workflows/ci.yml/badge.svg)](https://github.com/SuLG-ik/yandex-mapkit-kmp/actions/workflows/ci.yml)
[![Kotlin](https://img.shields.io/badge/kotlin-2.4.10-blue.svg?logo=kotlin)](http://kotlinlang.org)
[![Compose Multiplatform](https://img.shields.io/badge/Compose%20Multiplatform-v1.11.1-blue)](https://github.com/JetBrains/compose-multiplatform)
[![Maven Central](https://img.shields.io/maven-central/v/ru.sulgik.mapkit/yandex-mapkit-kmp?color=blue)](https://search.maven.org/artifact/ru.sulgik.mapkit/yandex-mapkit-kmp)
[![License](https://img.shields.io/badge/License-Apache/2.0-blue.svg)](https://github.com/SuLG-ik/yandex-mapkit-kmp/blob/main/LICENSE)
![badge-android](http://img.shields.io/badge/platform-android-6EDB8D.svg?style=flat&color=blue)
![badge-ios](http://img.shields.io/badge/platform-ios-CDCDCD.svg?style=flat&color=blue)

Kotlin-first SDK for Yandex MapKit. Its API is similar to the Yandex MapKit SDK but also supports
multiplatform projects and Compose Multiplatform, enabling you to use MapKit directly from your
common source targeting iOS or Android.

**_NOTE:_ It is not Yandex's project. Author has no connection with original SDK, it is wrapper
above official Yandex MapKit SDK**

# Available libraries

The following libraries are available. It
uses [Yandex MapKit SDK](https://yandex.ru/dev/mapkit/doc/ru/) version *4.42.0-lite*

| Module	                                        | Gradle Dependency                                                                                                                             | Description                                                                                                                                              |
|------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Core](yandex-mapkit-kmp)                      | [`ru.sulgik.mapkit:yandex-mapkit-kmp:1.0.0-beta01`](https://search.maven.org/artifact/ru.sulgik.mapkit/yandex-mapkit-kmp)                            | Features of original Yandex MapKit SDK                                                                                                                   |
| [Compose](yandex-mapkit-kmp-compose)           | [`ru.sulgik.mapkit:yandex-mapkit-kmp-compose:1.0.0-beta01`](https://search.maven.org/artifact/ru.sulgik.mapkit/yandex-mapkit-kmp-compose)            | Component to draw map and [compose-resources](https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-images-resources.html) usage as map images |
| [Moko](yandex-mapkit-kmp-moko)                 | [`ru.sulgik.mapkit:yandex-mapkit-kmp-moko:1.0.0-beta01`](https://search.maven.org/artifact/ru.sulgik.mapkit/yandex-mapkit-kmp-moko)                  | Use [moko-resources](https://github.com/icerockdev/moko-resources) as map images. Requires native initialization                                         |
| [Moko Compose](yandex-mapkit-kmp-moko-compose) | [`ru.sulgik.mapkit:yandex-mapkit-kmp-moko-compose:1.0.0-beta01`](https://search.maven.org/artifact/ru.sulgik.mapkit/yandex-mapkit-kmp-moko-compose) | Use [moko-resources](https://github.com/icerockdev/moko-resources) as image provider. Not require native initialization                                  |

## Installation

The minimum supported Android SDK is 26 (Android 8.0).

Supported iOS targets are `iosArm64` and `iosSimulatorArm64`. The `iosX64` target was dropped
because Compose Multiplatform no longer publishes for it.

All modules are available for use in common code, but native API available only in native code.

On iOS the
official [Yandex MapKit SDK](https://yandex.ru/dev/mapkit/doc/ru/ios/generated/getting_started) is
not linked as a transitive dependency. Therefore, any project using this SDK needs to link the same
Yandex MapKit SDK as well. This can be done through your preferred installation
method ([CocoaPods](https://kotlinlang.org/docs/native-cocoapods.html)/[SPM](https://kotlinlang.org/docs/native-spm.html#project-configuration-options)).

```kotlin
kotlin {
  cocoapods {
    pod("YandexMapsMobile") {
      version = "<mapkit-version>"
    }
  }
  sourceSets {
    commonMain.dependencies {
      implementation("ru.sulgik.mapkit:yandex-mapkit-kmp:<version>") // main module
      implementation("ru.sulgik.mapkit:yandex-mapkit-kmp-compose:<version>") // optional compose support
      implementation("ru.sulgik.mapkit:yandex-mapkit-kmp-moko:<version>") // optional: moko support
      implementation("ru.sulgik.mapkit:yandex-mapkit-kmp-moko-compose:<version>") // optional: moko compose resources support
    }
  }
}
```

## Compatibility

Within `1.x` the modules guarantee **source** compatibility, not binary compatibility.

The wrapper follows MapKit, and MapKit adds fields to its structures and constants to its enums in
minor releases. Those structures are `data class`es here, so a new field changes `componentN` and
`copy$default`, and a new enum constant makes an exhaustive `when` over it stop compiling. Both are
binary-breaking, and refusing them would mean freezing the wrapper on one MapKit version.

So: recompile against the version you depend on, do not mix wrapper versions in a single dependency
graph, and expect a `when` over a wrapper enum to need a new branch after an update. Renames,
removals and signature changes are reserved for a major release.

## Documentation

Full documentation is at [ymk-kmp.sulgik.ru](https://ymk-kmp.sulgik.ru), in
[English](https://ymk-kmp.sulgik.ru) and [Russian](https://ymk-kmp.sulgik.ru/ru/), with the KDoc
under [/kdoc](https://ymk-kmp.sulgik.ru/kdoc/).

yandex-mapkit-kmp

yandex-mapkit-kmp 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

yandex-mapkit-kmp

yandex-mapkit-kmp 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README