SearchBarState

Artifact: androidx.compose.material3:material3

View Source

Added in 1.4.0-alpha08

Common/AllAndroid/JVM

• Cmn

  @ExperimentalMaterial3Api
  class SearchBarState

---

The state of a search bar.

Summary

Public companion functions
Saver<SearchBarState, *>	Saver(     animationSpecForExpand: AnimationSpec<Float>,     animationSpecForCollapse: AnimationSpec<Float> ) The default Saver implementation for SearchBarState.	Cmn

Public constructors
SearchBarState(     initialValue: SearchBarValue,     animationSpecForExpand: AnimationSpec<Float>,     animationSpecForCollapse: AnimationSpec<Float> ) Construct a SearchBarState.	Cmn

Public functions
suspend Unit	animateToCollapsed() Animate the search bar to its collapsed state.	Cmn
suspend Unit	animateToExpanded() Animate the search bar to its expanded state.	Cmn
suspend Unit	snapTo(fraction: Float) Snap the search bar progress to the given fraction, where 0 represents SearchBarValue.Collapsed and 1 represents SearchBarValue.Expanded.	Cmn

Public properties
LayoutCoordinates?	collapsedCoords The layout coordinates, if available, of the search bar when it is collapsed.	Cmn
SearchBarValue	currentValue Whether the search bar is currently expanded or collapsed.	Cmn
Boolean	isAnimating Whether the state is currently animating	Cmn
Float	progress The animation progress of the search bar, where 0 represents SearchBarValue.Collapsed and 1 represents SearchBarValue.Expanded.	Cmn
SearchBarValue	targetValue Whether the search bar is going to be expanded or collapsed.	Cmn

Public companion functions

Saver

Cmn

Added in 1.4.0-alpha08

fun Saver(
    animationSpecForExpand: AnimationSpec<Float>,
    animationSpecForCollapse: AnimationSpec<Float>
): Saver<SearchBarState, *>

The default Saver implementation for SearchBarState.

Public constructors

SearchBarState

Cmn

Added in 1.4.0-alpha08

SearchBarState(
    initialValue: SearchBarValue,
    animationSpecForExpand: AnimationSpec<Float>,
    animationSpecForCollapse: AnimationSpec<Float>
)

Construct a SearchBarState.

Parameters
initialValue: SearchBarValue	the initial value of whether the search bar is collapsed or expanded.
animationSpecForExpand: AnimationSpec<Float>	the animation spec used when the search bar expands.
animationSpecForCollapse: AnimationSpec<Float>	the animation spec used when the search bar collapses.

Public functions

animateToCollapsed

Cmn

Added in 1.4.0-alpha08

suspend fun animateToCollapsed(): Unit

Animate the search bar to its collapsed state.

animateToExpanded

Cmn

Added in 1.4.0-alpha08

suspend fun animateToExpanded(): Unit

Animate the search bar to its expanded state.

snapTo

Cmn

Added in 1.4.0-alpha08

suspend fun snapTo(fraction: Float): Unit

Snap the search bar progress to the given fraction, where 0 represents SearchBarValue.Collapsed and 1 represents SearchBarValue.Expanded.

Public properties

collapsedCoords

Cmn

Added in 1.4.0-alpha08

var collapsedCoords: LayoutCoordinates?

The layout coordinates, if available, of the search bar when it is collapsed. Used to coordinate the expansion animation.

currentValue

Cmn

Added in 1.4.0-alpha08

val currentValue: SearchBarValue

Whether the search bar is currently expanded or collapsed. If the search bar is currently animating to/from the expanded state, currentValue is SearchBarValue.Expanded until the animation completes.

isAnimating

Cmn

Added in 1.4.0-alpha08

val isAnimating: Boolean

Whether the state is currently animating

progress

Cmn

Added in 1.4.0-alpha08

val progress: Float

The animation progress of the search bar, where 0 represents SearchBarValue.Collapsed and 1 represents SearchBarValue.Expanded.

targetValue

Cmn

Added in 1.4.0-alpha08

val targetValue: SearchBarValue

Whether the search bar is going to be expanded or collapsed.