Handle horizontal system insets for BottomAppBar.

Previously only the bottom inset (navigation bar) would add extra padding to the BottomAppBar which avoided overlapping with the bottom inset when drawing edge-to-edge. A problem arises if the device is rotated horizontally. The FAB (or sometimes the ActionMenuView in RtL layouts) would overlap with the right inset, making usage impossible.

This CL adjusts the FAB and ActionMenuView X translations when necessary to avoid the horizontal system insets. Two new stylable attributes have been added to enable/disable this behavior, analogous to the existing attribute for bottom padding.

PiperOrigin-RevId: 286419669

Author: Material Design Team

docs/components/BottomAppBar.md

@@ -82,6 +82,8 @@ FAB Cradle Corner Radius      | `app:fabCradleRoundedCornerRadius`
 FAB Vertical Offset           | `app:fabCradleVerticalOffset`
 Hide on scroll                | `app:hideOnScroll`
 Add Padding for Bottom Insets | `app:paddingBottomSystemWindowInsets`
+Add Padding for Left Insets   | `app:paddingLeftSystemWindowInsets`
+Add Padding for Right Insets  | `app:paddingRightSystemWindowInsets`
 
 #### Background Tint
 

lib/java/com/google/android/material/bottomappbar/BottomAppBar.java

@@ -146,6 +146,8 @@ public class BottomAppBar extends Toolbar implements AttachedBehavior {
   @FabAnimationMode private int fabAnimationMode;
   private boolean hideOnScroll;
   private final boolean paddingBottomSystemWindowInsets;
+  private final boolean paddingLeftSystemWindowInsets;
+  private final boolean paddingRightSystemWindowInsets;
 
   /** Keeps track of the number of currently running animations. */
   private int animatingModeChangeCounter = 0;
@@ -168,6 +170,8 @@ interface AnimationListener {
   private Behavior behavior;
 
   private int bottomInset;
+  private int rightInset;
+  private int leftInset;
 
   /**
    * Listens to the FABs hide or show animation to kick off an animation on BottomAppBar that reacts
@@ -243,6 +247,10 @@ public BottomAppBar(@NonNull Context context, @Nullable AttributeSet attrs, int
     // Reading out if we are handling bottom padding, so we can apply it to the FAB.
     paddingBottomSystemWindowInsets =
         a.getBoolean(R.styleable.BottomAppBar_paddingBottomSystemWindowInsets, false);
+    paddingLeftSystemWindowInsets =
+        a.getBoolean(R.styleable.BottomAppBar_paddingLeftSystemWindowInsets, false);
+    paddingRightSystemWindowInsets =
+        a.getBoolean(R.styleable.BottomAppBar_paddingRightSystemWindowInsets, false);
 
     a.recycle();
 
@@ -273,11 +281,31 @@ public WindowInsetsCompat onApplyWindowInsets(
               View view,
               @NonNull WindowInsetsCompat insets,
               @NonNull RelativePadding initialPadding) {
+            // Just read the insets here. doOnApplyWindowInsets will apply the padding under the
+            // hood.
+            boolean leftInsetsChanged = false;
+            boolean rightInsetsChanged = false;
             if (paddingBottomSystemWindowInsets) {
-              // Just read the insets here. doOnApplyWindowInsets will apply the bottom padding
-              // under the hood.
               bottomInset = insets.getSystemWindowInsetBottom();
             }
+            if (paddingLeftSystemWindowInsets) {
+              leftInsetsChanged = leftInset != insets.getSystemWindowInsetLeft();
+              leftInset = insets.getSystemWindowInsetLeft();
+            }
+            if (paddingRightSystemWindowInsets) {
+              rightInsetsChanged = rightInset != insets.getSystemWindowInsetRight();
+              rightInset = insets.getSystemWindowInsetRight();
+            }
+
+            // We may need to change the position of the cutout or the action menu if the side
+            // insets have changed.
+            if (leftInsetsChanged || rightInsetsChanged) {
+              cancelAnimations();
+
+              setCutoutState();
+              setActionMenuViewPosition();
+            }
+
             return insets;
           }
         });
@@ -679,10 +707,14 @@ private float getFabTranslationY() {
   }
 
   private float getFabTranslationX(@FabAlignmentMode int fabAlignmentMode) {
-    boolean isRtl = ViewCompat.getLayoutDirection(this) == ViewCompat.LAYOUT_DIRECTION_RTL;
-    return fabAlignmentMode == FAB_ALIGNMENT_MODE_END
-        ? (getMeasuredWidth() / 2 - fabOffsetEndMode) * (isRtl ? -1 : 1)
-        : 0;
+    boolean isRtl = ViewUtils.isLayoutRtl(this);
+    if (fabAlignmentMode == FAB_ALIGNMENT_MODE_END) {
+      int systemEndInset = isRtl ? leftInset : rightInset;
+      int totalEndInset = fabOffsetEndMode + systemEndInset;
+      return (getMeasuredWidth() / 2 - totalEndInset) * (isRtl ? -1 : 1);
+    } else {
+      return 0;
+    }
   }
 
   private float getFabTranslationX() {
@@ -729,7 +761,11 @@ protected int getActionMenuViewTranslationX(
       @NonNull ActionMenuView actionMenuView,
       @FabAlignmentMode int fabAlignmentMode,
       boolean fabAttached) {
-    boolean isRtl = ViewCompat.getLayoutDirection(this) == ViewCompat.LAYOUT_DIRECTION_RTL;
+    if (fabAlignmentMode != FAB_ALIGNMENT_MODE_END || !fabAttached) {
+      return 0;
+    }
+
+    boolean isRtl = ViewUtils.isLayoutRtl(this);
     int toolbarLeftContentEnd = isRtl ? getMeasuredWidth() : 0;
 
     // Calculate the inner side of the Toolbar's Gravity.START contents.
@@ -748,10 +784,11 @@ protected int getActionMenuViewTranslationX(
       }
     }
 
-    int end = isRtl ? actionMenuView.getRight() : actionMenuView.getLeft();
-    int offset = toolbarLeftContentEnd - end;
+    int actionMenuViewStart = isRtl ? actionMenuView.getRight() : actionMenuView.getLeft();
+    int systemStartInset = isRtl ? rightInset : -leftInset;
+    int end = actionMenuViewStart + systemStartInset;
 
-    return fabAlignmentMode == FAB_ALIGNMENT_MODE_END && fabAttached ? offset : 0;
+    return toolbarLeftContentEnd - end;
   }
 
   private void cancelAnimations() {
@@ -838,6 +875,14 @@ private int getBottomInset() {
     return bottomInset;
   }
 
+  private int getRightInset() {
+    return rightInset;
+  }
+
+  private int getLeftInset() {
+    return leftInset;
+  }
+
   @Override
   public void setTitle(CharSequence title) {
     // Don't do anything. BottomAppBar can't have a title.
@@ -927,6 +972,14 @@ public void onLayoutChange(
               // Should be moved above the bottom insets with space ignoring any shadow padding.
               int minBottomMargin = bottomMargin - bottomShadowPadding;
               fabLayoutParams.bottomMargin = child.getBottomInset() + minBottomMargin;
+              fabLayoutParams.leftMargin = child.getLeftInset();
+              fabLayoutParams.rightMargin = child.getRightInset();
+              boolean isRtl =  ViewUtils.isLayoutRtl(fab);
+              if (isRtl) {
+                fabLayoutParams.leftMargin += child.fabOffsetEndMode;
+              } else {
+                fabLayoutParams.rightMargin += child.fabOffsetEndMode;
+              }
             }
           }
         };

lib/java/com/google/android/material/bottomappbar/res/values/attrs.xml

@@ -44,6 +44,10 @@
     <attr name="hideOnScroll" format="boolean"/>
     <!-- Whether the BottomAppBar should apply padding to be above the bottom window insets. -->
     <attr name="paddingBottomSystemWindowInsets"/>
+    <!-- Whether the BottomAppBar should apply padding to be to the right of the left window insets. -->
+    <attr name="paddingLeftSystemWindowInsets"/>
+    <!-- Whether the BottomAppBar should apply padding to be to the left of the right window insets. -->
+    <attr name="paddingRightSystemWindowInsets"/>
   </declare-styleable>
 
   <!-- Style to use for BottomAppBar in this theme. -->

lib/java/com/google/android/material/bottomappbar/res/values/styles.xml

@@ -28,6 +28,8 @@
     <item name="maxButtonHeight">@dimen/mtrl_bottomappbar_height</item>
     <item name="elevation">8dp</item>
     <item name="paddingBottomSystemWindowInsets">true</item>
+    <item name="paddingLeftSystemWindowInsets">true</item>
+    <item name="paddingRightSystemWindowInsets">true</item>
   </style>
 
   <style name="Widget.MaterialComponents.BottomAppBar.Colored" parent="Widget.MaterialComponents.BottomAppBar">

lib/java/com/google/android/material/internal/ViewUtils.java

@@ -162,6 +162,10 @@ public static void doOnApplyWindowInsets(
 
     final boolean paddingBottomSystemWindowInsets =
         a.getBoolean(R.styleable.Insets_paddingBottomSystemWindowInsets, false);
+    final boolean paddingLeftSystemWindowInsets =
+        a.getBoolean(R.styleable.Insets_paddingLeftSystemWindowInsets, false);
+    final boolean paddingRightSystemWindowInsets =
+        a.getBoolean(R.styleable.Insets_paddingRightSystemWindowInsets, false);
 
     a.recycle();
 
@@ -177,6 +181,21 @@ public WindowInsetsCompat onApplyWindowInsets(
             if (paddingBottomSystemWindowInsets) {
               initialPadding.bottom += insets.getSystemWindowInsetBottom();
             }
+            boolean isRtl = isLayoutRtl(view);
+            if (paddingLeftSystemWindowInsets) {
+              if (isRtl) {
+                initialPadding.end += insets.getSystemWindowInsetLeft();
+              } else {
+                initialPadding.start += insets.getSystemWindowInsetLeft();
+              }
+            }
+            if (paddingRightSystemWindowInsets) {
+              if (isRtl) {
+                initialPadding.start += insets.getSystemWindowInsetRight();
+              } else {
+                initialPadding.end += insets.getSystemWindowInsetRight();
+              }
+            }
             initialPadding.applyToView(view);
             return listener != null
                 ? listener.onApplyWindowInsets(view, insets, initialPadding)

lib/java/com/google/android/material/internal/res-public/values/public.xml

@@ -18,5 +18,7 @@
   <public name="enforceMaterialTheme" type="attr"/>
   <public name="insetForeground" type="attr"/>
   <public name="paddingBottomSystemWindowInsets" type="attr"/>
+  <public name="paddingLeftSystemWindowInsets" type="attr"/>
+  <public name="paddingRightSystemWindowInsets" type="attr"/>
   <public name="Widget.Design.ScrimInsetsFrameLayout" type="style"/>
 </resources>

lib/java/com/google/android/material/internal/res/values/attrs.xml

@@ -51,9 +51,11 @@
   </declare-styleable>
 
   <declare-styleable name="Insets">
-    <!-- Just adding the parameter that we need for now. We can add others if we need them, but
+    <!-- Just adding the parameters that we need for now. We can add others if we need them, but
          ideally we'll be able to use https://github.com/chrisbanes/insetter once it's ready. -->
     <attr name="paddingBottomSystemWindowInsets" format="boolean"/>
+    <attr name="paddingLeftSystemWindowInsets" format="boolean"/>
+    <attr name="paddingRightSystemWindowInsets" format="boolean"/>
   </declare-styleable>
 
 </resources>