Compose Multiplatform Material3/androidx.compose.material3/FloatingToolbarState

FloatingToolbarState

interface FloatingToolbarState

A state object that can be hoisted to control and observe the floating toolbar state. The state is read and updated by a FloatingToolbarScrollBehavior implementation.

In most cases, this state will be created via rememberFloatingToolbarState.

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract var contentOffset: Float

The total offset of the content scrolled under the floating toolbar.

Link copied to clipboard
abstract var offset: Float

The floating toolbar's current offset in pixels. This offset is applied to the fixed size of the toolbar to control the displayed size when content is being scrolled.

Link copied to clipboard
abstract var offsetLimit: Float

The floating toolbar's offset limit in pixels, which represents the limit that a floating toolbar is allowed to collapse to.