The ArcGIS Maps SDK for Kotlin Toolkit contains components that will simplify your Kotlin app development. It is built off of the new ArcGIS Maps SDK for Kotlin.
- Augmented Reality - Provides components to "augment" the physical world with virtual content.
- FlyoverSceneView - Allows you to explore a scene using your device as a window into the virtual world.
- TableTopSceneView - Allows you to anchor scene content to a physical surface, as if it were a 3D-printed model.
- WorldScaleSceneView - Allows you to integrate scene content with the real world features like streets and buildings.
- Authenticator - Displays a user interface when network and ArcGIS authentication challenges occur.
- Basemap Gallery - Provides a control for selecting basemaps
- Compass - Shows a compass direction when the map is rotated. Auto-hides when the map points north.
- FeatureForms - Provides a UI for editing feature attributes.
- FloorFilter - Allows filtering of floor plan data in a geo view by a site, a facility in the site, or a floor in the facility.
- GeoView-Compose - Compose wrappers for the MapView and SceneView.
- Callout - Draws a callout on the GeoView to display Composable content.
- OverviewMap - Displays the visible extent of a GeoView in a small "inset" map.
- Legend - Displays a legend for a map or a scene.
- OfflineMapAreas - Allows you to take a web map offline by downloading map areas ahead-of-time or on-demand.
- Popup - View field values of features in a layer using the Popup API.
- Scalebar - Displays current scale reference.
- UtilityNetworkTrace - Configure, run, and visualize UtilityNetworkTraces on a composable MapView.
View the API reference for the toolkit here.
Please see the developer setup for a complete description of requirements
- ArcGIS Maps SDK for Kotlin
See this guide for complete instructions and other options for installing the SDK. - JDK 17
The ArcGIS Maps SDK for Kotlin Toolkit has a Minimum SDK version of 26, meaning that it can run on devices with Android Oreo (8.0) or newer.
Add the maven repository to your project's gradle file:
repositories {
maven {
url = uri("https://esri.jfrog.io/artifactory/arcgis")
}
}
The ArcGIS Maps SDK for Kotlin Toolkit is released with a "bill of materials" (BOM). The releasable BOM is versioned and represents a set of versions of the toolkit components which are compatible with one another. You may specify dependencies as follows
implementation(platform("com.esri:arcgis-maps-kotlin-toolkit-bom:200.8.0"))
implementation("com.esri:arcgis-maps-kotlin-toolkit-authentication")
implementation("com.esri:arcgis-maps-kotlin-toolkit-basemapgallery")
implementation("com.esri:arcgis-maps-kotlin-toolkit-compass")
implementation("com.esri:arcgis-maps-kotlin-toolkit-featureforms")
implementation("com.esri:arcgis-maps-kotlin-toolkit-geoview-compose")
implementation("com.esri:arcgis-maps-kotlin-toolkit-legend")
implementation("com.esri:arcgis-maps-kotlin-toolkit-offline")
implementation("com.esri:arcgis-maps-kotlin-toolkit-indoors")
implementation("com.esri:arcgis-maps-kotlin-toolkit-popup")
implementation("com.esri:arcgis-maps-kotlin-toolkit-scalebar")
implementation("com.esri:arcgis-maps-kotlin-toolkit-utilitynetworks")
implementation("com.esri:arcgis-maps-kotlin-toolkit-ar")
The template and TemplateApp modules are for bootstrapping new modules.
Please see the package structure documentation for more details.
Some toolkit components may require access to Esri location services, including basemaps, routing, and geocoding, which requires authentication using either an API Key or an ArcGIS identity. The toolkit code is set up to easily use an API key.
A long-lived access token that gives your application access to ArcGIS location services. Go to the Create an API key tutorial to obtain a new API key access token. Ensure that the following privileges are enabled:
- Location services > Basemaps
- Location services > Geocoding
- Location services > Routing
The components in this repository have been structured to use an access token, set once.
Set your access token in the local.properties in the same folder as the
secrets.defaults.properties as shown below.
API_KEY=YOUR_ACCESS_TOKENAn ArcGIS named user account that is a member of an organization in ArcGIS Online or ArcGIS Enterprise can be used as an alternative to API keys. Most toolkit micro apps don't make use of named user authentication. See User authentication for more information.
Find a bug or want to request a new feature enhancement? Please let us know by submitting an issue.
Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.
A new toolkit component can be added to this project by running the bash script at the top level
./new-component-starter.sh
This script will prompt for you to input a name for the new component and ask if you want to create a new app module for it. Capitalization isn't necessary, but it won't capitalize anything but the first letter if none is specified.
A new microapp can be added by running the bash script ./new-microapp-starter.sh.
This script will prompt for you to input a name for the new microapp.
This script requires bash 4.0 or higher.
The project is structured into two folders, microapps and toolkit each containing many modules, and a folder for releasing a bill of materials (BOM).
arcgis-maps-sdk-kotlin-toolkit
├── bom
│ └── build.gradle.kts
├── microapps
│ └── TemplateApp
│ ├── ...App
├── toolkit
│ ├── template
│ ├── ...
├── build.gradle.kts
└── settings.gradle.kts
The toolkit folder contains releasable libraries -- these are the components of the toolkit.
For each module in the toolkit folder there is a corresponding app in the microapps folder which depends on it.
The apps are not released but are useful for working on a particular component in isolation.
The template and TemplateApp modules are for bootstrapping new modules.
Please see the package structure documentation for more details.
In order to run local (non-instrumented) tests of all modules and get an aggregated test report, run the following at the root folder of the project:
./gradlew testAggregatedReport --continue
The test report for local tests can be located under arcgis-maps-sdk-kotlin-toolkit/build/reports.
In order to run connected (instrumented) tests of all modules and get the test reports in a centralized folder, run the following at the root folder of the project:
./gradlew connectedDebugAndroidTest --continue
The test reports for connected tests can be located under arcgis-maps-sdk-kotlin-toolkit/connectedTestReports.
Copyright 2019-2025 Esri
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
A copy of the license is available in the repository's LICENSE file.