[NavigationView] Add start/end scrim enable/disable methods

PiperOrigin-RevId: 666430643

Author: imhappi

docs/components/NavigationDrawer.md

@@ -322,9 +322,10 @@ Element        | Attribute                                             | Related
 
 ### Scrim attributes
 
-Element   | Attribute | Related method(s)                 | Default value
---------- | --------- | --------------------------------- | --------------------
-**Color** | N/A       | `setScrimColor` on `DrawerLayout` | Black at 60% opacity
+Element           | Attribute                                                                                                     | Related method(s)                                                                                                                                                                                                                                 | Default value
+----------------- | ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------
+**Color**         | N/A                                                                                                           | `setScrimColor` on `DrawerLayout`                                                                                                                                                                                                                 | Black at 60% opacity
+**Window Insets** | `app:topInsetScrimEnabled`<br/>`app:bottomScrimEnabled`<br/>`app:startScrimEnabled`<br/>`app:endScrimEnabled` | `setTopInsetScrimEnabled`<br/>`isTopInsetScrimEnabled`<br/>`setBottomInsetScrimEnabled`<br/>`isBottomInsetScrimEnabled`<br/>`setStartInsetScrimEnabled`<br/>`isStartInsetScrimEnabled`<br/>`setEndInsetScrimEnabled`<br/>`isEndInsetScrimEnabled` | true
 
 ### `NavigationView` styles
 

lib/java/com/google/android/material/navigation/NavigationView.java

@@ -142,6 +142,8 @@ public class NavigationView extends ScrimInsetsFrameLayout implements MaterialBa
   private OnGlobalLayoutListener onGlobalLayoutListener;
   private boolean topInsetScrimEnabled = true;
   private boolean bottomInsetScrimEnabled = true;
+  private boolean startInsetScrimEnabled = true;
+  private boolean endInsetScrimEnabled = true;
 
   @Px private int drawerLayoutCornerSize = 0;
   private final boolean drawerLayoutCornerSizeBackAnimationEnabled;
@@ -328,6 +330,11 @@ public NavigationView(@NonNull Context context, @Nullable AttributeSet attrs, in
 
     setBottomInsetScrimEnabled(
         a.getBoolean(R.styleable.NavigationView_bottomInsetScrimEnabled, bottomInsetScrimEnabled));
+    setStartInsetScrimEnabled(
+        a.getBoolean(R.styleable.NavigationView_startInsetScrimEnabled, startInsetScrimEnabled));
+
+    setEndInsetScrimEnabled(
+        a.getBoolean(R.styleable.NavigationView_endInsetScrimEnabled, endInsetScrimEnabled));
 
     final int itemIconPadding =
         a.getDimensionPixelSize(R.styleable.NavigationView_itemIconPadding, 0);
@@ -933,6 +940,34 @@ public void setBottomInsetScrimEnabled(boolean enabled) {
     this.bottomInsetScrimEnabled = enabled;
   }
 
+  /** Whether or not the NavigationView will draw a scrim behind the window's start inset. */
+  public boolean isStartInsetScrimEnabled() {
+    return this.startInsetScrimEnabled;
+  }
+
+  /**
+   * Set whether or not the NavigationView should draw a scrim behind the window's start inset.
+   *
+   * @param enabled true when the NavigationView should draw a scrim.
+   */
+  public void setStartInsetScrimEnabled(boolean enabled) {
+    this.startInsetScrimEnabled = enabled;
+  }
+
+  /** Whether or not the NavigationView will draw a scrim behind the window's end inset. */
+  public boolean isEndInsetScrimEnabled() {
+    return this.endInsetScrimEnabled;
+  }
+
+  /**
+   * Set whether or not the NavigationView should draw a scrim behind the window's end inset.
+   *
+   * @param enabled true when the NavigationView should draw a scrim.
+   */
+  public void setEndInsetScrimEnabled(boolean enabled) {
+    this.endInsetScrimEnabled = enabled;
+  }
+
   /**
    * Get the distance between the start edge of the NavigationView and the start of a menu divider.
    */
@@ -1087,10 +1122,12 @@ public void onGlobalLayout() {
             presenter.setBehindStatusBar(isBehindStatusBar);
             setDrawTopInsetForeground(isBehindStatusBar && isTopInsetScrimEnabled());
 
+            boolean isRtl = getLayoutDirection() == LAYOUT_DIRECTION_RTL;
             // The navigation view could be left aligned or just hidden out of view in a drawer
             // layout when the global layout listener is called.
             boolean isOnLeftSide = (tmpLocation[0] == 0) || (tmpLocation[0] + getWidth() == 0);
-            setDrawLeftInsetForeground(isOnLeftSide);
+            setDrawLeftInsetForeground(
+                isOnLeftSide && (isRtl ? isEndInsetScrimEnabled() : isStartInsetScrimEnabled()));
 
             Activity activity = ContextUtils.getActivity(getContext());
             if (activity != null && VERSION.SDK_INT >= VERSION_CODES.LOLLIPOP) {
@@ -1108,7 +1145,8 @@ public void onGlobalLayout() {
                   (displayBounds.width() == tmpLocation[0])
                       || (displayBounds.width() - getWidth() == tmpLocation[0]);
 
-              setDrawRightInsetForeground(isOnRightSide);
+              setDrawRightInsetForeground(
+                  isOnRightSide && (isRtl ? isStartInsetScrimEnabled() : isEndInsetScrimEnabled()));
             }
           }
         };

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

@@ -39,6 +39,8 @@
   <public name="labelVisibilityMode" type="attr"/>
   <public name="topInsetScrimEnabled" type="attr"/>
   <public name="bottomInsetScrimEnabled" type="attr"/>
+  <public name="startInsetScrimEnabled" type="attr"/>
+  <public name="endInsetScrimEnabled" type="attr"/>
   <public name="menu" type="attr"/>
   <public name="subheaderColor" type="attr"/>
   <public name="subheaderTextAppearance" type="attr"/>

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

@@ -199,6 +199,12 @@
     <!-- Whether or not the navigation view should draw a scrim behind the bottom window
          inset, usually the navigation area, when drawing edge to edge. -->
     <attr name="bottomInsetScrimEnabled" format="boolean"/>
+    <!-- Whether or not the navigation view should draw a scrim behind the start window
+     inset when drawing edge to edge. -->
+    <attr name="startInsetScrimEnabled" format="boolean"/>
+    <!-- Whether or not the navigation view should draw a scrim behind the end window
+         inset when drawing edge to edge. -->
+    <attr name="endInsetScrimEnabled" format="boolean"/>
     <!-- The distance between the start of the navigation view container and a menu divider. -->
     <attr name="dividerInsetStart"/>
     <!-- The distance between the end of the navigation view container and a menu divider. -->