compass

Compass is a Kotlin Multiplatform library location toolkit. It provides a set of tools for working with location data, including geocoding, reverse geocoding, and more. The library is built with a focus on simplicity and ease of use, providing a straightforward API for geocoding operations.

Check out the Documentation for detailed instructions. You can also view the generated KDoc at docs.compass.jordond.dev

[!IMPORTANT] Compass 4.0.0 removes the Google Play Services dependency on Android. geolocation-mobile now uses the built-in LocationManager. To keep the fused location provider, add dev.jordond.compass:geolocation-android-gms to your Android source set. No API changed. See the migration guide.

• Features
• Setup
• Demo
• Contributing
• License

• Geocoding:
  • Convert an address to a latitude and longitude (forward geocoding)
  • Convert a latitude and longitude to an address (reverse geocoding)
  • Support via native Android/iOS services
  • Support via third party APIs for all platforms (planned)
• Geolocation:
  • Built in permission handling
  • Get the current location of the device
  • Monitor the location of the device
  • JS/WASM browser geolocation support
  • No Google Play Services dependency on Android, with opt-in fused location support
• Autocomplete:
  • Provide suggestions for addresses based on user input
  • Support via native Android/iOS services
  • Support for all platforms via third party geocoder API's
  • Support for Google Places API (planned)

Read the Setup documentation for more information on setup and usage.

A demo app is available in the demo directory. It is a Compose Multiplatform app that runs on Android, and iOS.

See Documentation for more.

Contributions are always welcome!. If you'd like to contribute, please feel free to create a PR or open an issue.

See Documentation for more.

See LICENSE for more information.

Documentation website is powered via https://gitbook.com