1.12.0+1.0.31-sesl8+rev0

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

SearchBar

open class SearchBar : Toolbar

The SearchBar represents a floating search field with affordances for search and navigation.

Note: SearchBar does not support the setTitle and setSubtitle methods, or their corresponding xml attributes. Instead, use setHint or setText, or their corresponding xml attributes, to provide a text affordance for your .

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

constructor(@NonNull context: Context)

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

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

Types

OnLoadAnimationCallback

abstract class OnLoadAnimationCallback

Callback for the animation started and stopped via startOnLoadAnimation and stopOnLoadAnimation.

ScrollingViewBehavior

open class ScrollingViewBehavior : AppBarLayout.ScrollingViewBehavior

Behavior that sets up the scroll-away mode for an SearchBar.

Properties

open var centerView: View

val textView: TextView

Functions

addCollapseAnimationListener

open fun addCollapseAnimationListener(@NonNull listener: AnimatorListenerAdapter)

Adds a listener for the collapse animation started via collapse and collapse.

addExpandAnimationListener

open fun addExpandAnimationListener(@NonNull listener: AnimatorListenerAdapter)

Adds a listener for the expand animation started via expand and expand.

addOnLoadAnimationCallback

open fun addOnLoadAnimationCallback(@NonNull onLoadAnimationCallback: SearchBar.OnLoadAnimationCallback)

Registers a callback for the On Load Animation, started and stopped via startOnLoadAnimation and stopOnLoadAnimation.

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

open fun clearText()

Clears the text of main TextView.

@CanIgnoreReturnValue

open fun collapse(@NonNull expandedView: View): Boolean

@CanIgnoreReturnValue

open fun collapse(@NonNull expandedView: View, @Nullable appBarLayout: AppBarLayout): Boolean

@CanIgnoreReturnValue

open fun collapse(@NonNull expandedView: View, @Nullable appBarLayout: AppBarLayout, skipAnimation: Boolean): Boolean

Starts a collapse animation, if it's not already started, which transitions from the


expandedView

, e.g.

@CanIgnoreReturnValue

open fun expand(@NonNull expandedView: View): Boolean

@CanIgnoreReturnValue

open fun expand(@NonNull expandedView: View, @Nullable appBarLayout: AppBarLayout): Boolean

@CanIgnoreReturnValue

open fun expand(@NonNull expandedView: View, @Nullable appBarLayout: AppBarLayout, skipAnimation: Boolean): Boolean

Starts an expand animation, if it's not already started, which transitions from the to the expandedView, e.g.

open fun getCornerSize(): Float

Returns the size in pixels of the SearchBar corners.

open fun getHint(): CharSequence

Returns the hint of main TextView.

open fun getStrokeColor(): Int

Returns the color of the SearchBar outline stroke.

open fun getStrokeWidth(): Float

Returns the width in pixels of the SearchBar outline stroke.

open fun getText(): CharSequence

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

open fun inflateMenu(@MenuRes resId: Int)

open fun isCollapsing(): Boolean

Returns whether the collapse animation is running.

isDefaultScrollFlagsEnabled

open fun isDefaultScrollFlagsEnabled(): Boolean

Returns whether the default AppBarLayout scroll flags are enabled.

open fun isExpanding(): Boolean

Returns whether the expand animation is running.

isOnLoadAnimationFadeInEnabled

open fun isOnLoadAnimationFadeInEnabled(): Boolean

Returns whether the fade in part is enabled for the on load animation.

onInitializeAccessibilityNodeInfo

open fun onInitializeAccessibilityNodeInfo(info: AccessibilityNodeInfo)

removeCollapseAnimationListener

open fun removeCollapseAnimationListener(@NonNull listener: AnimatorListenerAdapter): Boolean

Removes a listener for the collapse animation started via collapse and collapse.

removeExpandAnimationListener

open fun removeExpandAnimationListener(@NonNull listener: AnimatorListenerAdapter): Boolean

Removes a listener for the expand animation started via expand and expand.

removeOnLoadAnimationCallback

open fun removeOnLoadAnimationCallback(@NonNull onLoadAnimationCallback: SearchBar.OnLoadAnimationCallback): Boolean

Unregisters a callback for the On Load Animation, started and stopped via startOnLoadAnimation and stopOnLoadAnimation.

setDefaultScrollFlagsEnabled

open fun setDefaultScrollFlagsEnabled(defaultScrollFlagsEnabled: Boolean)

Sets whether the default AppBarLayout scroll flags are enabled.

@RequiresApi(value = VERSION_CODES.LOLLIPOP)

open fun setElevation(elevation: Float)

open fun setHint(@StringRes hintResId: Int)

open fun setHint(@Nullable hint: CharSequence)

Sets the hint of main TextView.

setNavigationIcon

open fun setNavigationIcon(@Nullable navigationIcon: Drawable)

setNavigationOnClickListener

open fun setNavigationOnClickListener(listener: View.OnClickListener)

setOnLoadAnimationFadeInEnabled

open fun setOnLoadAnimationFadeInEnabled(onLoadAnimationFadeInEnabled: Boolean)

Sets whether the fade in part is enabled for the on load animation.

open fun setStrokeColor(@ColorInt strokeColor: Int)

Sets the color of the SearchBar outline stroke.

open fun setStrokeWidth(@Dimension strokeWidth: Float)

Sets the width in pixels of the SearchBar outline stroke.

open fun setSubtitle(subtitle: CharSequence)

SearchBar does not support the setSubtitle method, or its corresponding xml attribute.

open fun setText(@StringRes textResId: Int)

open fun setText(@Nullable text: CharSequence)

Sets the text of main TextView.

open fun setTitle(title: CharSequence)

SearchBar does not support the setTitle method, or its corresponding xml attribute.

startOnLoadAnimation

open fun startOnLoadAnimation()

Starts the on load animation which transitions from the center view to the hint .

stopOnLoadAnimation

open fun stopOnLoadAnimation()

Stops the on load animation which transitions from the center view to the hint .