adopt drop in to use new speed info view

Author: abhishek1508

CHANGELOG.md

@@ -27,6 +27,18 @@ Mapbox welcomes participation and contributions from everyone.
           .build()
   }
   ```
+- Added support to use `MapboxSpeedInfoView` as default view to render posted and current speed in Drop-In UI. [#6743](https://github.com/mapbox/mapbox-navigation-android/pull/6743)
+  - Introduced `ViewStyleCustomization.speedInfoOptions` to style the `MapboxSpeedInfoView` using Drop-In UI. [#6743](https://github.com/mapbox/mapbox-navigation-android/pull/6743)
+  - Introduced `ViewBinderCustomization.legacySpeedLimitBinder()` and `ViewBinderCustomization.defaultSpeedInfoBinder` to facilitate the simple use of legacy `MapboxSpeedLimitView` and new `MapboxSpeedInfoView`. [#6743](https://github.com/mapbox/mapbox-navigation-android/pull/6743)
+  - :warning: Deprecated `ViewStyleCustomization.setSpeedLimitStyle` and `ViewStyleCustomization.setSpeedLimitTextAppearance`. [#6743](https://github.com/mapbox/mapbox-navigation-android/pull/6743)
+    To use the legacy speed limit view, add the following code:
+  ```kotlin
+  binding.navigationView.customizeViewBinders {
+      binding.navigationView.customizeViewBinders {
+          speedLimitBinder = legacySpeedLimitBinder()
+      }
+  }
+  ```
 
 ## Mapbox Navigation SDK 2.10.0-rc.1 - 16 December, 2022
 ### Changelog
@@ -35,6 +47,7 @@ Mapbox welcomes participation and contributions from everyone.
 #### Features
 - Introduced `MapboxSpeedInfoApi` and `MapboxSpeedInfoView`. The combination of API and View can be used to render posted and current speed limit at user's current location. [#6687](https://github.com/mapbox/mapbox-navigation-android/pull/6687)
 - :warning: Deprecated `MapboxSpeedLimitApi` and `MapboxSpeedLimitView`. [#6687](https://github.com/mapbox/mapbox-navigation-android/pull/6687)
+
 #### Bug fixes and improvements
 - Fixed approaches list update in `RouteOptionsUpdater`(uses for reroute). It was putting to the origin approach corresponding approach from legacy approach list. [#6540](https://github.com/mapbox/mapbox-navigation-android/pull/6540)
 - Updated the `MapboxRestAreaApi` logic to load a SAPA map only if the upcoming rest stop is at the current step of the route leg. [#6695](https://github.com/mapbox/mapbox-navigation-android/pull/6695)

libnavui-dropin/api/current.txt

@@ -61,7 +61,8 @@ package com.mapbox.navigation.dropin {
   }
 
   public final class ViewBinderCustomization {
-    ctor public ViewBinderCustomization();
+    ctor @Deprecated public ViewBinderCustomization();
+    method public com.mapbox.navigation.ui.base.lifecycle.UIBinder? defaultSpeedInfoBinder();
     method public com.mapbox.navigation.ui.base.lifecycle.UIBinder? getActionButtonsBinder();
     method public com.mapbox.navigation.ui.base.lifecycle.UIBinder? getActionCameraModeButtonBinder();
     method public com.mapbox.navigation.ui.base.lifecycle.UIBinder? getActionCompassButtonBinder();
@@ -88,6 +89,7 @@ package com.mapbox.navigation.dropin {
     method public com.mapbox.navigation.ui.base.lifecycle.UIBinder? getRightFrameBinder();
     method public com.mapbox.navigation.ui.base.lifecycle.UIBinder? getRoadNameBinder();
     method public com.mapbox.navigation.ui.base.lifecycle.UIBinder? getSpeedLimitBinder();
+    method public com.mapbox.navigation.ui.base.lifecycle.UIBinder? legacySpeedLimitBinder();
     method public void setActionButtonsBinder(com.mapbox.navigation.ui.base.lifecycle.UIBinder?);
     method public void setActionCameraModeButtonBinder(com.mapbox.navigation.ui.base.lifecycle.UIBinder?);
     method public void setActionCompassButtonBinder(com.mapbox.navigation.ui.base.lifecycle.UIBinder?);
@@ -253,8 +255,9 @@ package com.mapbox.navigation.dropin {
     method public Integer? getRoadNameBackground();
     method public Integer? getRoadNameTextAppearance();
     method public Integer? getRoutePreviewButtonStyle();
-    method public Integer? getSpeedLimitStyle();
-    method public Integer? getSpeedLimitTextAppearance();
+    method public com.mapbox.navigation.ui.speedlimit.model.MapboxSpeedInfoOptions? getSpeedInfoOptions();
+    method @Deprecated public Integer? getSpeedLimitStyle();
+    method @Deprecated public Integer? getSpeedLimitTextAppearance();
     method public Integer? getStartNavigationButtonStyle();
     method public Integer? getTripProgressStyle();
     method public void setArrivalTextAppearance(Integer?);
@@ -274,8 +277,9 @@ package com.mapbox.navigation.dropin {
     method public void setRoadNameBackground(Integer?);
     method public void setRoadNameTextAppearance(Integer?);
     method public void setRoutePreviewButtonStyle(Integer?);
-    method public void setSpeedLimitStyle(Integer?);
-    method public void setSpeedLimitTextAppearance(Integer?);
+    method public void setSpeedInfoOptions(com.mapbox.navigation.ui.speedlimit.model.MapboxSpeedInfoOptions?);
+    method @Deprecated public void setSpeedLimitStyle(Integer?);
+    method @Deprecated public void setSpeedLimitTextAppearance(Integer?);
     method public void setStartNavigationButtonStyle(Integer?);
     method public void setTripProgressStyle(Integer?);
     property public final Integer? arrivalTextAppearance;
@@ -295,8 +299,9 @@ package com.mapbox.navigation.dropin {
     property public final Integer? roadNameBackground;
     property public final Integer? roadNameTextAppearance;
     property public final Integer? routePreviewButtonStyle;
-    property public final Integer? speedLimitStyle;
-    property public final Integer? speedLimitTextAppearance;
+    property public final com.mapbox.navigation.ui.speedlimit.model.MapboxSpeedInfoOptions? speedInfoOptions;
+    property @Deprecated public final Integer? speedLimitStyle;
+    property @Deprecated public final Integer? speedLimitTextAppearance;
     property public final Integer? startNavigationButtonStyle;
     property public final Integer? tripProgressStyle;
     field public static final com.mapbox.navigation.dropin.ViewStyleCustomization.Companion Companion;
@@ -320,8 +325,9 @@ package com.mapbox.navigation.dropin {
     method @DrawableRes public int defaultRoadNameBackground();
     method @StyleRes public int defaultRoadNameTextAppearance();
     method @StyleRes public int defaultRoutePreviewButtonStyle();
-    method @StyleRes public int defaultSpeedLimitStyle();
-    method @StyleRes public int defaultSpeedLimitTextAppearance();
+    method public com.mapbox.navigation.ui.speedlimit.model.MapboxSpeedInfoOptions defaultSpeedInfoOptions();
+    method @Deprecated @StyleRes public int defaultSpeedLimitStyle();
+    method @Deprecated @StyleRes public int defaultSpeedLimitTextAppearance();
     method @StyleRes public int defaultStartNavigationButtonStyle();
     method @StyleRes public int defaultTripProgressStyle();
   }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/ViewBinderCustomization.kt

@@ -5,14 +5,27 @@ import com.mapbox.navigation.dropin.actionbutton.ActionButtonDescription
 import com.mapbox.navigation.dropin.actionbutton.ActionButtonsBinder
 import com.mapbox.navigation.dropin.infopanel.InfoPanelBinder
 import com.mapbox.navigation.dropin.map.MapViewBinder
+import com.mapbox.navigation.dropin.navigationview.NavigationViewContext
+import com.mapbox.navigation.dropin.speedlimit.SpeedInfoViewBinder
+import com.mapbox.navigation.dropin.speedlimit.SpeedLimitViewBinder
 import com.mapbox.navigation.ui.base.lifecycle.UIBinder
+import com.mapbox.navigation.utils.internal.ifNonNull
 
 /**
  * A class that allows you to define [UIBinder] for various different views used by the
  * [NavigationView]. If not specified, [NavigationView] uses the default [UIBinder] defined for
  * each of these views.
  */
-class ViewBinderCustomization {
+class ViewBinderCustomization internal constructor(private val navContext: NavigationViewContext?) {
+
+    /**
+     * constructor
+     */
+    @Deprecated(
+        message = "The constructor, if used, would return null when legacySpeedLimitBinder() and " +
+            "defaultSpeedLimitBinder() are invoked"
+    )
+    constructor() : this(null)
 
     /**
      * Customize the speed limit view by providing your own [UIBinder].
@@ -181,4 +194,24 @@ class ViewBinderCustomization {
      * Use [MapViewBinder.defaultBinder] to reset to default.
      */
     var mapViewBinder: MapViewBinder? = null
+
+    /**
+     * Invoke the function to use the legacy speed limit binder.
+     * @return UIBinder
+     */
+    fun legacySpeedLimitBinder(): UIBinder? {
+        return ifNonNull(navContext) {
+            SpeedLimitViewBinder(it)
+        }
+    }
+
+    /**
+     * Invoke the function to use the default speed limit binder.
+     * @return UIBinder
+     */
+    fun defaultSpeedInfoBinder(): UIBinder? {
+        return ifNonNull(navContext) {
+            SpeedInfoViewBinder(it)
+        }
+    }
 }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/ViewStyleCustomization.kt

@@ -27,6 +27,8 @@ import com.mapbox.navigation.ui.maneuver.view.MapboxManeuverView
 import com.mapbox.navigation.ui.maps.puck.LocationPuckOptions
 import com.mapbox.navigation.ui.maps.roadname.view.MapboxRoadNameView
 import com.mapbox.navigation.ui.maps.view.MapboxCameraModeButton
+import com.mapbox.navigation.ui.speedlimit.model.MapboxSpeedInfoOptions
+import com.mapbox.navigation.ui.speedlimit.view.MapboxSpeedInfoView
 import com.mapbox.navigation.ui.speedlimit.view.MapboxSpeedLimitView
 import com.mapbox.navigation.ui.tripprogress.view.MapboxTripProgressView
 import com.mapbox.navigation.ui.voice.view.MapboxAudioGuidanceButton
@@ -101,18 +103,10 @@ class ViewStyleCustomization {
     var tripProgressStyle: Int? = null
 
     /**
-     * Provide custom [MapboxSpeedLimitView] style.
-     * Use [defaultSpeedLimitStyle] to reset to default.
-     */
-    @StyleRes
-    var speedLimitStyle: Int? = null
-
-    /**
-     * Provide custom [MapboxSpeedLimitView] [TextAppearance].
-     * Use [defaultSpeedLimitTextAppearance] to reset to default.
+     * Provide options to style [MapboxSpeedInfoView] MUTCD and VIENNA configuration .
+     * Use [defaultSpeedInfoOptions] to reset to default.
      */
-    @StyleRes
-    var speedLimitTextAppearance: Int? = null
+    var speedInfoOptions: MapboxSpeedInfoOptions? = null
 
     /**
      * Provide custom [MapboxRoadNameView] [TextAppearance].
@@ -191,6 +185,28 @@ class ViewStyleCustomization {
      */
     var locationPuckOptions: LocationPuckOptions? = null
 
+    /**
+     * Provide custom [MapboxSpeedLimitView] style.
+     * Use [defaultSpeedLimitStyle] to reset to default.
+     */
+    @StyleRes
+    @Deprecated(
+        message = "The parent MapboxSpeedLimitView is deprecated",
+        replaceWith = ReplaceWith("speedInfoOptions")
+    )
+    var speedLimitStyle: Int? = null
+
+    /**
+     * Provide custom [MapboxSpeedLimitView] [TextAppearance].
+     * Use [defaultSpeedLimitTextAppearance] to reset to default.
+     */
+    @StyleRes
+    @Deprecated(
+        message = "The parent MapboxSpeedLimitView is deprecated",
+        replaceWith = ReplaceWith("speedInfoOptions")
+    )
+    var speedLimitTextAppearance: Int? = null
+
     companion object {
         /**
          * Default info panel peek height in pixels.
@@ -255,18 +271,6 @@ class ViewStyleCustomization {
         @StyleRes
         fun defaultTripProgressStyle(): Int = R.style.DropInStyleTripProgressView
 
-        /**
-         * Default [MapboxSpeedLimitView] style.
-         */
-        @StyleRes
-        fun defaultSpeedLimitStyle(): Int = R.style.DropInStyleSpeedLimit
-
-        /**
-         * Default [MapboxSpeedLimitView] [TextAppearance].
-         */
-        @StyleRes
-        fun defaultSpeedLimitTextAppearance(): Int = R.style.DropInSpeedLimitTextAppearance
-
         /**
          * Default [MapboxRoadNameView] [TextAppearance].
          */
@@ -382,6 +386,32 @@ class ViewStyleCustomization {
         fun defaultLocationPuckOptions(context: Context): LocationPuckOptions =
             LocationPuckOptions.Builder(context).build()
 
+        /**
+         * Default [MapboxSpeedInfoOptions]
+         */
+        fun defaultSpeedInfoOptions(): MapboxSpeedInfoOptions =
+            MapboxSpeedInfoOptions.Builder().build()
+
+        /**
+         * Default [MapboxSpeedLimitView] style.
+         */
+        @Deprecated(
+            message = "The parent MapboxSpeedLimitView is deprecated",
+            replaceWith = ReplaceWith("speedInfoOptions")
+        )
+        @StyleRes
+        fun defaultSpeedLimitStyle(): Int = R.style.DropInStyleSpeedLimit
+
+        /**
+         * Default [MapboxSpeedLimitView] [TextAppearance].
+         */
+        @Deprecated(
+            message = "The parent MapboxSpeedLimitView is deprecated",
+            replaceWith = ReplaceWith("speedInfoOptions")
+        )
+        @StyleRes
+        fun defaultSpeedLimitTextAppearance(): Int = R.style.DropInSpeedLimitTextAppearance
+
         private fun defaultMutcdProperties() = MapboxExitProperties.PropertiesMutcd(
             exitBackground = R.drawable.mapbox_dropin_exit_board_background,
             fallbackDrawable = R.drawable.mapbox_dropin_ic_exit_arrow_right_mutcd,

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/navigationview/NavigationViewContext.kt

@@ -68,7 +68,7 @@ internal class NavigationViewContext(
     )
 
     fun applyBinderCustomization(action: ViewBinderCustomization.() -> Unit) {
-        val customization = ViewBinderCustomization().apply(action)
+        val customization = ViewBinderCustomization(this).apply(action)
         uiBinders.applyCustomization(customization)
     }
 

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/navigationview/NavigationViewStyles.kt

@@ -5,6 +5,7 @@ import com.mapbox.maps.plugin.annotation.generated.PointAnnotationOptions
 import com.mapbox.navigation.dropin.ViewStyleCustomization
 import com.mapbox.navigation.ui.maneuver.model.ManeuverViewOptions
 import com.mapbox.navigation.ui.maps.puck.LocationPuckOptions
+import com.mapbox.navigation.ui.speedlimit.model.MapboxSpeedInfoOptions
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.asStateFlow
@@ -41,10 +42,8 @@ internal class NavigationViewStyles(context: Context) {
     private var _startNavigationButtonStyle: MutableStateFlow<Int> =
         MutableStateFlow(ViewStyleCustomization.defaultStartNavigationButtonStyle())
 
-    private val _speedLimitStyle: MutableStateFlow<Int> =
-        MutableStateFlow(ViewStyleCustomization.defaultSpeedLimitStyle())
-    private val _speedLimitTextAppearance: MutableStateFlow<Int> =
-        MutableStateFlow(ViewStyleCustomization.defaultSpeedLimitTextAppearance())
+    private val _speedInfoOptions: MutableStateFlow<MapboxSpeedInfoOptions> =
+        MutableStateFlow(ViewStyleCustomization.defaultSpeedInfoOptions())
     private val _roadNameBackground: MutableStateFlow<Int> =
         MutableStateFlow(ViewStyleCustomization.defaultRoadNameBackground())
     private val _roadNameTextAppearance: MutableStateFlow<Int> =
@@ -58,6 +57,14 @@ internal class NavigationViewStyles(context: Context) {
     private val _locationPuckOptions: MutableStateFlow<LocationPuckOptions> =
         MutableStateFlow(ViewStyleCustomization.defaultLocationPuckOptions(context))
 
+    @Deprecated(message = "The parent MapboxSpeedLimitView is deprecated")
+    private val _speedLimitStyle: MutableStateFlow<Int> =
+        MutableStateFlow(ViewStyleCustomization.defaultSpeedLimitStyle())
+
+    @Deprecated(message = "The parent MapboxSpeedLimitView is deprecated")
+    private val _speedLimitTextAppearance: MutableStateFlow<Int> =
+        MutableStateFlow(ViewStyleCustomization.defaultSpeedLimitTextAppearance())
+
     val infoPanelPeekHeight: StateFlow<Int> = _infoPanelPeekHeight.asStateFlow()
     val infoPanelMarginStart: StateFlow<Int> = _infoPanelMarginStart.asStateFlow()
     val infoPanelMarginEnd: StateFlow<Int> = _infoPanelMarginEnd.asStateFlow()
@@ -75,8 +82,7 @@ internal class NavigationViewStyles(context: Context) {
     val endNavigationButtonStyle: StateFlow<Int> = _endNavigationButtonStyle.asStateFlow()
     val startNavigationButtonStyle: StateFlow<Int> = _startNavigationButtonStyle.asStateFlow()
 
-    val speedLimitStyle: StateFlow<Int> = _speedLimitStyle.asStateFlow()
-    val speedLimitTextAppearance: StateFlow<Int> = _speedLimitTextAppearance.asStateFlow()
+    val speedInfoOptions: StateFlow<MapboxSpeedInfoOptions> = _speedInfoOptions.asStateFlow()
     val destinationMarkerAnnotationOptions: StateFlow<PointAnnotationOptions> =
         _destinationMarkerAnnotationOptions.asStateFlow()
     val roadNameBackground: StateFlow<Int> = _roadNameBackground.asStateFlow()
@@ -85,6 +91,18 @@ internal class NavigationViewStyles(context: Context) {
     val arrivalTextAppearance: StateFlow<Int> = _arrivalTextAppearance.asStateFlow()
     val locationPuckOptions: StateFlow<LocationPuckOptions> = _locationPuckOptions.asStateFlow()
 
+    @Deprecated(
+        message = "The parent MapboxSpeedLimitView is deprecated",
+        replaceWith = ReplaceWith("speedInfoStyle")
+    )
+    val speedLimitStyle: StateFlow<Int> = _speedLimitStyle.asStateFlow()
+
+    @Deprecated(
+        message = "The parent MapboxSpeedLimitView is deprecated",
+        replaceWith = ReplaceWith("speedInfoStyle")
+    )
+    val speedLimitTextAppearance: StateFlow<Int> = _speedLimitTextAppearance.asStateFlow()
+
     fun applyCustomization(customization: ViewStyleCustomization) {
         customization.infoPanelPeekHeight?.also { _infoPanelPeekHeight.value = it }
         customization.infoPanelMarginStart?.also { _infoPanelMarginStart.value = it }
@@ -104,15 +122,17 @@ internal class NavigationViewStyles(context: Context) {
         customization.endNavigationButtonStyle?.also { _endNavigationButtonStyle.value = it }
         customization.startNavigationButtonStyle?.also { _startNavigationButtonStyle.value = it }
 
-        customization.speedLimitStyle?.also { _speedLimitStyle.value = it }
+        customization.speedInfoOptions?.also { _speedInfoOptions.value = it }
         customization.maneuverViewOptions?.also { _maneuverViewOptions.value = it }
-        customization.speedLimitTextAppearance?.also { _speedLimitTextAppearance.value = it }
         customization.destinationMarkerAnnotationOptions?.also {
             _destinationMarkerAnnotationOptions.value = it
         }
         customization.roadNameBackground?.also { _roadNameBackground.value = it }
         customization.roadNameTextAppearance?.also { _roadNameTextAppearance.value = it }
         customization.arrivalTextAppearance?.also { _arrivalTextAppearance.value = it }
         customization.locationPuckOptions?.also { _locationPuckOptions.value = it }
+
+        customization.speedLimitStyle?.also { _speedLimitStyle.value = it }
+        customization.speedLimitTextAppearance?.also { _speedLimitTextAppearance.value = it }
     }
 }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/speedlimit/SpeedInfoViewBinder.kt

@@ -0,0 +1,38 @@
+package com.mapbox.navigation.dropin.speedlimit
+
+import android.view.ViewGroup
+import androidx.transition.Fade
+import androidx.transition.Scene
+import androidx.transition.TransitionManager
+import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
+import com.mapbox.navigation.dropin.R
+import com.mapbox.navigation.dropin.databinding.MapboxSpeedInfoLayoutBinding
+import com.mapbox.navigation.dropin.internal.extensions.reloadOnChange
+import com.mapbox.navigation.dropin.navigationview.NavigationViewContext
+import com.mapbox.navigation.ui.base.lifecycle.UIBinder
+import com.mapbox.navigation.ui.speedlimit.internal.SpeedInfoComponent
+
+internal class SpeedInfoViewBinder(
+    val context: NavigationViewContext
+) : UIBinder {
+    override fun bind(viewGroup: ViewGroup): MapboxNavigationObserver {
+        val scene = Scene.getSceneForLayout(
+            viewGroup,
+            R.layout.mapbox_speed_info_layout,
+            viewGroup.context
+        )
+        TransitionManager.go(scene, Fade())
+        val binding = MapboxSpeedInfoLayoutBinding.bind(viewGroup)
+
+        return reloadOnChange(
+            context.styles.speedInfoOptions,
+            context.options.distanceFormatterOptions,
+        ) { options, distanceFormatter ->
+            SpeedInfoComponent(
+                speedInfoOptions = options,
+                speedInfoView = binding.speedInfoView,
+                distanceFormatterOptions = distanceFormatter,
+            )
+        }
+    }
+}