# FloatingToolbarState

Artifact: [androidx.compose.material3:material3](https://developer.android.com/jetpack/androidx/releases/compose-material3) [View Source](https://cs.android.com/search?q=file:androidx/compose/material3/FloatingToolbar.kt+class:androidx.compose.material3.FloatingToolbarState) Common/AllAndroid/JVM
- Cmn

  ```
  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 `https://developer.android.com/reference/kotlin/androidx/compose/material3/FloatingToolbarScrollBehavior` implementation.

In most cases, this state will be created via `https://developer.android.com/reference/kotlin/androidx/compose/material3/rememberFloatingToolbarState.composable#rememberFloatingToolbarState(kotlin.Float,kotlin.Float,kotlin.Float)`.

## Summary

| ### Public properties |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/FloatingToolbarState#contentOffset()` The total offset of the content scrolled under the floating toolbar. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/FloatingToolbarState#offset()` The floating toolbar's current offset in pixels. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/FloatingToolbarState#offsetLimit()` The floating toolbar's offset limit in pixels, which represents the limit that a floating toolbar is allowed to collapse to. | Cmn |

## Public properties

### contentOffset

Cmn

```
var contentOffset: Float
```

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

This value is updated by a `https://developer.android.com/reference/kotlin/androidx/compose/material3/FloatingToolbarScrollBehavior` whenever a nested scroll connection consumes scroll events. A common implementation would update the value to be the sum of all `https://developer.android.com/reference/kotlin/androidx/compose/ui/input/nestedscroll/NestedScrollConnection#onPostScroll(androidx.compose.ui.geometry.Offset,androidx.compose.ui.geometry.Offset,androidx.compose.ui.input.nestedscroll.NestedScrollSource)` `consumed` values.

### offset

Cmn

```
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.

Updates to the `https://developer.android.com/reference/kotlin/androidx/compose/material3/FloatingToolbarState#offset()` value are coerced between zero and `https://developer.android.com/reference/kotlin/androidx/compose/material3/FloatingToolbarState#offsetLimit()`.

### offsetLimit

Cmn

```
var offsetLimit: Float
```

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

Use this limit to coerce the `https://developer.android.com/reference/kotlin/androidx/compose/material3/FloatingToolbarState#offset()` value when it's updated.