[Bottom Sheet] Animate bottom sheet position when keyboard is shown using WindowInsetsAnimationCompat API

Note: android:windowSoftInputMode="adjustResize" is required in order for inset animation API to propagate the correct values, otherwise this is a no-op. This change also updates the M3 modal Bottom Sheet themes / theme overlays to use adjustResize by default (can still be overridden by the client).
PiperOrigin-RevId: 508351766

Author: dsn5ft

catalog/java/io/material/catalog/AndroidManifest.xml

@@ -35,7 +35,8 @@
 
     <activity
       android:name=".main.MainActivity"
-      android:exported="true">
+      android:exported="true"
+      android:windowSoftInputMode="adjustResize">
       <intent-filter>
         <action android:name="android.intent.action.MAIN"/>
         <category android:name="android.intent.category.LAUNCHER"/>

catalog/java/io/material/catalog/bottomsheet/res/layout/cat_bottomsheet_content.xml

@@ -35,11 +35,25 @@
         android:layout_marginTop="16dp"
         android:layout_centerHorizontal="true"/>
 
+    <com.google.android.material.textfield.TextInputLayout
+      android:id="@+id/bottomsheet_textinputlayout"
+      android:layout_width="@dimen/material_textinput_default_width"
+      android:layout_height="wrap_content"
+      android:layout_below="@id/bottomsheet_state"
+      android:layout_centerHorizontal="true"
+      android:layout_margin="16dp"
+      android:layout_gravity="center_horizontal"
+      android:hint="@string/cat_bottomsheet_textfield_label">
+      <com.google.android.material.textfield.TextInputEditText
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"/>
+    </com.google.android.material.textfield.TextInputLayout>
+
     <Button
         android:id="@+id/cat_bottomsheet_modal_button"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
-        android:layout_below="@id/bottomsheet_state"
+        android:layout_below="@id/bottomsheet_textinputlayout"
         android:layout_centerHorizontal="true"
         android:text="@string/cat_bottomsheet_button_label_enabled"/>
 

catalog/java/io/material/catalog/bottomsheet/res/layout/cat_bottomsheet_fragment.xml

@@ -91,11 +91,25 @@
         android:textColor="?attr/colorOnSurface"
         android:textSize="18sp"/>
 
+    <com.google.android.material.textfield.TextInputLayout
+      android:id="@+id/cat_persistent_bottomsheet_textinputlayout"
+      android:layout_width="@dimen/material_textinput_default_width"
+      android:layout_height="wrap_content"
+      android:layout_below="@id/cat_persistent_bottomsheet_state"
+      android:layout_centerHorizontal="true"
+      android:layout_margin="16dp"
+      android:layout_gravity="center_horizontal"
+      android:hint="@string/cat_bottomsheet_textfield_label">
+      <com.google.android.material.textfield.TextInputEditText
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"/>
+    </com.google.android.material.textfield.TextInputLayout>
+
     <Button
         android:id="@+id/cat_bottomsheet_button"
         android:layout_width="wrap_content"
         android:layout_height="wrap_content"
-        android:layout_below="@id/cat_persistent_bottomsheet_state"
+        android:layout_below="@id/cat_persistent_bottomsheet_textinputlayout"
         android:layout_centerHorizontal="true"
         android:text="@string/cat_bottomsheet_button_label_enabled"/>
 

catalog/java/io/material/catalog/bottomsheet/res/values/strings.xml

@@ -44,6 +44,11 @@
   <string name="cat_bottomsheet_persistent">
     Persistent Bottomsheet
   </string>
+
+  <string name="cat_bottomsheet_textfield_label"
+          description="The label for the bottom sheet text field. [CHAR_LIMIT=100]">
+    Label
+  </string>
   <string name="cat_bottomsheet_button_label_enabled">Enabled</string>
   <string name="cat_bottomsheet_button_label_disabled">Disabled</string>
   <string name="cat_bottomsheet_button_clicked">Button clicked</string>

lib/java/com/google/android/material/bottomsheet/BottomSheetBehavior.java

@@ -529,6 +529,7 @@ public boolean onLayoutChild(
       peekHeightMin =
           parent.getResources().getDimensionPixelSize(R.dimen.design_bottom_sheet_peek_height_min);
       setWindowInsetsListener(child);
+      ViewCompat.setWindowInsetsAnimationCallback(child, new InsetsAnimationCallback(child));
       viewRef = new WeakReference<>(child);
       // Only set MaterialShapeDrawable as background if shapeTheming is enabled, otherwise will
       // default to android:background declared in styles or layout.

lib/java/com/google/android/material/bottomsheet/InsetsAnimationCallback.java

@@ -0,0 +1,83 @@
+/*
+ * Copyright (C) 2023 The Android Open Source Project
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.android.material.bottomsheet;
+
+import android.view.View;
+import androidx.annotation.NonNull;
+import androidx.core.view.WindowInsetsAnimationCompat;
+import androidx.core.view.WindowInsetsAnimationCompat.BoundsCompat;
+import androidx.core.view.WindowInsetsCompat;
+import com.google.android.material.animation.AnimationUtils;
+import java.util.List;
+
+class InsetsAnimationCallback extends WindowInsetsAnimationCompat.Callback {
+
+  private final View view;
+
+  private int startY;
+  private int startTranslationY;
+
+  private final int[] tmpLocation = new int[2];
+
+  public InsetsAnimationCallback(View view) {
+    super(DISPATCH_MODE_STOP);
+    this.view = view;
+  }
+
+  @Override
+  public void onPrepare(@NonNull WindowInsetsAnimationCompat windowInsetsAnimationCompat) {
+    view.getLocationOnScreen(tmpLocation);
+    startY = tmpLocation[1];
+  }
+
+  @NonNull
+  @Override
+  public BoundsCompat onStart(
+      @NonNull WindowInsetsAnimationCompat windowInsetsAnimationCompat,
+      @NonNull BoundsCompat boundsCompat) {
+    view.getLocationOnScreen(tmpLocation);
+    int endY = tmpLocation[1];
+    startTranslationY = startY - endY;
+
+    // Move the view back to its original position before the insets were applied.
+    view.setTranslationY(startTranslationY);
+
+    return boundsCompat;
+  }
+
+  @NonNull
+  @Override
+  public WindowInsetsCompat onProgress(
+      @NonNull WindowInsetsCompat insets,
+      @NonNull List<WindowInsetsAnimationCompat> animationList) {
+    for (WindowInsetsAnimationCompat animation : animationList) {
+      if ((animation.getTypeMask() & WindowInsetsCompat.Type.ime()) != 0) {
+        // Move the view to match the animated position of the keyboard.
+        float translationY =
+            AnimationUtils.lerp(startTranslationY, 0, animation.getInterpolatedFraction());
+        view.setTranslationY(translationY);
+        break;
+      }
+    }
+    return insets;
+  }
+
+  @Override
+  public void onEnd(@NonNull WindowInsetsAnimationCompat windowInsetsAnimationCompat) {
+    view.setTranslationY(0f);
+  }
+}

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

@@ -17,20 +17,23 @@
 <resources>
   <style name="Base.V14.Theme.Material3.Light.BottomSheetDialog" parent="Theme.Material3.Light.Dialog">
     <item name="android:windowIsFloating">false</item>
+    <item name="android:windowSoftInputMode">adjustResize</item>
     <item name="android:windowBackground">@android:color/transparent</item>
     <item name="android:windowAnimationStyle">@style/Animation.Material3.BottomSheetDialog</item>
     <item name="bottomSheetStyle">@style/Widget.Material3.BottomSheet.Modal</item>
   </style>
 
   <style name="Base.V14.Theme.Material3.Dark.BottomSheetDialog" parent="Theme.Material3.Dark.Dialog">
     <item name="android:windowIsFloating">false</item>
+    <item name="android:windowSoftInputMode">adjustResize</item>
     <item name="android:windowBackground">@android:color/transparent</item>
     <item name="android:windowAnimationStyle">@style/Animation.Material3.BottomSheetDialog</item>
     <item name="bottomSheetStyle">@style/Widget.Material3.BottomSheet.Modal</item>
   </style>
 
   <style name="Base.V14.ThemeOverlay.Material3.BottomSheetDialog" parent="Base.ThemeOverlay.Material3.Dialog">
     <item name="android:windowIsFloating">false</item>
+    <item name="android:windowSoftInputMode">adjustResize</item>
     <item name="android:windowBackground">@android:color/transparent</item>
     <item name="android:windowAnimationStyle">@style/Animation.Material3.BottomSheetDialog</item>
     <item name="bottomSheetStyle">@style/Widget.Material3.BottomSheet.Modal</item>