introduce showMapScalebar to control its visibility (#6523)

Author: abhishek1508

CHANGELOG.md

@@ -18,6 +18,8 @@ Mapbox welcomes participation and contributions from everyone.
   - `ViewOptionsCustomization.showStartNavigationButton` can be used to show/hide info panel's start navigation button. The default is `true`. [#6506](https://github.com/mapbox/mapbox-navigation-android/pull/6506)
   - `ViewOptionsCustomization.showEndNavigationButton` can be used to show/hide info panel's end navigation button. The default is `true`. [#6506](https://github.com/mapbox/mapbox-navigation-android/pull/6506)
 #### Bug fixes and improvements
+- :warning: Removed `MapboxMapScalebarParams` and replaced `ViewStyleCustomization.mapScalebarParams` by `ViewOptionsCustomization.showMapScalebar` [#6523](https://github.com/mapbox/mapbox-navigation-android/pull/6523)
+- Refactored `ScalebarComponent` to use `ViewOptionsCustomization.distanceFormatterOptions` to change between imperial and metric based unit. [#6523](https://github.com/mapbox/mapbox-navigation-android/pull/6523)
 - :warning: Updated `NavigationView` buttons customization to allow styling via XML styles: [#6498](https://github.com/mapbox/mapbox-navigation-android/pull/6498)
   - `ViewStyleCustomization.compassButtonParams` option has been replaced by `ViewStyleCustomization.compassButtonStyle`. The default style can be accessed via `ViewStyleCustomization.defaultCompassButtonStyle()` [#6498](https://github.com/mapbox/mapbox-navigation-android/pull/6498)
   - `ViewStyleCustomization.cameraModeButtonParams` option has been replaced by `ViewStyleCustomization.cameraModeButtonStyle`. The default style can be accessed via `ViewStyleCustomization.defaultCameraModeButtonStyle()` [#6498](https://github.com/mapbox/mapbox-navigation-android/pull/6498)

libnavui-dropin/api/current.txt

@@ -152,6 +152,7 @@ package com.mapbox.navigation.dropin {
     method public Boolean? getShowEndNavigationButton();
     method public Boolean? getShowInfoPanelInFreeDrive();
     method public Boolean? getShowManeuver();
+    method public Boolean? getShowMapScalebar();
     method public Boolean? getShowRecenterActionButton();
     method public Boolean? getShowRoadName();
     method public Boolean? getShowRoutePreviewButton();
@@ -175,6 +176,7 @@ package com.mapbox.navigation.dropin {
     method public void setShowEndNavigationButton(Boolean?);
     method public void setShowInfoPanelInFreeDrive(Boolean?);
     method public void setShowManeuver(Boolean?);
+    method public void setShowMapScalebar(Boolean?);
     method public void setShowRecenterActionButton(Boolean?);
     method public void setShowRoadName(Boolean?);
     method public void setShowRoutePreviewButton(Boolean?);
@@ -197,6 +199,7 @@ package com.mapbox.navigation.dropin {
     property public final Boolean? showEndNavigationButton;
     property public final Boolean? showInfoPanelInFreeDrive;
     property public final Boolean? showManeuver;
+    property public final Boolean? showMapScalebar;
     property public final Boolean? showRecenterActionButton;
     property public final Boolean? showRoadName;
     property public final Boolean? showRoutePreviewButton;
@@ -226,7 +229,6 @@ package com.mapbox.navigation.dropin {
     method public Integer? getInfoPanelPeekHeight();
     method public com.mapbox.maps.plugin.LocationPuck? getLocationPuck();
     method public com.mapbox.navigation.ui.maneuver.model.ManeuverViewOptions? getManeuverViewOptions();
-    method public com.mapbox.navigation.dropin.map.scalebar.MapboxMapScalebarParams? getMapScalebarParams();
     method public Integer? getPoiNameTextAppearance();
     method public Integer? getRecenterButtonStyle();
     method public Integer? getRoadNameBackground();
@@ -248,7 +250,6 @@ package com.mapbox.navigation.dropin {
     method public void setInfoPanelPeekHeight(Integer?);
     method public void setLocationPuck(com.mapbox.maps.plugin.LocationPuck?);
     method public void setManeuverViewOptions(com.mapbox.navigation.ui.maneuver.model.ManeuverViewOptions?);
-    method public void setMapScalebarParams(com.mapbox.navigation.dropin.map.scalebar.MapboxMapScalebarParams?);
     method public void setPoiNameTextAppearance(Integer?);
     method public void setRecenterButtonStyle(Integer?);
     method public void setRoadNameBackground(Integer?);
@@ -270,7 +271,6 @@ package com.mapbox.navigation.dropin {
     property public final Integer? infoPanelPeekHeight;
     property public final com.mapbox.maps.plugin.LocationPuck? locationPuck;
     property public final com.mapbox.navigation.ui.maneuver.model.ManeuverViewOptions? maneuverViewOptions;
-    property public final com.mapbox.navigation.dropin.map.scalebar.MapboxMapScalebarParams? mapScalebarParams;
     property public final Integer? poiNameTextAppearance;
     property public final Integer? recenterButtonStyle;
     property public final Integer? roadNameBackground;
@@ -296,7 +296,6 @@ package com.mapbox.navigation.dropin {
     method @Px public int defaultInfoPanelPeekHeight(android.content.Context context);
     method public com.mapbox.maps.plugin.LocationPuck defaultLocationPuck(android.content.Context context);
     method public com.mapbox.navigation.ui.maneuver.model.ManeuverViewOptions defaultManeuverViewOptions();
-    method public com.mapbox.navigation.dropin.map.scalebar.MapboxMapScalebarParams defaultMapScalebarParams(android.content.Context context);
     method @StyleRes public int defaultPoiNameTextAppearance();
     method @StyleRes public int defaultRecenterButtonStyle();
     method @DrawableRes public int defaultRoadNameBackground();

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

@@ -139,6 +139,12 @@ class ViewOptionsCustomization {
      */
     var showTripProgress: Boolean? = null
 
+    /**
+     * Sets whether the map scalebar should be visible.
+     * Set to `false` for the default behavior.
+     */
+    var showMapScalebar: Boolean? = null
+
     /**
      * Sets whether the route preview button should be visible.
      * Set to `true` for the default behavior.

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

@@ -15,7 +15,6 @@ import com.mapbox.maps.plugin.annotation.generated.PointAnnotationOptions
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.dropin.arrival.ArrivalTextComponent
 import com.mapbox.navigation.dropin.map.geocoding.POINameComponent
-import com.mapbox.navigation.dropin.map.scalebar.MapboxMapScalebarParams
 import com.mapbox.navigation.ui.base.view.MapboxExtendableButton
 import com.mapbox.navigation.ui.maneuver.model.ManeuverExitOptions
 import com.mapbox.navigation.ui.maneuver.model.ManeuverPrimaryOptions
@@ -181,16 +180,6 @@ class ViewStyleCustomization {
      */
     var locationPuck: LocationPuck? = null
 
-    /**
-     * Map scalebar params.
-     * Use [defaultMapScalebarParams] to reset to default.
-     * NOTE: When `enabled`, the `scalebar` will always be added to the top start corner
-     * of the screen. Position of the `scalebar` using `NavigationView` cannot be changed at any
-     * given time. However, if you change the position using `MapView`, the behavior is undefined
-     * and you will be responsible to ensure the correct positioning based on other view overlays.
-     */
-    var mapScalebarParams: MapboxMapScalebarParams? = null
-
     companion object {
         /**
          * Default info panel peek height in pixels.
@@ -380,12 +369,6 @@ class ViewStyleCustomization {
             )
         )
 
-        /**
-         * Default map scalebar parameters.
-         */
-        fun defaultMapScalebarParams(context: Context): MapboxMapScalebarParams =
-            MapboxMapScalebarParams.Builder(context).build()
-
         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/map/MapViewBinder.kt

@@ -102,8 +102,9 @@ abstract class MapViewBinder : UIBinder {
             },
             ScalebarComponent(
                 mapView,
-                context.styles.mapScalebarParams,
-                context.systemBarsInsets
+                context.options.showMapScalebar,
+                context.systemBarsInsets,
+                context.options.distanceFormatterOptions,
             )
         )
     }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/map/scalebar/ScalebarComponent.kt

@@ -5,23 +5,30 @@ import androidx.core.graphics.Insets
 import com.mapbox.maps.MapView
 import com.mapbox.maps.plugin.scalebar.scalebar
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
+import com.mapbox.navigation.base.formatter.DistanceFormatterOptions
+import com.mapbox.navigation.base.formatter.UnitType
 import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.ui.base.lifecycle.UIComponent
 import kotlinx.coroutines.flow.StateFlow
 
 @ExperimentalPreviewMapboxNavigationAPI
 internal class ScalebarComponent(
     private val mapView: MapView,
-    private val scalebarParams: StateFlow<MapboxMapScalebarParams>,
+    private val isEnabled: StateFlow<Boolean>,
     private val systemBarInsets: StateFlow<Insets>,
+    private val options: StateFlow<DistanceFormatterOptions>,
 ) : UIComponent() {
 
     private val defaultMarginTop = 4f
     private val defaultMarginLeft = 4f
 
     init {
-        setUpScalebar(scalebarParams.value)
         mapView.scalebar.updateSettings {
+            enabled = isEnabled.value
+            isMetricUnits = when (options.value.unitType) {
+                UnitType.METRIC -> true
+                UnitType.IMPERIAL -> false
+            }
             position = Gravity.TOP or Gravity.START
             // temporary workaround, remove after MAPSMBL-173
             textBorderWidth = 3f
@@ -30,19 +37,27 @@ internal class ScalebarComponent(
 
     override fun onAttached(mapboxNavigation: MapboxNavigation) {
         super.onAttached(mapboxNavigation)
-        scalebarParams.observe { setUpScalebar(it) }
+
+        options.observe { formatter ->
+            mapView.scalebar.updateSettings {
+                isMetricUnits = when (formatter.unitType) {
+                    UnitType.METRIC -> true
+                    UnitType.IMPERIAL -> false
+                }
+            }
+        }
+
+        isEnabled.observe { enabled ->
+            mapView.scalebar.updateSettings {
+                this.enabled = enabled
+            }
+        }
+
         systemBarInsets.observe { insets ->
             mapView.scalebar.updateSettings {
                 marginTop = defaultMarginTop + insets.top
                 marginLeft = defaultMarginLeft + insets.left
             }
         }
     }
-
-    private fun setUpScalebar(params: MapboxMapScalebarParams) {
-        mapView.scalebar.updateSettings {
-            enabled = params.enabled
-            isMetricUnits = params.isMetricUnits
-        }
-    }
 }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/map/scalebar/ScalebarPlaceholderBinder.kt

@@ -18,7 +18,7 @@ internal class ScalebarPlaceholderBinder(
         val binding = inflateLayout(viewGroup)
         return ScalebarPlaceholderComponent(
             binding.scalebarPlaceholder,
-            context.styles.mapScalebarParams,
+            context.options.showMapScalebar,
             context.maneuverBehavior.maneuverViewVisibility
         )
     }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/map/scalebar/ScalebarPlaceholderComponent.kt

@@ -12,16 +12,16 @@ import kotlinx.coroutines.launch
 @ExperimentalPreviewMapboxNavigationAPI
 internal class ScalebarPlaceholderComponent(
     private val scalebarPlaceholder: View,
-    private val scalebarParams: StateFlow<MapboxMapScalebarParams>,
+    private val isEnabled: StateFlow<Boolean>,
     private val maneuverViewVisible: StateFlow<Boolean>,
 ) : UIComponent() {
 
     override fun onAttached(mapboxNavigation: MapboxNavigation) {
         super.onAttached(mapboxNavigation)
         coroutineScope.launch {
-            combine(scalebarParams, maneuverViewVisible) { params, maneuverViewVisible ->
+            combine(isEnabled, maneuverViewVisible) { enabled, maneuverViewVisible ->
                 scalebarPlaceholder.visibility =
-                    if (params.enabled && !maneuverViewVisible) {
+                    if (enabled && !maneuverViewVisible) {
                         View.VISIBLE
                     } else {
                         View.GONE

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

@@ -48,6 +48,7 @@ internal class NavigationViewOptions(context: Context) {
     private var _showCameraModeActionButton: MutableStateFlow<Boolean> = MutableStateFlow(true)
     private var _showToggleAudioActionButton: MutableStateFlow<Boolean> = MutableStateFlow(true)
     private var _showRecenterActionButton: MutableStateFlow<Boolean> = MutableStateFlow(true)
+    private var _showMapScalebar: MutableStateFlow<Boolean> = MutableStateFlow(false)
     private var _showTripProgress: MutableStateFlow<Boolean> = MutableStateFlow(true)
     private var _showRoutePreviewButton: MutableStateFlow<Boolean> = MutableStateFlow(true)
     private var _showEndNavigationButton: MutableStateFlow<Boolean> = MutableStateFlow(true)
@@ -73,6 +74,7 @@ internal class NavigationViewOptions(context: Context) {
     val showCameraModeActionButton: StateFlow<Boolean> = _showCameraModeActionButton.asStateFlow()
     val showToggleAudioActionButton: StateFlow<Boolean> = _showToggleAudioActionButton.asStateFlow()
     val showRecenterActionButton: StateFlow<Boolean> = _showRecenterActionButton.asStateFlow()
+    val showMapScalebar: StateFlow<Boolean> = _showMapScalebar.asStateFlow()
     val showTripProgress: StateFlow<Boolean> = _showTripProgress.asStateFlow()
     val showRoutePreviewButton: StateFlow<Boolean> = _showRoutePreviewButton.asStateFlow()
     val showEndNavigationButton: StateFlow<Boolean> = _showEndNavigationButton.asStateFlow()
@@ -100,6 +102,7 @@ internal class NavigationViewOptions(context: Context) {
         }
         customization.showRecenterActionButton?.also { _showRecenterActionButton.value = it }
         customization.showTripProgress?.also { _showTripProgress.value = it }
+        customization.showMapScalebar?.also { _showMapScalebar.value = it }
         customization.showRoutePreviewButton?.also { _showRoutePreviewButton.value = it }
         customization.showEndNavigationButton?.also { _showEndNavigationButton.value = it }
         customization.showStartNavigationButton?.also { _showStartNavigationButton.value = it }

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

@@ -5,7 +5,6 @@ import com.mapbox.maps.plugin.LocationPuck
 import com.mapbox.maps.plugin.annotation.generated.PointAnnotationOptions
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.dropin.ViewStyleCustomization
-import com.mapbox.navigation.dropin.map.scalebar.MapboxMapScalebarParams
 import com.mapbox.navigation.ui.maneuver.model.ManeuverViewOptions
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
@@ -58,9 +57,6 @@ internal class NavigationViewStyles(context: Context) {
         MutableStateFlow(ViewStyleCustomization.defaultArrivalTextAppearance())
     private val _locationPuck: MutableStateFlow<LocationPuck> =
         MutableStateFlow(ViewStyleCustomization.defaultLocationPuck(context))
-    private val _mapScalebarParams: MutableStateFlow<MapboxMapScalebarParams> = MutableStateFlow(
-        ViewStyleCustomization.defaultMapScalebarParams(context)
-    )
 
     val infoPanelPeekHeight: StateFlow<Int> = _infoPanelPeekHeight.asStateFlow()
     val infoPanelMarginStart: StateFlow<Int> = _infoPanelMarginStart.asStateFlow()
@@ -86,7 +82,6 @@ internal class NavigationViewStyles(context: Context) {
     val maneuverViewOptions: StateFlow<ManeuverViewOptions> = _maneuverViewOptions.asStateFlow()
     val arrivalTextAppearance: StateFlow<Int> = _arrivalTextAppearance.asStateFlow()
     val locationPuck: StateFlow<LocationPuck> = _locationPuck.asStateFlow()
-    val mapScalebarParams: StateFlow<MapboxMapScalebarParams> = _mapScalebarParams.asStateFlow()
 
     fun applyCustomization(customization: ViewStyleCustomization) {
         customization.infoPanelPeekHeight?.also { _infoPanelPeekHeight.value = it }
@@ -114,6 +109,5 @@ internal class NavigationViewStyles(context: Context) {
         customization.roadNameTextAppearance?.also { _roadNameTextAppearance.value = it }
         customization.arrivalTextAppearance?.also { _arrivalTextAppearance.value = it }
         customization.locationPuck?.also { _locationPuck.value = it }
-        customization.mapScalebarParams?.also { _mapScalebarParams.value = it }
     }
 }