[FloatingToolbar] Floating toolbar should not enforce disappear on scroll behaviour within CoordinatorLayouts

PiperOrigin-RevId: 719361862

Author: imhappi

catalog/java/io/material/catalog/floatingtoolbar/res/layout/cat_floating_toolbar_fragment.xml

@@ -95,6 +95,7 @@
   android:layout_height="wrap_content"
   android:layout_gravity="left|center"
   android:layout_margin="16dp"
+  app:layout_behavior="com.google.android.material.behavior.HideViewOnScrollBehavior"
   android:visibility="gone">
 
   <LinearLayout
@@ -114,6 +115,7 @@
   android:layout_height="wrap_content"
   android:layout_gravity="right|center"
   android:layout_margin="16dp"
+  app:layout_behavior="com.google.android.material.behavior.HideViewOnScrollBehavior"
   android:visibility="gone">
 
   <LinearLayout
@@ -133,6 +135,7 @@
   android:layout_height="wrap_content"
   android:layout_gravity="bottom|center"
   style="?attr/floatingToolbarVibrantStyle"
+  app:layout_behavior="com.google.android.material.behavior.HideViewOnScrollBehavior"
   android:layout_margin="16dp">
 
   <LinearLayout

docs/components/FloatingToolBar.md

@@ -67,8 +67,9 @@ Here's what a typical layout would look like:
     android:layout_width="wrap_content"
     android:layout_height="wrap_content"
     android:layout_gravity="bottom|center"
+    app:layout_behavior="com.google.android.material.behavior.HideViewOnScrollBehavior"
     android:layout_margin="16dp">
-    
+
     <!-- floating toolbar sample content -->
     <LinearLayout
       android:id="@+id/floating_toolbar_child"
@@ -111,10 +112,20 @@ Here's what a typical layout would look like:
 A Floating Toolbar is a `FrameLayout` that provides additional styling and functionality.
 You may add children to it as you would to a `FrameLayout`.
 
-When inside a `CoordinatorLayout`, a floating toolbar will hide itself on scroll using `CoordinatorLayout.Behavior`.
+Floating toolbars can hide on scroll if inside a `CoordinatorLayout` by setting the following `CoordinatorLayout.Behavior` through the `app:layout_behavior` attribute:
+
+```xml
+  <com.google.android.material.floatingtoolbar.FloatingToolbarLayout
+    android:id="@+id/floating_toolbar"
+    android:layout_width="wrap_content"
+    android:layout_height="wrap_content"
+    android:layout_gravity="bottom|center"
+    app:layout_behavior="com.google.android.material.behavior.HideViewOnScrollBehavior">
+  ...
+</com.google.android.material.floatingtoolbar.FloatingToolbarLayout>
+```
 
-Note that the Material3 style should be explicitly set on the `FloatingToolbarLayout`. See the full list of [styles](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/floatingtoolbar/res/values/styles.xml). Otherwise the default horizontal style will be used and `android:layout_gravity` and `android:layout_margin`
-will need to be set explicitly.
+Note that the default M3 style is the horizontal standard color styling. Vibrant color or vertical styles should be explicitly set on the `FloatingToolbarLayout`. M3 stylings for specific components may also be defined, such as for icon buttons. These are recommended to be set explicitly on the corresponding components inside `FloatingToolbarLayout`. See the full list of [styles](https://github.com/material-components/material-components-android/tree/master/lib/java/com/google/android/material/floatingtoolbar/res/values/styles.xml).
 
 API and source code:
 

lib/java/com/google/android/material/floatingtoolbar/FloatingToolbarLayout.java

@@ -35,11 +35,9 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.StyleRes;
-import androidx.coordinatorlayout.widget.CoordinatorLayout.AttachedBehavior;
 import androidx.core.graphics.Insets;
 import androidx.core.view.ViewCompat;
 import androidx.core.view.WindowInsetsCompat;
-import com.google.android.material.behavior.HideViewOnScrollBehavior;
 import com.google.android.material.internal.ThemeEnforcement;
 import com.google.android.material.shape.MaterialShapeDrawable;
 import com.google.android.material.shape.ShapeAppearanceModel;
@@ -54,11 +52,10 @@
  * provides styling for the provided child to give a uniform "floating toolbar" appearance to the
  * {@link android.view.ViewGroup}.
  */
-public class FloatingToolbarLayout extends FrameLayout implements AttachedBehavior {
+public class FloatingToolbarLayout extends FrameLayout {
 
   private static final String TAG = FloatingToolbarLayout.class.getSimpleName();
   private static final int DEF_STYLE_RES = R.style.Widget_Material3_FloatingToolbar;
-  @Nullable private Behavior behavior;
 
   private boolean marginLeftSystemWindowInsets;
   private boolean marginTopSystemWindowInsets;
@@ -180,20 +177,4 @@ public WindowInsetsCompat onApplyWindowInsets(
 
     attributes.recycle();
   }
-
-  @Override
-  @NonNull
-  public Behavior getBehavior() {
-    if (behavior == null) {
-      behavior = new Behavior();
-    }
-    return behavior;
-  }
-
-  /**
-   * Behavior designed for use with {@link FloatingToolbarLayout} instances. Its main function is to
-   * hide the {@link FloatingToolbarLayout} view when scrolling. Supports scrolling the floating
-   * toolbar off of either the right, bottom or left edge of the screen.
-   */
-  public static class Behavior extends HideViewOnScrollBehavior<FloatingToolbarLayout> {}
 }

lib/java/com/google/android/material/theme/res/values/themes_base.xml

@@ -452,6 +452,8 @@
     <item name="floatingActionButtonLargeSecondaryStyle">@style/Widget.Material3.FloatingActionButton.Large.Secondary</item>
     <item name="floatingActionButtonLargeTertiaryStyle">@style/Widget.Material3.FloatingActionButton.Large.Tertiary</item>
     <item name="floatingActionButtonLargeSurfaceStyle">@style/Widget.Material3.FloatingActionButton.Large.Surface</item>
+    <item name="floatingToolbarStyle">@style/Widget.Material3.FloatingToolbar</item>
+    <item name="floatingToolbarVibrantStyle">@style/Widget.Material3.FloatingToolbar.Vibrant</item>
     <item name="linearProgressIndicatorStyle">@style/Widget.Material3.LinearProgressIndicator</item>
     <item name="loadingIndicatorStyle">@style/Widget.Material3.LoadingIndicator</item>
     <item name="materialIconButtonStyle">@style/Widget.Material3.Button.IconButton</item>