SESL Material/com.google.android.material.search/SearchView

SearchView

open class SearchView : FrameLayout, CoordinatorLayout.AttachedBehavior, MaterialBackHandler

Layout that provides a full screen search view and can be used with SearchBar.

The example below shows how to use the SearchBar and SearchView together:

<androidx.coordinatorlayout.widget.CoordinatorLayout
    android:layout_width="match_parent"
    android:layout_height="match_parent">

  <!-- NestedScrollingChild goes here (NestedScrollView, RecyclerView, etc.). -->
  <androidx.core.widget.NestedScrollView
      android:layout_width="match_parent"
      android:layout_height="match_parent"
      app:layout_behavior="@string/searchbar_scrolling_view_behavior">
    <!-- Screen content goes here. -->
  </androidx.core.widget.NestedScrollView>

  <com.google.android.material.appbar.AppBarLayout
      android:layout_width="match_parent"
      android:layout_height="wrap_content">
    <com.google.android.material.search.SearchBar
        android:id="@+id/search_bar"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:hint="@string/searchbar_hint" />
  </com.google.android.material.appbar.AppBarLayout>

  <com.google.android.material.search.SearchView
      android:layout_width="match_parent"
      android:layout_height="match_parent"
      android:hint="@string/searchbar_hint"
      app:layout_anchor="@id/search_bar">
    <!-- Search suggestions/results go here (ScrollView, RecyclerView, etc.). -->
  </com.google.android.material.search.SearchView>
</androidx.coordinatorlayout.widget.CoordinatorLayout>

For more information, see the component developer guidance and design guidelines.

Constructors

SearchView

constructor(@NonNull context: Context)

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)

constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int)

Types

Behavior

open class Behavior : CoordinatorLayout.Behavior<V>

Behavior that sets up an SearchView with an SearchBar.

TransitionListener

interface TransitionListener

Callback interface that provides important transition events for a SearchView.

TransitionState

enum TransitionState

Enum that defines the possible transition states of an SearchView.

Properties

currentTransitionState

@NonNull

@get:NonNull

open val currentTransitionState: SearchView.TransitionState

editText

@get:NonNull

val editText: EditText

searchPrefix

@get:NonNull

val searchPrefix: TextView

softInputMode

open val softInputMode: Int

Functions

addHeaderView

open fun addHeaderView(@NonNull headerView: View)

Add a header view to this SearchView, which will be placed above the search text area.

addTransitionListener

open fun addTransitionListener(@NonNull transitionListener: SearchView.TransitionListener)

Adds a listener to handle SearchView transitions such as showing and closing.

addView

open fun addView(child: View, index: Int, params: ViewGroup.LayoutParams)

cancelBackProgress

open fun cancelBackProgress()

Call this method from onBackCancelled or handleOnBackCancelled so that the back handler can cancel the back animation.

clearFocusAndHideKeyboard

open fun clearFocusAndHideKeyboard()

Clears focus on the main EditText and hides the soft keyboard.

clearText

open fun clearText()

Clears the text of main EditText.

getBehavior

@NonNull

open fun getBehavior(): CoordinatorLayout.Behavior<SearchView>

getHint

@Nullable

open fun getHint(): CharSequence

Returns the hint of main EditText.

getSearchPrefixText

@Nullable

open fun getSearchPrefixText(): CharSequence

Returns the search prefix text.

getText

@NonNull

open fun getText(): Editable

Returns the text of main EditText, which usually represents the search text.

getToolbar

@NonNull

open fun getToolbar(): Toolbar

Returns the Toolbar used by the SearchView.

handleBackInvoked

open fun handleBackInvoked()

Call this method from onBackInvoked or handleOnBackPressed so that the back handler can complete the back animation, or handle back without progress in certain cases.

hide

open fun hide()

Hides the SearchView with an animation.

inflateMenu

open fun inflateMenu(@MenuRes menuResId: Int)

Inflate a menu to provide additional options.

isAnimatedNavigationIcon

open fun isAnimatedNavigationIcon(): Boolean

Returns whether the navigation icon should be animated from the SearchBar to .

isAutoShowKeyboard

open fun isAutoShowKeyboard(): Boolean

Returns whether the soft keyboard should be shown when the SearchView is shown.

isMenuItemsAnimated

open fun isMenuItemsAnimated(): Boolean

Returns whether the menu items should be animated from the SearchBar to .

isSetupWithSearchBar

open fun isSetupWithSearchBar(): Boolean

Returns whether or not this SearchView is set up with an SearchBar.

isShowing

open fun isShowing(): Boolean

Returns whether the SearchView's main content view is shown or showing.

isUseWindowInsetsController

@RestrictTo(value = LIBRARY_GROUP)

open fun isUseWindowInsetsController(): Boolean

Returns whether the soft keyboard should be shown with WindowInsetsController.

removeAllHeaderViews

open fun removeAllHeaderViews()

Remove all header views from the section above the search text area.

removeHeaderView

open fun removeHeaderView(@NonNull headerView: View)

Remove a header view from the section above the search text area.

removeTransitionListener

open fun removeTransitionListener(@NonNull transitionListener: SearchView.TransitionListener)

Removes a listener to handle SearchView transitions such as showing and closing.

requestFocusAndShowKeyboard

open fun requestFocusAndShowKeyboard()

Requests focus on the main EditText and shows the soft keyboard.

setAnimatedNavigationIcon

open fun setAnimatedNavigationIcon(animatedNavigationIcon: Boolean)

Sets whether the navigation icon should be animated from the SearchBar to .

setAutoShowKeyboard

open fun setAutoShowKeyboard(autoShowKeyboard: Boolean)

Sets whether the soft keyboard should be shown when the SearchView is shown.

setElevation

@RequiresApi(value = VERSION_CODES.LOLLIPOP)

open fun setElevation(elevation: Float)

setHint

open fun setHint(@StringRes hintResId: Int)

open fun setHint(@Nullable hint: CharSequence)

Sets the hint of main EditText.

setMenuItemsAnimated

open fun setMenuItemsAnimated(menuItemsAnimated: Boolean)

Sets whether the menu items should be animated from the SearchBar to .

setModalForAccessibility

open fun setModalForAccessibility(isSearchViewModal: Boolean)

Sets whether the SearchView is modal for accessibility, i.e.

setOnMenuItemClickListener

open fun setOnMenuItemClickListener(@Nullable onMenuItemClickListener: Toolbar.OnMenuItemClickListener)

Set a listener to handle menu item clicks.

setSearchPrefixText

open fun setSearchPrefixText(@Nullable searchPrefixText: CharSequence)

Sets the search prefix text.

setStatusBarSpacerEnabled

@RestrictTo(value = LIBRARY_GROUP)

open fun setStatusBarSpacerEnabled(enabled: Boolean)

Enables/disables the status bar spacer, which can be used in cases where the status bar is translucent and the SearchView should not overlap the status bar area.

setText