# scrollAway

## Functions summary

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.https://developer.android.com/reference/kotlin/androidx/wear/compose/material/scrollAway.modifier#(androidx.compose.ui.Modifier).scrollAway(androidx.compose.foundation.ScrollState,androidx.compose.ui.unit.Dp)(scrollState: https://developer.android.com/reference/kotlin/androidx/compose/foundation/ScrollState, offset: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp)` Scroll an item vertically in/out of view based on a `https://developer.android.com/reference/kotlin/androidx/compose/foundation/ScrollState`. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.https://developer.android.com/reference/kotlin/androidx/wear/compose/material/scrollAway.modifier#(androidx.compose.ui.Modifier).scrollAway(androidx.compose.foundation.lazy.LazyListState,kotlin.Int,androidx.compose.ui.unit.Dp)( scrollState: https://developer.android.com/reference/kotlin/androidx/compose/foundation/lazy/LazyListState, itemIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, offset: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp )` Scroll an item vertically in/out of view based on a `https://developer.android.com/reference/kotlin/androidx/compose/foundation/lazy/LazyListState`. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.https://developer.android.com/reference/kotlin/androidx/wear/compose/material/scrollAway.modifier#(androidx.compose.ui.Modifier).scrollAway(androidx.wear.compose.foundation.lazy.ScalingLazyListState,kotlin.Int,androidx.compose.ui.unit.Dp)( scrollState: https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/lazy/ScalingLazyListState, itemIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, offset: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp )` Scroll an item vertically in/out of view based on a `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/lazy/ScalingLazyListState`. |
| `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier` | `https://developer.android.com/reference/kotlin/androidx/compose/ui/Modifier.[scrollAway](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/scrollAway.modifier#(androidx.compose.ui.Modifier).scrollAway(androidx.wear.compose.material.ScalingLazyListState,kotlin.Int,androidx.compose.ui.unit.Dp))( scrollState: https://developer.android.com/reference/kotlin/androidx/wear/compose/material/ScalingLazyListState, itemIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, offset: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp )` **This function is deprecated.** This overload is provided for backwards compatibility with Compose for Wear OS 1.1.A newer overload is available which uses ScalingLazyListState from wear.compose.foundation.lazy package |

## Functions

### Modifier.scrollAway

Artifact: [androidx.wear.compose:compose-material](https://developer.android.com/jetpack/androidx/releases/wear-compose) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/material/ScrollAway.kt+function:scrollAway) Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.6.0)

```
fun Modifier.scrollAway(scrollState: ScrollState, offset: Dp = 0.dp): Modifier
```

Scroll an item vertically in/out of view based on a `https://developer.android.com/reference/kotlin/androidx/compose/foundation/ScrollState`. Typically used to scroll a `https://developer.android.com/reference/kotlin/androidx/wear/compose/material/TimeText.composable#TimeText(androidx.compose.ui.Modifier,androidx.wear.compose.material.TimeSource,androidx.compose.ui.text.TextStyle,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0,kotlin.Function1,kotlin.Function0,kotlin.Function1,kotlin.Function0,kotlin.Function1)` item out of view as the user starts to scroll a vertically scrollable `https://developer.android.com/reference/kotlin/androidx/compose/foundation/layout/Column.composable#Column(androidx.compose.ui.Modifier,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.ui.Alignment.Horizontal,kotlin.Function1)` of items upwards and bring additional items into view.

| Parameters |
|---|---|
| `scrollState: https://developer.android.com/reference/kotlin/androidx/compose/foundation/ScrollState` | The `https://developer.android.com/reference/kotlin/androidx/compose/foundation/ScrollState` to be used as the basis for the scroll-away. |
| `offset: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp = 0.dp` | Adjustment to the starting point for scrolling away. Positive values result in the scroll away starting later. |

### Modifier.scrollAway

Artifact: [androidx.wear.compose:compose-material](https://developer.android.com/jetpack/androidx/releases/wear-compose) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/material/ScrollAway.kt+function:scrollAway) Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.6.0)

```
fun Modifier.scrollAway(
    scrollState: LazyListState,
    itemIndex: Int = 0,
    offset: Dp = 0.dp
): Modifier
```

Scroll an item vertically in/out of view based on a `https://developer.android.com/reference/kotlin/androidx/compose/foundation/lazy/LazyListState`. Typically used to scroll a `https://developer.android.com/reference/kotlin/androidx/wear/compose/material/TimeText.composable#TimeText(androidx.compose.ui.Modifier,androidx.wear.compose.material.TimeSource,androidx.compose.ui.text.TextStyle,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0,kotlin.Function1,kotlin.Function0,kotlin.Function1,kotlin.Function0,kotlin.Function1)` item out of view as the user starts to scroll a `https://developer.android.com/reference/kotlin/androidx/compose/foundation/lazy/LazyColumn.composable#LazyColumn(androidx.compose.ui.Modifier,androidx.compose.foundation.lazy.LazyListState,androidx.compose.foundation.layout.PaddingValues,kotlin.Boolean,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.ui.Alignment.Horizontal,androidx.compose.foundation.gestures.FlingBehavior,kotlin.Boolean,androidx.compose.foundation.OverscrollEffect,androidx.compose.foundation.lazy.layout.LazyLayoutCacheWindow,kotlin.Function1)` of items upwards and bring additional items into view.

| Parameters |
|---|---|
| `scrollState: https://developer.android.com/reference/kotlin/androidx/compose/foundation/lazy/LazyListState` | The `https://developer.android.com/reference/kotlin/androidx/compose/foundation/lazy/LazyListState` to be used as the basis for the scroll-away. |
| `itemIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = 0` | The item for which the scroll offset will trigger scrolling away. |
| `offset: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp = 0.dp` | Adjustment to the starting point for scrolling away. Positive values result in the scroll away starting later. |

### Modifier.scrollAway

Artifact: [androidx.wear.compose:compose-material](https://developer.android.com/jetpack/androidx/releases/wear-compose) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/material/ScrollAway.kt+function:scrollAway) Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.6.0)

```
fun Modifier.scrollAway(
    scrollState: ScalingLazyListState,
    itemIndex: Int = 1,
    offset: Dp = 0.dp
): Modifier
```

Scroll an item vertically in/out of view based on a `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/lazy/ScalingLazyListState`. Typically used to scroll a `https://developer.android.com/reference/kotlin/androidx/wear/compose/material/TimeText.composable#TimeText(androidx.compose.ui.Modifier,androidx.wear.compose.material.TimeSource,androidx.compose.ui.text.TextStyle,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0,kotlin.Function1,kotlin.Function0,kotlin.Function1,kotlin.Function0,kotlin.Function1)` item out of view as the user starts to scroll a `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/lazy/ScalingLazyColumn.composable#ScalingLazyColumn(androidx.compose.ui.Modifier,androidx.wear.compose.foundation.lazy.ScalingLazyListState,androidx.compose.foundation.layout.PaddingValues,kotlin.Boolean,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.ui.Alignment.Horizontal,androidx.compose.foundation.gestures.FlingBehavior,kotlin.Boolean,androidx.wear.compose.foundation.lazy.ScalingParams,androidx.wear.compose.foundation.lazy.ScalingLazyListAnchorType,androidx.wear.compose.foundation.lazy.AutoCenteringParams,androidx.wear.compose.foundation.rotary.RotaryScrollableBehavior,androidx.compose.foundation.OverscrollEffect,kotlin.Function1)` of items upwards and bring additional items into view.

| Parameters |
|---|---|
| `scrollState: https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/lazy/ScalingLazyListState` | The `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/lazy/ScalingLazyListState` to be used as the basis for the scroll-away. |
| `itemIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = 1` | The item for which the scroll offset will trigger scrolling away. |
| `offset: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp = 0.dp` | Adjustment to the starting point for scrolling away. Positive values result in the scroll away starting later, negative values start scrolling away earlier. |

### Modifier.scrollAway

Artifact: [androidx.wear.compose:compose-material](https://developer.android.com/jetpack/androidx/releases/wear-compose) [View Source](https://cs.android.com/search?q=file:androidx/wear/compose/material/ScrollAway.kt+function:scrollAway) Added in [1.6.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.6.0) Deprecated in [1.6.0](https://developer.android.com/jetpack/androidx/releases/wear-compose#1.6.0)

```
fun Modifier.[scrollAway](https://developer.android.com/reference/kotlin/androidx/wear/compose/material/scrollAway.modifier#(androidx.compose.ui.Modifier).scrollAway(androidx.wear.compose.material.ScalingLazyListState,kotlin.Int,androidx.compose.ui.unit.Dp))(
    scrollState: ScalingLazyListState,
    itemIndex: Int = 1,
    offset: Dp = 0.dp
): Modifier
```

> [!CAUTION]
> **This function is deprecated.**   
> This overload is provided for backwards compatibility with Compose for Wear OS 1.1.A newer overload is available which uses ScalingLazyListState from wear.compose.foundation.lazy package

Scroll an item vertically in/out of view based on a `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/lazy/ScalingLazyListState`. Typically used to scroll a `https://developer.android.com/reference/kotlin/androidx/wear/compose/material/TimeText.composable#TimeText(androidx.compose.ui.Modifier,androidx.wear.compose.material.TimeSource,androidx.compose.ui.text.TextStyle,androidx.compose.foundation.layout.PaddingValues,kotlin.Function0,kotlin.Function1,kotlin.Function0,kotlin.Function1,kotlin.Function0,kotlin.Function1)` item out of view as the user starts to scroll a `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/lazy/ScalingLazyColumn.composable#ScalingLazyColumn(androidx.compose.ui.Modifier,androidx.wear.compose.foundation.lazy.ScalingLazyListState,androidx.compose.foundation.layout.PaddingValues,kotlin.Boolean,androidx.compose.foundation.layout.Arrangement.Vertical,androidx.compose.ui.Alignment.Horizontal,androidx.compose.foundation.gestures.FlingBehavior,kotlin.Boolean,androidx.wear.compose.foundation.lazy.ScalingParams,androidx.wear.compose.foundation.lazy.ScalingLazyListAnchorType,androidx.wear.compose.foundation.lazy.AutoCenteringParams,androidx.wear.compose.foundation.rotary.RotaryScrollableBehavior,androidx.compose.foundation.OverscrollEffect,kotlin.Function1)` of items upwards and bring additional items into view.

| Parameters |
|---|---|
| `scrollState: https://developer.android.com/reference/kotlin/androidx/wear/compose/material/ScalingLazyListState` | The `https://developer.android.com/reference/kotlin/androidx/wear/compose/foundation/lazy/ScalingLazyListState` to be used as the basis for the scroll-away. |
| `itemIndex: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = 1` | The item for which the scroll offset will trigger scrolling away. |
| `offset: https://developer.android.com/reference/kotlin/androidx/compose/ui/unit/Dp = 0.dp` | Adjustment to the starting point for scrolling away. Positive values result in the scroll away starting later, negative values start scrolling away earlier. |