Skip to content
Mapbox Android Plugins are a collection of libraries that extend our other SDKs, helping you design powerful mapping features while the plugins handle most of the heavy lifting.
Java HTML Kotlin JavaScript Makefile
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github copying settings from mapbox-gl-native (#747) Oct 29, 2018
.tx adds transifex (#463) Apr 30, 2018
app [annotation] re-add airplane bitmap when symbol example style changes Oct 14, 2019
config/checkstyle deprecate all methods in geojson plugin (#497) May 9, 2018
gradle bumped maps sdk version to 8.6.0 (#1084) Jan 6, 2020
ktx-mapbox-maps [all] - remove java 8 language support May 2, 2019
plugin-annotation [annotation] expose underlying, generated Layer ID Nov 20, 2019
plugin-building add javadoc Jun 24, 2019
plugin-localization [localization] Changed timber log level from warning to debug (#1085) Jan 8, 2020
plugin-locationlayer [LLP] remove the source code of the LocationLayerPlugin Jan 8, 2019
plugin-markerview
plugin-offline Bumped plugin version numbers in README files for giant release follo… Jun 12, 2019
plugin-places Added user location button to Places Plugin's PlacePickerActivity (#994) Jun 21, 2019
plugin-scalebar [scalebar] Release Scale Bar Plugin 0.3.0 (#1041) Aug 20, 2019
plugin-traffic Bumped plugin version numbers in README files for giant release follo… Jun 12, 2019
scripts [location-layer] disabled LocationLayerPlugin's test suite Nov 8, 2018
.editorconfig Adding Kotlin lint check plugin and cleanup tweaks (#1012) Jul 12, 2019
.gitignore [build] - add generated activity sanity test using ejs Sep 18, 2018
.gitmodules [annotation] - migrate to mapbox-gl-js submodule for referencing styl… May 24, 2019
CHANGELOG.md Release ScalebarPlugin 0.2.0 (#1022) Jul 29, 2019
CONTRIBUTING.md adds transifex (#463) Apr 30, 2018
LICENSE Happy New Year 2019! Jan 9, 2019
Makefile Added scalebar to plugin list at top of makefile (#1023) Jul 29, 2019
README.md Bumped plugin version numbers in README files for giant release follo… Jun 12, 2019
build.gradle bump Maps SDK to the stable v8.3.0 (#1045) Aug 30, 2019
circle.yml [plugins] - init submodules as part of ci build May 24, 2019
gradle.properties Remove location layer dep in places plugin (#319) Feb 27, 2018
gradlew moved modules to outer root folder (#144) Nov 1, 2017
gradlew.bat moved modules to outer root folder (#144) Nov 1, 2017
package-lock.json Bump lodash from 4.17.11 to 4.17.13 Aug 1, 2019
package.json [annotation] - update lodash npm dependency Jul 15, 2019
settings.gradle Add Scale bar plugin (#955) May 29, 2019

README.md


Mapbox Plugins

Plugins are single-purpose libraries built on top of the Mapbox Maps SDK for Android that you can include in your apps like any other Android dependency


Mapbox Plugins for Android

Plugins are single-purpose libraries built on top of the Mapbox Maps SDK for Android that you can include in your apps like any other Android dependency. You'll find documentation for each plugin on our Android documentation website. A full list of the current plugins is available below.

Available Plugins

Installing a plugin

By using a plugin, you also have to include the Mapbox Maps SDK for Android which means that you'll need to setup your project to use the Maps SDK if you haven't already. Head over to the overview page for the Maps SDK to learn more.

Note that depending on the plugin you add, there might be required permissions and additional setup steps. You'll find more information on whether or not more configuration steps are involved when looking at the specific plugin documentation.

  1. Start Android Studio
  2. Open up your application's build.gradle
  3. Make sure that your project's minSdkVersion is at API 14 or higher
  4. Under dependencies, add a new build rule for the latest plugin version you are trying to use.
repositories {
  mavenCentral()
}

dependencies {
  implementation 'com.mapbox.mapboxsdk:{PLUGIN_NAME}-v{MAJOR_MAPS_SDK_VERSION_NUMBER}:PLUGIN_VERSION_NUMBER'
}

Plugin artifacts are versioned based on the major release of the Maps SDK for Android, which means, that each artifact's name has a major version of the Maps SDK it's compatible with appended.

  1. Click the Sync Project with Gradle Files near the toolbar in Studio.

Maps SDK compatibility

The Mapbox Plugins for Android are heavily dependent on the major semantic versioning number of the Maps SDK. They either won't compile or hide runtime bugs when paired with a different major version of the Maps SDK. Each plugin's dependency name has a vX suffix which states the major version of the Maps SDK that the plugin is compatible with. This suffix makes the transition between versions easier and more educated without the need to jump into changelogs and compare repositories.

Help and Usage

This repository includes an app that shows how to use each plugins in this repository. Check out its code for ready-to-use snippets.

Plugins are easy to use. A plugin is simply a library module built on top of the Mapbox Maps SDK for Android. Currently, we are not requiring plugins to register themselves or to implement any specific interfaces so that they're simple to consume.

This might change in the future as we build more plugins and learn how you use them. We'd love to hear your feedback.

Why Plugins

Splitting specific functionality into plugins makes our Maps SDK lighter and nimble for you to use, and it also lets us iterate faster. We can release plugins more often than the SDK, which requires a slower pace due to its larger codebase.

The Mapbox Android team creates plugins but this plugins repository is an open-source project similar to the various Mapbox SDKs for Android. Plugins' lightweight nature makes them much easier for you and anyone else to contribute rather than trying to add the same feature to the more robust Maps SDK. The Mapbox team can also more easily accept contributed plugins and keep the plugin list growing.

Contributing

We welcome contributions to this plugin repository!

If you're interested in building and sharing your own plugin, please read the contribution guide to learn how to get started.

You can’t perform that action at this time.