[ExposedDropdownMenu][A11y] Add keyboard support for dropdown menus

PiperOrigin-RevId: 788007779

Author: Material Design Team

lib/java/com/google/android/material/textfield/MaterialAutoCompleteTextView.java

@@ -33,8 +33,8 @@
 import androidx.appcompat.widget.ListPopupWindow;
 import android.text.InputType;
 import android.util.AttributeSet;
+import android.view.KeyEvent;
 import android.view.View;
-import android.view.View.MeasureSpec;
 import android.view.ViewGroup;
 import android.view.ViewGroup.LayoutParams;
 import android.view.ViewParent;
@@ -51,6 +51,7 @@
 import androidx.annotation.LayoutRes;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+import androidx.annotation.VisibleForTesting;
 import com.google.android.material.color.MaterialColors;
 import com.google.android.material.internal.ManufacturerUtils;
 import com.google.android.material.internal.ThemeEnforcement;
@@ -201,6 +202,43 @@ public void dismissDropDown() {
     }
   }
 
+  @Override
+  public boolean onKeyDown(int keyCode, @NonNull KeyEvent event) {
+    if (shouldShowPopup(keyCode)) {
+      TextInputLayout textInputLayout = findTextInputLayoutAncestor();
+      if (textInputLayout != null) {
+        // A click on the end icon will show the dropdown and animate the icon
+        // Note that View.performClick() is a programmatic action that works even if the view is
+        // not clickable.
+        textInputLayout.getEndIconView().performClick();
+      }
+      return true;
+    }
+    return super.onKeyDown(keyCode, event);
+  }
+
+  /**
+   * Determines whether the dropdown should be shown based on the key press.
+   *
+   * <p>If the view is editable and single-line, the dropdown is shown only for the Enter or D-pad
+   * Center keys.
+   *
+   * <p>If the view is not editable, the dropdown is shown if the user presses the Enter, D-pad
+   * Center, or Space keys.
+   */
+  @VisibleForTesting
+  boolean shouldShowPopup(int keyCode) {
+    boolean isEnterKey =
+        keyCode == KeyEvent.KEYCODE_ENTER || keyCode == KeyEvent.KEYCODE_DPAD_CENTER;
+    boolean isSpaceKey = keyCode == KeyEvent.KEYCODE_SPACE;
+    boolean isEditable = getKeyListener() != null;
+    if (isEditable) {
+      return isEnterKey && getMaxLines() == 1;
+    } else {
+      return isEnterKey || isSpaceKey;
+    }
+  }
+
   @Override
   public void onWindowFocusChanged(boolean hasWindowFocus) {
     if (isPopupRequired()) {

lib/java/com/google/android/material/textfield/TextInputLayout.java

@@ -24,7 +24,6 @@
 import static com.google.android.material.theme.overlay.MaterialThemeOverlay.wrap;
 
 import android.animation.ValueAnimator;
-import android.annotation.TargetApi;
 import android.content.Context;
 import android.content.res.ColorStateList;
 import android.content.res.Configuration;
@@ -1465,7 +1464,7 @@ public LengthCounter getLengthCounter() {
   }
 
   @Override
-  @TargetApi(VERSION_CODES.O)
+  @RequiresApi(VERSION_CODES.O)
   public void dispatchProvideAutofillStructure(@NonNull ViewStructure structure, int flags) {
     if (editText == null) {
       super.dispatchProvideAutofillStructure(structure, flags);
@@ -4524,6 +4523,19 @@ void updateTextInputBoxState() {
     }
 
     applyBoxAttributes();
+
+    if (getEndIconMode() == END_ICON_DROPDOWN_MENU) {
+      if (editText instanceof AutoCompleteTextView && !isEditable(editText)) {
+        // For non-editable dropdowns, the end icon is not clickable and focusable, because the
+        // whole field is a single touch target. The dropdown can be toggled programmatically by
+        // calling performClick() on the end icon.
+        getEndIconView().setFocusable(false);
+        getEndIconView().setClickable(false);
+      } else {
+        getEndIconView().setFocusable(true);
+        getEndIconView().setClickable(true);
+      }
+    }
   }
 
   private boolean isOnError() {

tests/javatests/com/google/android/material/testutils/EditTextActions.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2025 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.testutils;
+
+import static androidx.test.espresso.matcher.ViewMatchers.isAssignableFrom;
+
+import android.view.View;
+import android.widget.EditText;
+import android.widget.TextView;
+import androidx.test.espresso.UiController;
+import androidx.test.espresso.ViewAction;
+import org.hamcrest.Matcher;
+
+public class EditTextActions {
+
+  private EditTextActions() {}
+
+  public static ViewAction setSingleLine(final boolean isSingleLine) {
+    return new ViewAction() {
+      @Override
+      public Matcher<View> getConstraints() {
+        return isAssignableFrom(TextView.class);
+      }
+
+      @Override
+      public String getDescription() {
+        return "Sets the single line";
+      }
+
+      @Override
+      public void perform(UiController uiController, View view) {
+        EditText editText = (EditText) view;
+        editText.setSingleLine(isSingleLine);
+      }
+    };
+  }
+}

tests/javatests/com/google/android/material/textfield/ExposedDropdownMenuTest.java

@@ -19,13 +19,16 @@
 import static androidx.test.espresso.accessibility.AccessibilityChecks.accessibilityAssertion;
 import static androidx.test.espresso.action.ViewActions.clearText;
 import static androidx.test.espresso.action.ViewActions.click;
+import static androidx.test.espresso.action.ViewActions.pressKey;
 import static androidx.test.espresso.action.ViewActions.typeText;
 import static androidx.test.espresso.action.ViewActions.typeTextIntoFocusedView;
 import static androidx.test.espresso.assertion.ViewAssertions.matches;
 import static androidx.test.espresso.matcher.ViewMatchers.isDescendantOfA;
 import static androidx.test.espresso.matcher.ViewMatchers.isRoot;
 import static androidx.test.espresso.matcher.ViewMatchers.withContentDescription;
 import static androidx.test.espresso.matcher.ViewMatchers.withId;
+import static com.google.android.material.testutils.EditTextActions.setSingleLine;
+import static com.google.android.material.testutils.TestUtilsActions.requestFocus;
 import static com.google.android.material.testutils.TestUtilsActions.waitFor;
 import static com.google.android.material.testutils.TextInputLayoutActions.clickIcon;
 import static com.google.android.material.testutils.TextInputLayoutActions.setInputType;
@@ -45,6 +48,7 @@
 import android.graphics.drawable.Drawable;
 import android.graphics.drawable.LayerDrawable;
 import android.text.InputType;
+import android.view.KeyEvent;
 import android.widget.AutoCompleteTextView;
 import androidx.test.filters.MediumTest;
 import androidx.test.rule.ActivityTestRule;
@@ -65,6 +69,7 @@ public class ExposedDropdownMenuTest {
   public final ActivityTestRule<ExposedDropdownMenuActivity> activityTestRule =
       new ActivityTestRule<>(ExposedDropdownMenuActivity.class);
 
+
   @Test
   public void testMenuIsNonEditableWithInputTypeNone() {
     final Activity activity = activityTestRule.getActivity();
@@ -238,4 +243,150 @@ public void testEndIconIsAccessible() {
         isDescendantOfA(withId(R.id.filled_dropdown))))
         .check(accessibilityAssertion());
   }
+
+  @Test
+  public void testOnKeyDown_enterOnNonEditableField_showsDropDown() {
+    final Activity activity = activityTestRule.getActivity();
+    final AutoCompleteTextView editText = activity.findViewById(R.id.edittext_filled);
+
+    onView(withId(R.id.edittext_filled)).perform(requestFocus());
+    onView(withId(R.id.edittext_filled)).perform(pressKey(KeyEvent.KEYCODE_ENTER));
+    onView(withId(R.id.filled_dropdown)).perform(skipAnimations());
+
+    assertThat(editText.isPopupShowing(), is(true));
+  }
+
+  @Test
+  public void testOnKeyDown_spaceOnNonEditableField_showsDropDown() {
+    final Activity activity = activityTestRule.getActivity();
+    final AutoCompleteTextView editText = activity.findViewById(R.id.edittext_filled);
+
+    onView(withId(R.id.edittext_filled)).perform(requestFocus());
+    onView(withId(R.id.edittext_filled)).perform(pressKey(KeyEvent.KEYCODE_SPACE));
+    onView(withId(R.id.filled_dropdown)).perform(skipAnimations());
+
+    assertThat(editText.isPopupShowing(), is(true));
+  }
+
+  @Test
+  public void testOnKeyDown_enterOnNonEditableField_hidesDropDown() {
+    final Activity activity = activityTestRule.getActivity();
+    final AutoCompleteTextView editText = activity.findViewById(R.id.edittext_filled);
+
+    onView(withId(R.id.filled_dropdown)).perform(click());
+    onView(withId(R.id.filled_dropdown)).perform(skipAnimations());
+
+    onView(withId(R.id.edittext_filled)).perform(requestFocus());
+    onView(withId(R.id.edittext_filled)).perform(pressKey(KeyEvent.KEYCODE_ENTER));
+    onView(withId(R.id.filled_dropdown)).perform(skipAnimations());
+
+    assertThat(editText.isPopupShowing(), is(false));
+  }
+
+  @Test
+  public void testOnKeyDown_spaceOnNonEditableField_hidesDropDown() {
+    final Activity activity = activityTestRule.getActivity();
+    final AutoCompleteTextView editText = activity.findViewById(R.id.edittext_filled);
+
+    onView(withId(R.id.filled_dropdown)).perform(click());
+    onView(withId(R.id.filled_dropdown)).perform(skipAnimations());
+
+    onView(withId(R.id.edittext_filled)).perform(requestFocus());
+    onView(withId(R.id.edittext_filled)).perform(pressKey(KeyEvent.KEYCODE_SPACE));
+    onView(withId(R.id.filled_dropdown)).perform(skipAnimations());
+
+    assertThat(editText.isPopupShowing(), is(false));
+  }
+
+  @Test
+  public void testOnKeyDown_enterOnEditableMultiLineField_doesNotShowDropDown() {
+    final Activity activity = activityTestRule.getActivity();
+    final AutoCompleteTextView editText = activity.findViewById(R.id.edittext_filled_editable);
+
+    onView(withId(R.id.edittext_filled_editable)).perform(requestFocus());
+    onView(withId(R.id.edittext_filled_editable)).perform(pressKey(KeyEvent.KEYCODE_ENTER));
+    onView(withId(R.id.filled_editable_dropdown)).perform(skipAnimations());
+
+    assertThat(editText.isPopupShowing(), is(false));
+  }
+
+  @Test
+  public void testOnKeyDown_enterOnEditableSingleLineField_showsDropDown() {
+    final Activity activity = activityTestRule.getActivity();
+    final AutoCompleteTextView editText = activity.findViewById(R.id.edittext_filled_editable);
+
+    onView(withId(R.id.edittext_filled_editable)).perform(setSingleLine(true));
+
+    onView(withId(R.id.edittext_filled_editable)).perform(requestFocus());
+    onView(withId(R.id.edittext_filled_editable)).perform(pressKey(KeyEvent.KEYCODE_ENTER));
+    onView(withId(R.id.filled_editable_dropdown)).perform(skipAnimations());
+
+    assertThat(editText.isPopupShowing(), is(true));
+  }
+
+  @Test
+  public void testOnKeyDown_enterOnEditableSingleLineField_hidesDropDown() {
+    final Activity activity = activityTestRule.getActivity();
+    final AutoCompleteTextView editText = activity.findViewById(R.id.edittext_filled_editable);
+
+    onView(withId(R.id.edittext_filled_editable)).perform(setSingleLine(true));
+
+    onView(withId(R.id.filled_editable_dropdown)).perform(click());
+    onView(withId(R.id.filled_editable_dropdown)).perform(skipAnimations());
+
+    onView(withId(R.id.edittext_filled_editable)).perform(requestFocus());
+    onView(withId(R.id.edittext_filled_editable)).perform(pressKey(KeyEvent.KEYCODE_ENTER));
+    onView(withId(R.id.filled_editable_dropdown)).perform(skipAnimations());
+
+    assertThat(editText.isPopupShowing(), is(false));
+  }
+
+  @Test
+  public void testOnKeyDown_spaceOnEditableField_doesNotShowDropDown() {
+    final Activity activity = activityTestRule.getActivity();
+    final AutoCompleteTextView editText = activity.findViewById(R.id.edittext_filled_editable);
+
+    onView(withId(R.id.edittext_filled_editable)).perform(requestFocus());
+    onView(withId(R.id.edittext_filled_editable)).perform(pressKey(KeyEvent.KEYCODE_SPACE));
+    onView(withId(R.id.filled_editable_dropdown)).perform(skipAnimations());
+
+    assertThat(editText.isPopupShowing(), is(false));
+  }
+
+  @Test
+  public void shouldShowPopup_nonEditable_isTrueForEnterOrSpace() {
+    final Activity activity = activityTestRule.getActivity();
+    final MaterialAutoCompleteTextView nonEditable = activity.findViewById(R.id.edittext_filled);
+
+    assertThat(nonEditable.shouldShowPopup(KeyEvent.KEYCODE_ENTER), is(true));
+    assertThat(nonEditable.shouldShowPopup(KeyEvent.KEYCODE_DPAD_CENTER), is(true));
+    assertThat(nonEditable.shouldShowPopup(KeyEvent.KEYCODE_SPACE), is(true));
+    assertThat(nonEditable.shouldShowPopup(KeyEvent.KEYCODE_A), is(false));
+  }
+
+  @Test
+  public void shouldShowPopup_editableMultiLine_isFalse() {
+    final Activity activity = activityTestRule.getActivity();
+    final MaterialAutoCompleteTextView editable =
+        activity.findViewById(R.id.edittext_filled_editable);
+
+    onView(withId(R.id.edittext_filled_editable)).perform(setSingleLine(false));
+
+    assertThat(editable.shouldShowPopup(KeyEvent.KEYCODE_ENTER), is(false));
+    assertThat(editable.shouldShowPopup(KeyEvent.KEYCODE_DPAD_CENTER), is(false));
+    assertThat(editable.shouldShowPopup(KeyEvent.KEYCODE_SPACE), is(false));
+  }
+
+  @Test
+  public void shouldShowPopup_editableSingleLine_isTrueForEnter() {
+    final Activity activity = activityTestRule.getActivity();
+    final MaterialAutoCompleteTextView editable =
+        activity.findViewById(R.id.edittext_filled_editable);
+
+    onView(withId(R.id.edittext_filled_editable)).perform(setSingleLine(true));
+
+    assertThat(editable.shouldShowPopup(KeyEvent.KEYCODE_ENTER), is(true));
+    assertThat(editable.shouldShowPopup(KeyEvent.KEYCODE_DPAD_CENTER), is(true));
+    assertThat(editable.shouldShowPopup(KeyEvent.KEYCODE_SPACE), is(false));
+  }
 }

tests/javatests/com/google/android/material/textfield/TextInputLayoutTest.java

@@ -71,6 +71,7 @@
 import android.text.TextPaint;
 import android.util.SparseArray;
 import android.view.inputmethod.EditorInfo;
+import android.widget.AutoCompleteTextView;
 import android.widget.EditText;
 import android.widget.TextView;
 import androidx.annotation.ColorInt;
@@ -1032,6 +1033,35 @@ public void hintSetOnOuterLayout_propagateOuterHintToAutofillProvider() {
     assertEquals("Outer hint", editText.getHint().toString());
   }
 
+  @UiThreadTest
+  @Test
+  public void testDropdownMenu_nonEditable_endIconIsNotFocusableOrClickable() {
+    final Activity activity = activityTestRule.getActivity();
+    final TextInputLayout textInputLayout = activity.findViewById(R.id.textinput_noedittext);
+    final AutoCompleteTextView editText = new AutoCompleteTextView(activity);
+
+    textInputLayout.setEndIconMode(TextInputLayout.END_ICON_DROPDOWN_MENU);
+    editText.setKeyListener(null); // This makes the EditText not-editable
+    textInputLayout.addView(editText);
+
+    assertThat(textInputLayout.getEndIconView().isFocusable()).isFalse();
+    assertThat(textInputLayout.getEndIconView().isClickable()).isFalse();
+  }
+
+  @UiThreadTest
+  @Test
+  public void testDropdownMenu_editable_endIconIsFocusableAndClickable() {
+    final Activity activity = activityTestRule.getActivity();
+    final TextInputLayout textInputLayout = activity.findViewById(R.id.textinput_noedittext);
+    final AutoCompleteTextView editText = new AutoCompleteTextView(activity);
+
+    textInputLayout.setEndIconMode(TextInputLayout.END_ICON_DROPDOWN_MENU);
+    textInputLayout.addView(editText);
+
+    assertThat(textInputLayout.getEndIconView().isFocusable()).isTrue();
+    assertThat(textInputLayout.getEndIconView().isClickable()).isTrue();
+  }
+
   private static ViewAssertion isHintExpanded(final boolean expanded) {
     return (view, noViewFoundException) -> {
       assertTrue(view instanceof TextInputLayout);