# PaneScaffoldValue

# PaneScaffoldValue

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/PaneScaffoldValue.kt+class:androidx.compose.material3.adaptive.layout.PaneScaffoldValue)  
Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)
Common/All
  - Cmn  

  ```
  @ExperimentalMaterial3AdaptiveApi
  sealed interface PaneScaffoldValue<Role : PaneScaffoldRole>
```  
Known direct subclasses  
[ThreePaneScaffoldValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldValue)  

|--------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [ThreePaneScaffoldValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldValue) | The adapted value of [ThreePaneScaffold](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/package-summary#ThreePaneScaffold(androidx.compose.ui.Modifier,androidx.compose.material3.adaptive.layout.PaneScaffoldDirective,androidx.compose.material3.adaptive.layout.ThreePaneScaffoldValue,androidx.compose.material3.adaptive.layout.ThreePaneScaffoldHorizontalOrder,kotlin.Function1,kotlin.Function1,androidx.compose.material3.adaptive.layout.PaneExpansionState,kotlin.Function2,kotlin.Function1)). |

*** ** * ** ***

Interface to provide adapted value of panes.  

|                                                                 Parameters                                                                  |
|---------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `<Role : `[PaneScaffoldRole](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneScaffoldRole)`>` | The type of the [PaneScaffoldRole](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneScaffoldRole) that will be used by the pane scaffold implementation to index the pane and its associated [PaneAdaptedValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneAdaptedValue). |

|                                                                  See also                                                                  |
|--------------------------------------------------------------------------------------------------------------------------------------------|---|
| [ThreePaneScaffoldValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldValue) |   |

## Summary

|                                                           ### Public functions                                                            |
|-------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| `operator `[PaneAdaptedValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneAdaptedValue) | [get](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneScaffoldValue#get(androidx.compose.material3.adaptive.layout.PaneScaffoldRole))`(role: Role)` Returns the [PaneAdaptedValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneAdaptedValue) of the given [role](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneScaffoldValue#get(androidx.compose.material3.adaptive.layout.PaneScaffoldRole)) of a pane. | Cmn |

## Public functions

### get

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

```
operator fun get(role: Role): PaneAdaptedValue
```

Returns the [PaneAdaptedValue](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneAdaptedValue) of the given [role](https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneScaffoldValue#get(androidx.compose.material3.adaptive.layout.PaneScaffoldRole)) of a pane.