The Mapbox Maps Gestures Plugin for Android is an public library for handling gesture interaction with a MapView. By default the plugin provides a default gesture interaction. Gestures supported include scrolling, scaling, rotating and shoving. Please visit our documentation for more information on interacting with gestures.

A full overview of classes and interfaces can be found in our API documentation.

This README is intended for developers who are interested in contributing to the Mapbox Maps Gestures Plugin for Android. Please visit DEVELOPING.md for general information and instructions on how to use the Mapbox Maps Plugin System. To add the gestures plugin to your project, you configure its dependency in your build.gradle files.

// In the root build.gradle file
// The Mapbox access token needs to a scope set to DOWNLOADS:READ
allprojects {
    repositories {
        maven {
            url 'https://api.mapbox.com/downloads/v2/releases/maven'
            authentication {
                basic(BasicAuthentication)
            }
            credentials {
                username = "mapbox"
                password = "INSERT_MAPBOX_ACCESS_TOKEN_HERE"
            }
        }
    }
}

// In the app build.gradle file
dependencies {
  implementation 'com.mapbox.plugin:maps-gestures:11.24.0-rc.1'
    // Mapbox Maps Gestures Plugin depends on the Mapbox Maps Animation Plugin
  implementation 'com.mapbox.plugin:maps-animation:11.24.0-rc.1'
}

Please note that Mapbox Maps Gestures Plugin uses on the Mapbox Gestures Android, for more information visit mapbox/mapbox-gestures-android.

Customizing Mapbox Maps Gestures Plugin for Android could be done in two ways: by either providing your own version of the gestures plugin or by setting the GesturesSettings to the gestures plugin. The former is documented in DEVELOPING.md, the latter can be achieved with:

val plugin = mapView.gestures
plugin.gesturesSettings = GesturesSettings(...)

More concrete examples of the gestures plugin can be found in our test application.

View LICENSE.md for all dependencies used by this plugin.