Toolkit

ArcGIS Maps SDK for Kotlin offers a toolkit, ArcGIS Maps SDK for Kotlin Toolkit, that contains composable UI components to help simplify your Android development work. Available components include:

  • Authenticator - Displays a user interface when network and ArcGIS authentication challenges occur.
  • Compass - Shows a compass direction when the map is rotated. Auto-hides when the map points north.
  • FloorFilter - Allows filtering of floor plan data in a geo view by a site, a building in the site, or a floor in the building.

The fastest way to get the toolkit into your app is to reference the compiled library (.aar file) from Jfrog, as described below. For instructions on using the toolkit from source code — for example, if you want to customize it — see Developer setup in the toolkit's repo.

Issues resolved in 200.3

  • Support for intercepting OAuth User Sign In as well as corresponding helper methods (Activity.launchCustomTabs, AuthenticatorState.completeOAuthSignIn) to prompt for OAuth user sign in with Custom Tabs. For more details see the readme.
  • Fix an issue where hitting the X button on OAuth Custom Tab did not complete (cancel) the sign in process.
  • Fix for displaying FloorFilter facility selector when sites are absent in the webmap.

Modular toolkit library

The toolkit has library modules that can be deployed independent of each other in an application. Note that an individual library module can contain one or more composable UI components.

Reference the library from Jfrog

  1. If you haven't already, install and set up ArcGIS Maps SDK for Kotlin.

  2. Ensure the Esri public Jfrog Maven repository is in your project's gradle file, https://esri.jfrog.io/artifactory/arcgis

    Use dark colors for code blocksCopy
    1
    2
    3
    4
    5
    6
    7
    allprojects {
    	repositories {
    		...
    		maven {url 'https://esri.jfrog.io/artifactory/arcgis' }
    		...
    	}
    }
  3. Add the toolkit dependencies to the module's gradle file. Specify only the toolkit components that you will use in your app.

    Use dark colors for code blocksCopy
    1
    2
    3
    4
    dependencies {
        implementation 'com.esri:arcgis-maps-kotlin-toolkit-authentication:200.3.0'
    	implementation 'com.esri:arcgis-maps-kotlin-toolkit-compass:200.3.0'
    }

    Alternatively, you can declare the toolkit's bom (Bill of Materials) subproject and version number as a dependency. The BOM itself specifies versions of the toolkit components that are compatible with each other. You can see which versions these are in the BOM's .pom file at https://esri.jfrog.io/ui/native/arcgis/com/esri/arcgis-maps-kotlin-toolkit-bom/. For more information, see the toolkit repo's top-level README.

    Use dark colors for code blocksCopy
    1
    2
    3
    4
    5
    dependencies {
        implementation 'com.esri:arcgis-maps-kotlin-toolkit-bom:200.3.0'
        implementation 'com.esri:arcgis-maps-kotlin-toolkit-authentication'
    	implementation 'com.esri:arcgis-maps-kotlin-toolkit-compass'
    }

Build from source

Use the following code if you want to customize the toolkit.

Use dark colors for code blocksCopy
1
$ ./gradlew clean assembleDebug --info

See the setup instructions for a more detailed guide.

Requirements

The following table shows version compatibility.

SDK VersionToolkit Version
200.0.0none
200.1.0none
200.2.0200.2.0
200.3.0200.3.0

Issues

Find a bug or want to request a new feature enhancement? Please let us know by submitting an issue.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.