Merge branch 'wescpy' of https://github.com/googlemaps/android-maps-compose into wescpy

Author: wescpy

.github/workflows/docs.yml

@@ -60,7 +60,9 @@ jobs:
         commit-message: 'docs: Update docs'
         author: googlemaps-bot <[email protected]>
         committer: googlemaps-bot <[email protected]>
-        labels: docs
+        labels: |
+          docs
+          automerge
         title: 'docs: Update docs'
         body: |
             Updated GitHub pages with latest from `./gradlew dokkaHtml`.

.github/workflows/test.yml

@@ -1,4 +1,4 @@
-# Copyright 2020 Google LLC
+# Copyright 2024 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -45,3 +45,13 @@ jobs:
 
     - name: Build modules
       run: ./gradlew build jacocoTestReport --stacktrace
+
+    - name: Run Screenshot Tests
+      run: ./gradlew validateDebugScreenshotTest
+
+    - name: Upload build reports
+      uses: actions/upload-artifact@v4
+      if: always()
+      with:
+        name: my-artifact
+        path: app/build/reports

.gitignore

@@ -1,6 +1,7 @@
 *.iml
 .idea
 .gradle
+.kotlin
 /local.properties
 /.idea/caches
 /.idea/libraries

README.md

@@ -29,14 +29,14 @@ You no longer need to specify the Maps SDK for Android or its Utility Library as
 
 ```groovy
 dependencies {
-    implementation 'com.google.maps.android:maps-compose:6.2.1'
+    implementation 'com.google.maps.android:maps-compose:6.4.0'
 
     // Optionally, you can include the Compose utils library for Clustering,
     // Street View metadata checks, etc.
-    implementation 'com.google.maps.android:maps-compose-utils:6.2.1'
+    implementation 'com.google.maps.android:maps-compose-utils:6.4.0'
 
     // Optionally, you can include the widgets library for ScaleBar, etc.
-    implementation 'com.google.maps.android:maps-compose-widgets:6.2.1'
+    implementation 'com.google.maps.android:maps-compose-widgets:6.4.0'
 }
 ```
 

app/build.gradle.kts

@@ -3,6 +3,7 @@ plugins {
     id("kotlin-android")
     id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
     alias(libs.plugins.compose.compiler)
+    alias(libs.plugins.screenshot)
 }
 
 android {
@@ -46,6 +47,14 @@ android {
         jvmTarget = "1.8"
         freeCompilerArgs += "-Xopt-in=kotlin.RequiresOptIn"
     }
+
+    experimentalProperties["android.experimental.enableScreenshotTest"] = true
+
+    testOptions {
+        screenshotTests {
+            imageDifferenceThreshold = 0.035f // 3.5%
+        }
+    }
 }
 
 dependencies {
@@ -68,6 +77,8 @@ dependencies {
     androidTestImplementation(libs.androidx.test.compose.ui)
     androidTestImplementation(libs.kotlinx.coroutines.test)
 
+    screenshotTestImplementation(libs.androidx.compose.ui.tooling)
+
     // Instead of the lines below, regular apps would load these libraries from Maven according to
     // the README installation instructions
     implementation(project(":maps-compose"))

app/src/debug/screenshotTest/reference/com/google/maps/android/compose/ScaleBarTest/PreviewDisappearingScaleBar_0.png

@@ -31,13 +31,18 @@ import androidx.compose.foundation.layout.systemBarsPadding
 import androidx.compose.foundation.layout.wrapContentSize
 import androidx.compose.material.CircularProgressIndicator
 import androidx.compose.material.MaterialTheme
+import androidx.compose.runtime.Composable
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateOf
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.setValue
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
+import androidx.compose.ui.tooling.preview.Preview
 import androidx.compose.ui.unit.dp
+import com.google.android.gms.maps.model.CameraPosition
+import com.google.android.gms.maps.model.LatLng
+import com.google.maps.android.compose.theme.MapsComposeSampleTheme
 import com.google.maps.android.compose.widgets.DarkGray
 import com.google.maps.android.compose.widgets.DisappearingScaleBar
 import com.google.maps.android.compose.widgets.ScaleBar
@@ -126,4 +131,26 @@ class ScaleBarActivity : ComponentActivity() {
             }
         }
     }
+}
+
+@Preview
+@Composable
+fun PreviewScaleBar() {
+    val cameraPositionState = remember {
+        CameraPositionState(
+            position = CameraPosition(
+                LatLng(48.137154, 11.576124), // Example coordinates: Munich, Germany
+                12f,
+                0f,
+                0f
+            )
+        )
+    }
+
+    MapsComposeSampleTheme {
+        ScaleBar(
+            modifier = Modifier.padding(end = 4.dp),
+            cameraPositionState = cameraPositionState
+        )
+    }
 }

app/src/debug/screenshotTest/reference/com/google/maps/android/compose/ScaleBarTest/PreviewScaleBar_0.png

@@ -42,6 +42,7 @@ import com.google.android.gms.maps.model.CameraPosition
 import com.google.android.gms.maps.model.LatLng
 import com.google.maps.android.clustering.ClusterItem
 import com.google.maps.android.clustering.algo.NonHierarchicalViewBasedAlgorithm
+import com.google.maps.android.clustering.view.DefaultClusterRenderer
 import com.google.maps.android.compose.GoogleMap
 import com.google.maps.android.compose.MapsComposeExperimentalApi
 import com.google.maps.android.compose.MarkerInfoWindow
@@ -181,7 +182,11 @@ private fun CustomUiClustering(items: List<MyItem>) {
             )
         },
         // Optional: Custom rendering for non-clustered items
-        clusterItemContent = null
+        clusterItemContent = null,
+        // Optional: Customization hook for clusterManager and renderer when they're ready
+        onClusterManager = { clusterManager ->
+            (clusterManager.renderer as DefaultClusterRenderer).minClusterSize = 2
+        },
     )
 }
 
@@ -218,6 +223,7 @@ fun CustomRendererClustering(items: List<MyItem>) {
         },
         clusterManager = clusterManager,
     )
+
     SideEffect {
         clusterManager ?: return@SideEffect
         clusterManager.setOnClusterClickListener {

app/src/main/java/com/google/maps/android/compose/ScaleBarActivity.kt

@@ -0,0 +1,60 @@
+package com.google.maps.android.compose
+
+import androidx.compose.foundation.layout.padding
+import androidx.compose.runtime.Composable
+import androidx.compose.runtime.remember
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.unit.dp
+import com.google.android.gms.maps.model.CameraPosition
+import com.google.android.gms.maps.model.LatLng
+import com.google.maps.android.compose.theme.MapsComposeSampleTheme
+import com.google.maps.android.compose.widgets.DisappearingScaleBar
+import com.google.maps.android.compose.widgets.ScaleBar
+
+
+class ScaleBarTest() {
+    @Preview
+    @Composable
+    fun PreviewScaleBar() {
+        val cameraPositionState = remember {
+            CameraPositionState(
+                position = CameraPosition(
+                    LatLng(48.137154, 11.576124), // Example coordinates: Munich, Germany
+                    12f,
+                    0f,
+                    0f
+                )
+            )
+        }
+
+        MapsComposeSampleTheme {
+            ScaleBar(
+                modifier = Modifier.padding(end = 4.dp),
+                cameraPositionState = cameraPositionState
+            )
+        }
+    }
+
+    @Preview
+    @Composable
+    fun PreviewDisappearingScaleBar() {
+        val cameraPositionState = remember {
+            CameraPositionState(
+                position = CameraPosition(
+                    LatLng(48.137154, 11.576124), // Example coordinates: Munich, Germany
+                    12f,
+                    0f,
+                    0f
+                )
+            )
+        }
+
+        MapsComposeSampleTheme {
+            DisappearingScaleBar(
+                modifier = Modifier.padding(end = 4.dp),
+                cameraPositionState = cameraPositionState
+            )
+        }
+    }
+}