Compose Multiplatform Material3/androidx.compose.material3/SearchBarState

SearchBarState

@Stable

The state of a search bar.

Constructors

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

Construct a SearchBarState.

Types

Companion

object Companion

Properties

collapsedCoords

var collapsedCoords: LayoutCoordinates?

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

currentValue

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

val isAnimating: Boolean

Whether the state is currently animating

progress

@get:FloatRange(from = 0.0, to = 1.0)

val progress: Float

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

targetValue

val targetValue: SearchBarValue

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

Functions

animateToCollapsed

suspend fun animateToCollapsed()

Animate the search bar to its collapsed state.

animateToExpanded

suspend fun animateToExpanded()

Animate the search bar to its expanded state.

snapTo

suspend fun snapTo(fraction: Float)

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