# rememberStandardBottomSheetState

Common/AllAndroid/JVM

## Functions summary

|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetState` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/Composable @https://developer.android.com/reference/kotlin/androidx/compose/material3/ExperimentalMaterial3Api [rememberStandardBottomSheetState](https://developer.android.com/reference/kotlin/androidx/compose/material3/rememberStandardBottomSheetState.composable#rememberStandardBottomSheetState(androidx.compose.material3.SheetValue,kotlin.Function1,kotlin.Boolean))( initialValue: https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue, confirmValueChange: (https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html, skipHiddenState: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html )` **This function is deprecated.** Use rememberBottomSheetState with PartiallyExpanded initial value | Cmn |

## Functions

### rememberStandardBottomSheetState

Cmn 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/BottomSheetScaffold.kt+function:rememberStandardBottomSheetState)

```
@Composable
@ExperimentalMaterial3Api
fun [rememberStandardBottomSheetState](https://developer.android.com/reference/kotlin/androidx/compose/material3/rememberStandardBottomSheetState.composable#rememberStandardBottomSheetState(androidx.compose.material3.SheetValue,kotlin.Function1,kotlin.Boolean))(
    initialValue: SheetValue = PartiallyExpanded,
    confirmValueChange: (SheetValue) -> Boolean = { true },
    skipHiddenState: Boolean = true
): SheetState
```

> [!CAUTION]
> **This function is deprecated.**   
> Use rememberBottomSheetState with PartiallyExpanded initial value, use this instead:
>
> ```kotlin
> rememberBottomSheetState(initialValue = initialValue, enabledValues = if (skipHiddenState) setOf(SheetValue.PartiallyExpanded, SheetValue.Expanded) else setOf(SheetValue.Hidden, SheetValue.PartiallyExpanded, SheetValue.Expanded), confirmValueChange = confirmValueChange)
> ```

Create and `https://developer.android.com/reference/kotlin/androidx/compose/runtime/remember.composable#remember(kotlin.Function0)` a `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetState` for `https://developer.android.com/reference/kotlin/androidx/compose/material3/BottomSheetScaffold.composable#BottomSheetScaffold(kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.BottomSheetScaffoldState,androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp,kotlin.Function0,kotlin.Boolean,kotlin.Function0,kotlin.Function1,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,kotlin.Function1)`.

This deprecated method preserves the legacy behavior where the partially expanded state is automatically excluded if the sheet height is less than half the screen height. To move away from this behavior, use `https://developer.android.com/reference/kotlin/androidx/compose/material3/rememberBottomSheetState.composable#rememberBottomSheetState(androidx.compose.material3.SheetValue,kotlin.collections.Set,kotlin.Function1)`.

| Parameters |
|---|---|
| `initialValue: https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue = PartiallyExpanded` | the initial value of the state. Should be either `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue#PartiallyExpanded` or `https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue#Expanded` if `https://developer.android.com/reference/kotlin/androidx/compose/material3/package-summary#rememberStandardBottomSheetState(androidx.compose.material3.SheetValue,kotlin.Function1,kotlin.Boolean)` is true |
| `confirmValueChange: (https://developer.android.com/reference/kotlin/androidx/compose/material3/SheetValue) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = { true }` | optional callback invoked to confirm or veto a pending state change |
| `skipHiddenState: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html = true` | whether Hidden state is skipped for `https://developer.android.com/reference/kotlin/androidx/compose/material3/BottomSheetScaffold.composable#BottomSheetScaffold(kotlin.Function1,androidx.compose.ui.Modifier,androidx.compose.material3.BottomSheetScaffoldState,androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp,androidx.compose.ui.graphics.Shape,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,androidx.compose.ui.unit.Dp,androidx.compose.ui.unit.Dp,kotlin.Function0,kotlin.Boolean,kotlin.Function0,kotlin.Function1,androidx.compose.ui.graphics.Color,androidx.compose.ui.graphics.Color,kotlin.Function1)` |