h3-kmp
0.0.7indexedConverts Uber's H3 geospatial indexes to LatLng vertices and back, with utilities for geo→H3 conversion, polygon vertex extraction, and sample app examples.
12
Stars
—
Used by
dependents
40
Health
/ 100
H3-KMP library 
A library to convert Uber's H3 geo-index to LatLng vertices and back for Kotlin Multiplatform: iOS, Android, and Wasm/JS (browser + Node).
Experimental
- Android, iOS, wasmJs are ready to use, API may change
- wasmJs variant bridges to the
h3-jsnpm package via JS interop (Kotlin/Wasm has no cinterop, so the in-tree C sources used for iOS/Android cannot be reused directly).
Instalation
[!NOTE] Replace "0.0.7" with
Gradle KMP
kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.phansier.h3:library:0.0.7")
/*
# or using version catalog:
# libs.version.toml
[versions]
h3 = "0.0.7"
[libraries]
h3 = { module = "io.github.phansier.h3:library", version.ref = "h3" }
*/
// implementation(libs.h3)
}
}
}
Gradle Android
dependencies {
implementation("io.github.phansier.h3:library:0.0.7")
// implementation(libs.h3)
}
Usage
import com.beriukhov.h3.H3
import com.beriukhov.h3.LatLng as H3LatLng
// https://h3geo.org/#hex=084754a9ffffffff
val polygon: List<H3LatLng> = H3.vertices("084754a9ffffffff")
// res - Resolution, 0 <= res <= 15
val h3Index: String = geoToH3(H3LatLng(0.0, 0.0), res = 4).toHexString()
Run Sample App
- Android:
open project in Android Studio and run the sample app - iOS:
open 'sample/iosApp/iosApp.xcodeproj' in Xcode and run the sample app
Publish to MavenLocal
- Run
./gradlew :library:publishToMavenLocal - Open
~/.m2/repository/io/github/phansier/h3/
Inspired by
- abc-kmm-h3 - not updated 4 years
- h3-java - was not supported and easy to use in Android when works started
- h3-go - includes C lib as sources - same approach used here