ComposeParallaxToolbar/am.highapps.parallaxtoolbar/ParallaxToolbarState

ParallaxToolbarState

Hoisted state of a ComposeParallaxToolbarLayout: observe how far the toolbar has collapsed and drive it programmatically.

Create it with rememberParallaxToolbarState. The collapse fraction survives configuration changes and process death. scrollState backs ParallaxContent.Regular and lazyListState backs ParallaxContent.Lazy unless the content carries its own list state; custom content manages its own scroll state.

Properties

collapseFraction

val collapseFraction: Float

0f while fully expanded, 1f once fully collapsed.

isCollapsed

val isCollapsed: Boolean

isScrollInProgress

val isScrollInProgress: Boolean

True while the header is being dragged, flung, snapped or animated by collapse and expand. False once it has come to rest.

layoutInfo

val layoutInfo: ParallaxToolbarLayoutInfo

Measured geometry, updated on every layout pass.

lazyListState

val lazyListState: LazyListState

scrollState

val scrollState: ScrollState

stretchPx

val stretchPx: Float

Current stretch past the expanded height, in px, while stretchEnabled and pulled down.

toolbarExitFraction

val toolbarExitFraction: Float

0f while the toolbar is on screen, 1f once it has slid away. Only moves in ScrollMode.EnterAlwaysCollapsed; other modes keep the toolbar pinned at 0f.

Functions

collapse

suspend fun collapse(animated: Boolean = true, animationSpec: AnimationSpec<Float>? = null)

Collapses the header. The body keeps its own scroll position.

expand

suspend fun expand(animated: Boolean = true, animationSpec: AnimationSpec<Float>? = null)

Expands the header and brings an exited toolbar back. The body keeps its own scroll position.