# ScreenStage

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


```
value class ScreenStage
```

<br />

*** ** * ** ***

`https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScreenStage` represents the different stages for a screen, which affect visibility of scaffold components such as `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/TimeText.composable#TimeText(androidx.compose.ui.Modifier,androidx.wear.compose.foundation.CurvedModifier,kotlin.Float,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.TimeSource,androidx.compose.foundation.layout.PaddingValues,kotlin.Function2)` and `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScrollIndicator.composable#ScrollIndicator(androidx.compose.foundation.ScrollState,androidx.compose.ui.Modifier,androidx.wear.compose.material3.ScrollIndicatorColors,kotlin.Boolean,androidx.compose.animation.core.AnimationSpec)` with `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/scrollAway.modifier#(androidx.compose.ui.Modifier).scrollAway(androidx.wear.compose.foundation.ScrollInfoProvider,kotlin.Function0)` and other animations.

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScreenStage` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScreenStage#Idle()` Stage when both the screen is not scrolling and some time has passed after the screen was initially shown. |
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScreenStage` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScreenStage#New()` Initial stage for a screen when first displayed. |
| `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScreenStage` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScreenStage#Scrolling()` Stage when the screen is being scrolled. |

| ### Public functions |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScreenStage#toString()()` |

## Public companion properties

### Idle

```
val Idle: ScreenStage
```

Stage when both the screen is not scrolling and some time has passed after the screen was initially shown. At this stage, the `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/TimeText.composable#TimeText(androidx.compose.ui.Modifier,androidx.wear.compose.foundation.CurvedModifier,kotlin.Float,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.TimeSource,androidx.compose.foundation.layout.PaddingValues,kotlin.Function2)` is expected to be displayed and the `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScrollIndicator.composable#ScrollIndicator(androidx.compose.foundation.ScrollState,androidx.compose.ui.Modifier,androidx.wear.compose.material3.ScrollIndicatorColors,kotlin.Boolean,androidx.compose.animation.core.AnimationSpec)` will be hidden.

### New

```
val New: ScreenStage
```

Initial stage for a screen when first displayed. It is expected that the `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/TimeText.composable#TimeText(androidx.compose.ui.Modifier,androidx.wear.compose.foundation.CurvedModifier,kotlin.Float,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.TimeSource,androidx.compose.foundation.layout.PaddingValues,kotlin.Function2)` and `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScrollIndicator.composable#ScrollIndicator(androidx.compose.foundation.ScrollState,androidx.compose.ui.Modifier,androidx.wear.compose.material3.ScrollIndicatorColors,kotlin.Boolean,androidx.compose.animation.core.AnimationSpec)` are displayed when initially showing a screen.

### Scrolling

```
val Scrolling: ScreenStage
```

Stage when the screen is being scrolled. At this stage, it is expected that the `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/ScrollIndicator.composable#ScrollIndicator(androidx.compose.foundation.ScrollState,androidx.compose.ui.Modifier,androidx.wear.compose.material3.ScrollIndicatorColors,kotlin.Boolean,androidx.compose.animation.core.AnimationSpec)` will be shown and `https://developer.android.com/reference/kotlin/androidx/wear/compose/material3/TimeText.composable#TimeText(androidx.compose.ui.Modifier,androidx.wear.compose.foundation.CurvedModifier,kotlin.Float,androidx.compose.ui.graphics.Color,androidx.wear.compose.material3.TimeSource,androidx.compose.foundation.layout.PaddingValues,kotlin.Function2)` will be scrolled away by the scroll operation.

## Public functions

### toString

```
open fun toString(): String
```