feat: Deprecate rememberMarkerState function.

googlemaps · Dec 14, 2024 · 17f3857 · 17f3857
1 parent 356d429
commit 17f3857
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/maps-compose/src/main/java/com/google/maps/android/compose/Marker.kt b/maps-compose/src/main/java/com/google/maps/android/compose/Marker.kt
@@ -188,6 +188,18 @@ public class MarkerState private constructor(position: LatLng) {
  * If you need this implementation, use 'rememberUpdatedMarkerState'.
  */
 @Composable
+@Deprecated(
+    message = "Use 'rememberUpdatedMarkerState' instead - It may be confusing to think " +
+            "that the state is automatically updated as the position changes, " +
+            "so it will be changed or removed.",
+    replaceWith = ReplaceWith(
+        expression = """
+            val markerState = rememberSaveable(key = key, saver = MarkerState.Saver) {
+                MarkerState(position)
+            }
+        """
+    )
+)
 public fun rememberMarkerState(
     key: String? = null,
     position: LatLng = LatLng(0.0, 0.0)