Bug 1864760 - Added actions to Toolbar and MenuButton to hide and sho…

…w the menu button

android-components/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/BrowserToolbar.kt

@@ -335,6 +335,20 @@ class BrowserToolbar @JvmOverloads constructor(
         edit.removeEditActionEnd(action)
     }
 
+    /**
+     * Hides the menu button in display mode.
+     */
+    override fun hideMenuButton() {
+        display.hideMenuButton()
+    }
+
+    /**
+     * Shows the menu button in display mode.
+     */
+    override fun showMenuButton() {
+        display.showMenuButton()
+    }
+
     /**
      * Switches to URL editing mode.
      *

android-components/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/display/DisplayToolbar.kt

@@ -648,6 +648,20 @@ class DisplayToolbar internal constructor(
     internal fun removeNavigationAction(action: Toolbar.Action) {
         views.navigationActions.removeAction(action)
     }
+
+    /**
+     * Hides the menu button in display mode.
+     */
+    internal fun hideMenuButton() {
+        views.menu.setShouldBeHidden(true)
+    }
+
+    /**
+     * Shows the menu button in display mode.
+     */
+    internal fun showMenuButton() {
+        views.menu.setShouldBeHidden(false)
+    }
 }
 
 /**

android-components/components/browser/toolbar/src/main/java/mozilla/components/browser/toolbar/display/MenuButton.kt

@@ -92,6 +92,15 @@ internal class MenuButton(
 
     fun setColorFilter(@ColorInt color: Int) = impl.setColorFilter(color)
 
+    /**
+     * Hides the menu button.
+     *
+     * @param shouldBeHidden A [Boolean] that determines the visibility of the menu button.
+     */
+    fun setShouldBeHidden(shouldBeHidden: Boolean) {
+        impl.isVisible = !shouldBeHidden && shouldBeVisible()
+    }
+
     @VisibleForTesting
     internal fun shouldBeVisible() = impl.menuBuilder != null || impl.menuController != null
 }

android-components/components/browser/toolbar/src/test/java/mozilla/components/browser/toolbar/BrowserToolbarTest.kt

@@ -542,6 +542,30 @@ class BrowserToolbarTest {
         verify(edit).removeEditActionEnd(action)
     }
 
+    @Test
+    fun `WHEN hideMenuButton is sent to BrowserToolbar THEN it will be forwarded to the DisplayToolbar`() {
+        val toolbar = BrowserToolbar(testContext)
+
+        val display: DisplayToolbar = mock()
+        toolbar.display = display
+
+        toolbar.hideMenuButton()
+
+        verify(display).hideMenuButton()
+    }
+
+    @Test
+    fun `WHEN showMenuButton is sent to BrowserToolbar THEN it will be forwarded to the DisplayToolbar`() {
+        val toolbar = BrowserToolbar(testContext)
+
+        val display: DisplayToolbar = mock()
+        toolbar.display = display
+
+        toolbar.showMenuButton()
+
+        verify(display).showMenuButton()
+    }
+
     @Test
     fun `cast to view`() {
         // Given

android-components/components/concept/toolbar/src/main/java/mozilla/components/concept/toolbar/Toolbar.kt

@@ -173,6 +173,16 @@ interface Toolbar {
      */
     fun removeEditActionEnd(action: Action)
 
+    /**
+     * Hides the menu button in display mode.
+     */
+    fun hideMenuButton()
+
+    /**
+     * Shows the menu button in display mode.
+     */
+    fun showMenuButton()
+
     /**
      * Casts this toolbar to an Android View object.
      */

android-components/components/feature/customtabs/src/test/java/mozilla/components/feature/customtabs/feature/CustomTabSessionTitleObserverTest.kt

@@ -88,6 +88,8 @@ class CustomTabSessionTitleObserverTest {
         override fun addEditActionStart(action: Toolbar.Action) = Unit
         override fun addEditActionEnd(action: Toolbar.Action) = Unit
         override fun removeEditActionEnd(action: Toolbar.Action) = Unit
+        override fun hideMenuButton() = Unit
+        override fun showMenuButton() = Unit
         override fun setOnEditListener(listener: Toolbar.OnEditListener) = Unit
         override fun displayMode() = Unit
         override fun editMode(cursorPlacement: Toolbar.CursorPlacement) = Unit

android-components/components/feature/toolbar/src/test/java/mozilla/components/feature/toolbar/ToolbarAutocompleteFeatureTest.kt

@@ -115,6 +115,14 @@ class ToolbarAutocompleteFeatureTest {
             fail()
         }
 
+        override fun hideMenuButton() {
+            fail()
+        }
+
+        override fun showMenuButton() {
+            fail()
+        }
+
         override fun invalidateActions() {
             fail()
         }

android-components/components/feature/toolbar/src/test/java/mozilla/components/feature/toolbar/ToolbarInteractorTest.kt

@@ -98,6 +98,14 @@ class ToolbarInteractorTest {
             fail()
         }
 
+        override fun hideMenuButton() {
+            fail()
+        }
+
+        override fun showMenuButton() {
+            fail()
+        }
+
         override fun invalidateActions() {
             fail()
         }

docs/changelog.md

@@ -16,6 +16,10 @@ permalink: /changelog/
 
 * **all components**
   * All new usages of the `concept-fetch` component to make fetch requests now have conservative-mode off by default. Current features will continue to use conservative mode until individually updated.
+
+* **browser-toolbar**
+  * Add `showMenuButton` and `hideMenuButton` API to `BrowserToolbar` and `DisplayToolbar` to allow hiding and showing of the menu button in
+  the `BrowserToolbar` [Bug 1864760](https://bugzilla.mozilla.org/show_bug.cgi?id=1864760)
 
 # 123.0
 * [Commits](https://github.com/mozilla-mobile/firefox-android/compare/releases_v122..releases_v123)