rememberStandardBottomSheetState

Functions summary

SheetState
@Composable
@ExperimentalMaterial3Api
rememberStandardBottomSheetState(
    initialValue: SheetValue,
    confirmValueChange: (SheetValue) -> Boolean,
    skipHiddenState: Boolean
)

This function is deprecated. Use rememberBottomSheetState with PartiallyExpanded initial value

Cmn

Functions

rememberStandardBottomSheetState

@Composable
@ExperimentalMaterial3Api
fun rememberStandardBottomSheetState(
    initialValue: SheetValue = PartiallyExpanded,
    confirmValueChange: (SheetValue) -> Boolean = { true },
    skipHiddenState: Boolean = true
): SheetState

Create and remember a SheetState for BottomSheetScaffold.

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 rememberBottomSheetState.

Parameters
initialValue: SheetValue = PartiallyExpanded

the initial value of the state. Should be either PartiallyExpanded or Expanded if skipHiddenState is true

confirmValueChange: (SheetValue) -> Boolean = { true }

optional callback invoked to confirm or veto a pending state change

skipHiddenState: Boolean = true

whether Hidden state is skipped for BottomSheetScaffold