ComposeParallaxToolbarLayout

Title, positioned by the layout.

Content shown in the expanded header, e.g. an image.

The scrollable body: ParallaxContent.Regular or ParallaxContent.Lazy.

Padding applied to the body, typically the Scaffold padding.

Optional subtitle under the title.

Optional leading toolbar slot.

Optional trailing toolbar slot.

Optional layer drawn above the body and the toolbar, the size of the whole layout. Use it with ParallaxToolbarScope.moveBetween for elements that travel from the header into the toolbar, such as an avatar.

Optional row pinned under the toolbar, such as tabs or a search field. It rides the header's bottom edge while expanded and stays below the toolbar once collapsed. Give it a background; the body scrolls underneath it.

Called when a stretch is released past ParallaxHeaderConfig.stretchTriggerDistance; requires stretchEnabled. Typical use is pull-to-refresh.

Strings announced to accessibility services; see ParallaxSemanticsConfig. The layout exposes its state and expand/collapse actions, reads the toolbar before the header and body, marks the title as a heading, and hides the covered header or an exited toolbar from screen readers.

Whether scrolling and dragging move the header. When false the header stays where it is and only ParallaxToolbarState.collapse and ParallaxToolbarState.expand move it; the body still scrolls. For a locked state such as loading or editing.

Insets the toolbar and body are pushed inside of. The top inset sits above the toolbar and under the header; the horizontal insets keep the navigation icon, actions and title clear of display cutouts. Defaults to the status bar plus the cutout, the same as Material's top app bar. Pass WindowInsets(0) when the layout does not touch the window edge, for example inside a dialog, a bottom sheet or a split pane.

Hoisted state to observe the collapse fraction or expand and collapse programmatically. It also owns the scroll states of both content kinds, unless ParallaxContent.Lazy carries its own list state.

Example with a customized LazyColumn:

ComposeParallaxToolbarLayout(
    titleContent = { collapsed -> Text("Title") },
    headerContent = { Image(...) },
    content = ParallaxContent.Lazy(
        content = { collapsed -> items(100) { Text("Row $it") } },
        config = ParallaxToolbarDefaults.lazyColumnConfig(
            contentPadding = PaddingValues(16.dp),
            verticalArrangement = Arrangement.spacedBy(8.dp)
        )
    )
)