# ThreePaneScaffoldState

# ThreePaneScaffoldState

Artifact:[androidx.compose.material3.adaptive:adaptive-layout](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive)  
[View Source](https://cs.android.com/search?q=file:androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState.kt+class:androidx.compose.material3.adaptive.layout.ThreePaneScaffoldState)  
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)
Common/All
  - Cmn  

  ```
  @ExperimentalMaterial3AdaptiveApi
  sealed class ThreePaneScaffoldState
```  
Known direct subclasses  
[MutableThreePaneScaffoldState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/MutableThreePaneScaffoldState)  

|----------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
| [MutableThreePaneScaffoldState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/MutableThreePaneScaffoldState) | The seekable state of a three pane scaffold. |

*** ** * ** ***

A read-only state of a three pane scaffold. It provides information about the[Transition](https://developer.android.com/reference/kotlin/androidx/compose/animation/core/Transition)between[ThreePaneScaffoldValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldValue)s.

## Summary

|                                                                       ### Protected constructors                                                                        |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| [ThreePaneScaffoldState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#ThreePaneScaffoldState())`()` | Cmn |

|                                                                 ### Public properties                                                                 |
|-------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| `abstract `[ThreePaneScaffoldValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldValue) | [currentState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#currentState()) Current[ThreePaneScaffoldValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldValue)state of the transition.                                                                                                                                                                                                      | Cmn |
| `abstract `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                        | [isPredictiveBackInProgress](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#isPredictiveBackInProgress()) Whether a predictive back navigation is currently in progress.                                                                                                                                                                                                                                                                                     | Cmn |
| `abstract `[Float](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html)                                                            | [progressFraction](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#progressFraction()) The progress of the transition from[currentState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#currentState())to[targetState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#targetState())as a fraction of the entire duration. | Cmn |
| `abstract `[ThreePaneScaffoldValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldValue) | [targetState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#targetState()) Target[ThreePaneScaffoldValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldValue)state of the transition.                                                                                                                                                                                                         | Cmn |

## Protected constructors

### ThreePaneScaffoldState

Cmn  

```
protected ThreePaneScaffoldState()
```

## Public properties

### currentState

Cmn  
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)  

```
abstract val currentState: ThreePaneScaffoldValue
```

Current[ThreePaneScaffoldValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldValue)state of the transition. If there is an active transition,[currentState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#currentState())and[targetState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#targetState())are different.  

### isPredictiveBackInProgress

Cmn  
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)  

```
abstract val isPredictiveBackInProgress: Boolean
```

Whether a predictive back navigation is currently in progress.  

### progressFraction

Cmn  
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)  

```
abstract val progressFraction: Float
```

The progress of the transition from[currentState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#currentState())to[targetState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#targetState())as a fraction of the entire duration.

If[targetState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#targetState())and[currentState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#currentState())are the same,[progressFraction](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#progressFraction())will be 0.  

### targetState

Cmn  
Added in[1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)  

```
abstract val targetState: ThreePaneScaffoldValue
```

Target[ThreePaneScaffoldValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldValue)state of the transition. If this is the same as[currentState](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldState#currentState()), no transition is active.