[Drop-In UI] Fix of multiple infoPanel issues (#6361)

* Fixed info panel layout issues when in fullscreen mode.
Exposed BottomSheet slideOffset value via NavigationViewListener.
Updated QA-Test-App custom info panel layout example.

Fixed road name label position when updating bottom sheet state

Added examples for custom info panel layouts with fixed height

Fixed incorrect RoadNameLabel placement when bottom sheet is visible in landscape mode.

Tests fix.

CHANGELOG entry

Fixed info panel > small content size support.

Fixed InfoPanelCoordinator resetSlideOffset logic.
NavigationViewListener KDoc updates.

* Unit tests fix

Author: tomaszrybakiewicz

CHANGELOG.md

@@ -9,6 +9,7 @@ Mapbox welcomes participation and contributions from everyone.
 - Added `ComponentInstaller` for the `LocationComponent` that offers simplified integration of map LocationPuck. [#6206](https://github.com/mapbox/mapbox-navigation-android/pull/6206)
 - Added `ViewStyleCustomization.locationPuck` that allows to define a custom location puck using `NavigationView`. [#6365](https://github.com/mapbox/mapbox-navigation-android/pull/6365)
 - Added _Experimental_ `RouteRefreshStatesObserver` that can be used to observe route refresh states. To subscribe and unsubscribe on updates corresponding use `MapboxNavigation#registerRouteRefreshStateObserver` and `MapboxNavigation#unregisterRouteRefreshStateObserver`. [#6345](https://github.com/mapbox/mapbox-navigation-android/pull/6345)
+- Introduced `NavigationViewListener.onInfoPanelSlide` callback that allows observation of `NavigationView`'s Info Panel slide offset. [#6361](https://github.com/mapbox/mapbox-navigation-android/pull/6361)
 #### Bug fixes and improvements
 - Marked `PredictiveCacheController`, `MapboxBuildingView`, `ViewportDataSourceUpdateObserver`, `NavigationScaleGestureHandler`, `NavigationCameraStateChangedObserver`, `NavigationCameraStateTransition`, `NavigationCameraTransition`, `TransitionEndListener`, `MapboxRecenterButton`, `MapboxRouteOverviewButton`, `MapboxJunctionView`, `MapboxSignboardView`, `MapboxRoadNameLabelView`, `MapboxRoadNameView`, `MapboxRouteArrowView`, `MapboxRouteLineView`, `MapboxCameraModeButton` methods and `View.capture` extension with `@UiThread` annotation. [#6235](https://github.com/mapbox/mapbox-navigation-android/pull/6235)
 - Marked `Binder`, `MapboxExtendableButton` methods and `MapboxNavigation#installComponents` methods with `@UiThread` annotation. [#6268](https://github.com/mapbox/mapbox-navigation-android/pull/6268)
@@ -19,6 +20,8 @@ Mapbox welcomes participation and contributions from everyone.
 - Fixed crash caused by `ConstantVelocityInterpolator` creating `PathInterpolator` with an invalid path. [#6367](https://github.com/mapbox/mapbox-navigation-android/pull/6367)
 - Improved alternatives id robustness by adding new alternatives to existing instead of replacing them during `MapboxNavigation#requestAlternativeRoutes`. [#6373](https://github.com/mapbox/mapbox-navigation-android/pull/6373)
 - Improved stop detector for auto profile. [#6373](https://github.com/mapbox/mapbox-navigation-android/pull/6373)
+- Fixed `RoadNameLabel` position issues by making sure that it updates when expanding and collapsing the info panel. [#6361](https://github.com/mapbox/mapbox-navigation-android/pull/6361)
+- Fixed `InfoPanel` overlapping the `RoadNameLabel` in free drive state with the device being in landscape orientation. [#6361](https://github.com/mapbox/mapbox-navigation-android/pull/6361)
 
 ## Mapbox Navigation SDK 2.9.0-alpha.2 - 16 September, 2022
 ### Changelog

libnavui-dropin/api/current.txt

@@ -100,8 +100,10 @@ package com.mapbox.navigation.dropin {
     method public void onInfoPanelExpanded();
     method public void onInfoPanelHidden();
     method public void onInfoPanelSettling();
+    method public void onInfoPanelSlide(float slideOffset);
     method public void onManeuverCollapsed();
     method public void onManeuverExpanded();
+    method public void onMapClicked(com.mapbox.geojson.Point point);
     method public void onOverviewCameraMode();
     method public void onRouteFetchCanceled(com.mapbox.api.directions.v5.models.RouteOptions routeOptions, com.mapbox.navigation.base.route.RouterOrigin routerOrigin);
     method public void onRouteFetchFailed(java.util.List<com.mapbox.navigation.base.route.RouterFailure> reasons, com.mapbox.api.directions.v5.models.RouteOptions routeOptions);

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

@@ -131,6 +131,16 @@ abstract class NavigationViewListener {
      */
     open fun onInfoPanelSettling() = Unit
 
+    /**
+     * Called when the info panel is being dragged.
+     *
+     * @param slideOffset The new offset of info panel within [-1,1] range. Offset increases
+     *  as info panel is moving upward and decreases in the opposite direction.
+     *  Range 0 to 1: Denotes the panel is transitioning from collapsed to expanded state.
+     *  Range -1 to 0: Denotes the panel is transitioning from hidden to collapsed state.
+     */
+    open fun onInfoPanelSlide(slideOffset: Float) = Unit
+
     /**
      * Called when hardware back button has been pressed.
      *

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

@@ -110,7 +110,7 @@ internal class NavigationViewListenerRegistry(
             }
             launch {
                 infoPanelSubscriber
-                    .infoPanelBehavior
+                    .bottomSheetState
                     .filterNotNull()
                     .collect { behavior ->
                         when (behavior) {
@@ -122,7 +122,9 @@ internal class NavigationViewListenerRegistry(
                         }
                     }
             }
-
+            launch {
+                infoPanelSubscriber.slideOffset.collect(listener::onInfoPanelSlide)
+            }
             launch {
                 maneuverSubscriber
                     .maneuverBehavior

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/binder/infopanel/InfoPanelBinder.kt

@@ -4,6 +4,7 @@ import android.content.Context
 import android.view.LayoutInflater
 import android.view.ViewGroup
 import androidx.core.graphics.Insets
+import androidx.core.view.updatePadding
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.internal.extensions.navigationListOf
 import com.mapbox.navigation.core.lifecycle.MapboxNavigationObserver
@@ -124,12 +125,8 @@ internal class MapboxInfoPanelBinder : InfoPanelBinder() {
         layout.findViewById(R.id.infoPanelContent)
 
     override fun applySystemBarsInsets(layout: ViewGroup, insets: Insets) {
-        layout.setPadding(
-            layout.paddingLeft,
-            layout.paddingTop,
-            layout.paddingRight,
-            insets.bottom
-        )
+        layout.updatePadding(bottom = insets.bottom)
+        // top, left and right insets are applied by InfoPanelComponent
     }
 
     override fun bind(viewGroup: ViewGroup): MapboxNavigationObserver {

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/component/infopanel/InfoPanelBehavior.kt

@@ -5,10 +5,19 @@ import kotlinx.coroutines.flow.asStateFlow
 
 internal class InfoPanelBehavior {
 
-    private val _infoPanelBehavior = MutableStateFlow<Int?>(null)
-    val infoPanelBehavior = _infoPanelBehavior.asStateFlow()
+    private val _bottomSheetState = MutableStateFlow<Int?>(null)
+    val bottomSheetState = _bottomSheetState.asStateFlow()
 
-    fun updateBehavior(newState: Int) {
-        _infoPanelBehavior.value = newState
+    private val _slideOffset = MutableStateFlow<Float>(-1f)
+    val slideOffset = _slideOffset.asStateFlow()
+
+    fun updateBottomSheetState(newState: Int) {
+        _bottomSheetState.value = newState
+    }
+
+    fun updateSlideOffset(slideOffset: Float) {
+        if (!slideOffset.isNaN()) {
+            _slideOffset.value = slideOffset.coerceIn(-1f, 1f)
+        }
     }
 }

libnavui-dropin/src/main/java/com/mapbox/navigation/dropin/component/infopanel/InfoPanelComponent.kt

@@ -1,9 +1,12 @@
 package com.mapbox.navigation.dropin.component.infopanel
 
 import android.view.ViewGroup
+import androidx.core.view.updatePadding
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.MapboxNavigation
+import com.mapbox.navigation.dropin.NavigationView
 import com.mapbox.navigation.dropin.NavigationViewContext
+import com.mapbox.navigation.dropin.internal.extensions.updateMargins
 import com.mapbox.navigation.ui.base.lifecycle.UIComponent
 import kotlinx.coroutines.flow.combine
 
@@ -13,21 +16,55 @@ internal class InfoPanelComponent(
     private val context: NavigationViewContext
 ) : UIComponent() {
 
+    private companion object {
+        const val APPLY_TOP_PADDING_THRESHOLD = 0.8f
+    }
+
     override fun onAttached(mapboxNavigation: MapboxNavigation) {
         super.onAttached(mapboxNavigation)
-        stylesFlow().observe { (background, marginLeft, marginRight) ->
-            layout.layoutParams = (layout.layoutParams as? ViewGroup.MarginLayoutParams)?.apply {
-                setMargins(marginLeft, topMargin, marginRight, bottomMargin)
+
+        val navigationView = findNavigationView()
+        combine(
+            context.infoPanelBehavior.slideOffset,
+            context.systemBarsInsets
+        ) { slideOffset, insets ->
+            slideOffset to insets
+        }.observe { (slideOffset, insets) ->
+            val isFullHeightLayout = layout.height == navigationView?.height
+            if (isFullHeightLayout && APPLY_TOP_PADDING_THRESHOLD < slideOffset) {
+                val f = 1.0f - (1.0f - slideOffset) / (1.0f - APPLY_TOP_PADDING_THRESHOLD)
+                val top = insets.top * f
+                layout.updatePadding(top = top.toInt(), bottom = insets.bottom)
+            } else {
+                layout.updatePadding(top = 0, bottom = insets.bottom)
             }
+        }
+
+        stylesFlow().observe { (background, marginLeft, marginRight) ->
+            layout.updateMargins(
+                left = marginLeft,
+                right = marginRight
+            )
             layout.setBackgroundResource(background)
         }
     }
 
+    private fun findNavigationView(): NavigationView? {
+        var v = layout.parent
+        while (v != null && v !is NavigationView) {
+            v = v.parent
+        }
+        return v as? NavigationView
+    }
+
     private fun stylesFlow() = context.styles.let { styles ->
         combine(
             styles.infoPanelBackground,
             styles.infoPanelMarginStart,
-            styles.infoPanelMarginEnd
-        ) { background, marginStart, marginEnd -> Triple(background, marginStart, marginEnd) }
+            styles.infoPanelMarginEnd,
+            context.systemBarsInsets
+        ) { background, marginStart, marginEnd, insets ->
+            Triple(background, marginStart + insets.left, marginEnd + insets.right)
+        }
     }
 }

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

@@ -34,12 +34,13 @@ internal class InfoPanelCoordinator(
 
     private val updateGuideline = object : BottomSheetBehavior.BottomSheetCallback() {
         override fun onStateChanged(bottomSheet: View, newState: Int) {
-            context.infoPanelBehavior.updateBehavior(newState)
-            setGuidelinePosition(bottomSheet, context.systemBarsInsets.value)
+            context.infoPanelBehavior.updateBottomSheetState(newState)
+            updateGuidelinePosition()
         }
 
         override fun onSlide(bottomSheet: View, slideOffset: Float) {
-            setGuidelinePosition(bottomSheet, context.systemBarsInsets.value)
+            context.infoPanelBehavior.updateSlideOffset(slideOffset)
+            updateGuidelinePosition()
         }
     }
 
@@ -55,18 +56,19 @@ internal class InfoPanelCoordinator(
         behavior.addBottomSheetCallback(updateGuideline)
         coroutineScope.launch {
             bottomSheetState().collect { state ->
+                val prevState = behavior.state
                 when (state) {
                     BottomSheetBehavior.STATE_HIDDEN -> behavior.hide()
                     BottomSheetBehavior.STATE_COLLAPSED,
                     BottomSheetBehavior.STATE_HALF_EXPANDED,
                     BottomSheetBehavior.STATE_EXPANDED -> behavior.show(state)
                 }
+                resetSlideOffset(prevState, state)
+                updateGuidelinePosition()
             }
         }
         coroutineScope.launch {
-            context.systemBarsInsets.collect {
-                setGuidelinePosition(infoPanel, it)
-            }
+            context.systemBarsInsets.collect(this@InfoPanelCoordinator::updateGuidelinePosition)
         }
         coroutineScope.launch {
             context.options.isInfoPanelHideable.collect { hideable ->
@@ -107,11 +109,12 @@ internal class InfoPanelCoordinator(
     }
 
     private fun bottomSheetState() = combine(
+        context.uiBinders.infoPanelContentBinder,
         store.select { it.destination?.point },
         store.select { it.navigation },
         context.options.showInfoPanelInFreeDrive,
-        context.options.infoPanelForcedState
-    ) { _, navigationState, showInfoPanelInFreeDrive, infoPanelForcedState ->
+        context.options.infoPanelForcedState,
+    ) { _, _, navigationState, showInfoPanelInFreeDrive, infoPanelForcedState ->
         if (infoPanelForcedState != 0) {
             infoPanelForcedState
         } else if (showInfoPanelInFreeDrive || navigationState != NavigationState.FreeDrive) {
@@ -138,9 +141,27 @@ internal class InfoPanelCoordinator(
         state = BottomSheetBehavior.STATE_HIDDEN
     }
 
-    private fun setGuidelinePosition(bottomSheet: View, systemBarsInsets: Insets) {
-        val parentHeight = (bottomSheet.parent as ViewGroup).height
-        guidelineBottom.setGuidelineEnd(parentHeight - bottomSheet.top - systemBarsInsets.bottom)
+    private fun updateGuidelinePosition(systemBarsInsets: Insets = context.systemBarsInsets.value) {
+        val parentHeight = (infoPanel.parent as ViewGroup).height
+        val maxPos = (parentHeight * GUIDELINE_MAX_POSITION_PERCENT).toInt()
+        val pos = parentHeight - infoPanel.top - systemBarsInsets.bottom
+        guidelineBottom.setGuidelineEnd(pos.coerceIn(0, maxPos))
+    }
+
+    private fun resetSlideOffset(prevBottomSheetState: Int, bottomSheetState: Int) {
+        if (prevBottomSheetState == BottomSheetBehavior.STATE_EXPANDED) {
+            // BottomSheet slideOffset value is always in [-1,1] range.
+            // From -1.0 when hidden, 0.0 when collapsed to 1.0 when expanded.
+            when (bottomSheetState) {
+                BottomSheetBehavior.STATE_EXPANDED -> 1.0f
+                BottomSheetBehavior.STATE_HALF_EXPANDED -> 0.5f
+                BottomSheetBehavior.STATE_COLLAPSED -> 0.0f
+                BottomSheetBehavior.STATE_HIDDEN -> -1.0f
+                else -> null
+            }?.also { slideOffset ->
+                context.infoPanelBehavior.updateSlideOffset(slideOffset)
+            }
+        }
     }
 
     /**
@@ -168,4 +189,12 @@ internal class InfoPanelCoordinator(
             }
         }
     }
+
+    private companion object {
+        /**
+         * Guideline bottom maximum position within its parent view.
+         * This value must be within 0.0f..1.0f range.
+         */
+        const val GUIDELINE_MAX_POSITION_PERCENT = 0.3f
+    }
 }

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

@@ -1,19 +1,20 @@
 package com.mapbox.navigation.dropin.coordinator
 
-import android.content.res.Configuration
+import android.content.res.Configuration.ORIENTATION_LANDSCAPE
 import android.view.ViewGroup
 import androidx.constraintlayout.widget.ConstraintLayout
 import androidx.core.view.updateLayoutParams
+import com.google.android.material.bottomsheet.BottomSheetBehavior
 import com.mapbox.navigation.base.ExperimentalPreviewMapboxNavigationAPI
 import com.mapbox.navigation.core.MapboxNavigation
 import com.mapbox.navigation.dropin.NavigationViewContext
 import com.mapbox.navigation.dropin.R
 import com.mapbox.navigation.dropin.binder.roadlabel.RoadNameViewBinder
-import com.mapbox.navigation.ui.app.internal.navigation.NavigationState
 import com.mapbox.navigation.ui.base.lifecycle.UIBinder
 import com.mapbox.navigation.ui.base.lifecycle.UICoordinator
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.collect
+import kotlinx.coroutines.flow.filterNotNull
 import kotlinx.coroutines.flow.map
 import kotlinx.coroutines.launch
 
@@ -26,42 +27,33 @@ internal class RoadNameLabelCoordinator(
     val roadNameLabelLayout: ViewGroup
 ) : UICoordinator<ViewGroup>(roadNameLabelLayout) {
 
-    override fun MapboxNavigation.flowViewBinders(): Flow<UIBinder> {
+    override fun onAttached(mapboxNavigation: MapboxNavigation) {
+        super.onAttached(mapboxNavigation)
+
         coroutineScope.launch {
-            context.store.select { it.navigation }.collect { navigationState ->
-                when (roadNameLabelLayout.resources.configuration.orientation) {
-                    Configuration.ORIENTATION_LANDSCAPE -> {
-                        adjustLandscapeConstraints(navigationState)
+            context.infoPanelBehavior.bottomSheetState
+                .filterNotNull()
+                .map { bottomSheetState ->
+                    val isBottomSheetVisible = bottomSheetState != BottomSheetBehavior.STATE_HIDDEN
+                    if (isOrientationLandscape() && isBottomSheetVisible) {
+                        R.id.guidelineBegin
+                    } else {
+                        ConstraintLayout.LayoutParams.PARENT_ID
                     }
-                    else -> {
-                        roadNameLabelLayout.updateLayoutParams<ConstraintLayout.LayoutParams> {
-                            startToStart = R.id.container
-                        }
+                }.collect { startConstraintId ->
+                    roadNameLabelLayout.updateLayoutParams<ConstraintLayout.LayoutParams> {
+                        startToStart = startConstraintId
                     }
                 }
-            }
         }
+    }
 
+    private fun isOrientationLandscape() =
+        roadNameLabelLayout.resources.configuration.orientation == ORIENTATION_LANDSCAPE
+
+    override fun MapboxNavigation.flowViewBinders(): Flow<UIBinder> {
         return context.uiBinders.roadName.map {
             it ?: RoadNameViewBinder(context)
         }
     }
-
-    private fun adjustLandscapeConstraints(navigationState: NavigationState) {
-        when (navigationState) {
-            NavigationState.FreeDrive -> {
-                roadNameLabelLayout.updateLayoutParams<ConstraintLayout.LayoutParams> {
-                    startToStart = R.id.container
-                }
-            }
-            NavigationState.DestinationPreview,
-            NavigationState.RoutePreview,
-            NavigationState.ActiveNavigation,
-            NavigationState.Arrival -> {
-                roadNameLabelLayout.updateLayoutParams<ConstraintLayout.LayoutParams> {
-                    startToStart = R.id.guidelineBegin
-                }
-            }
-        }
-    }
 }