ModalBottomSheetState

Kotlin |Java

class ModalBottomSheetState : SwipeableState<ModalBottomSheetValue>

kotlin.Any
↳	androidx.compose.material.SwipeableState<androidx.compose.material.ModalBottomSheetValue>
	↳	androidx.compose.material.ModalBottomSheetState

State of the ModalBottomSheetLayout composable.

Summary

Public constructors
`<init>(initialValue: ModalBottomSheetValue, animationSpec: AnimationSpec<Float> = SwipeableDefaults.AnimationSpec, confirmStateChange: (ModalBottomSheetValue) -> Boolean = { true })` State of the ModalBottomSheetLayout composable.

Public methods
suspend Unit	`hide()` Hide the bottom sheet with animation and suspend until it if fully hidden or animation has been cancelled.
suspend Unit	`show()` Show the bottom sheet with animation and suspend until it's shown.

Companion functions
Saver<ModalBottomSheetState, *>	`Saver(animationSpec: AnimationSpec<Float>, confirmStateChange: (ModalBottomSheetValue) -> Boolean)` The default Saver implementation for ModalBottomSheetState.

Inherited functions

From class SwipeableState

`Unit`	`animateTo(targetValue: T, anim: AnimationSpec<Float> = animationSpec)` Set the state to the target value by starting an animation.
`Float`	`performDrag(delta: Float)` Force swipeable to consume drag delta provided from outside of the regular swipeable gesture flow. Note: This method performs generic drag and it won't settle to any particular anchor, * leaving swipeable in between anchors. When done dragging, performFling must be called as well to ensure swipeable will settle at the anchor. In general cases, swipeable drags by itself when being swiped. This method is to be used for nested scroll logic that wraps the swipeable. In nested scroll developer may want to force drag when the child scroll container reaches the bound.
`Unit`	`performFling(velocity: Float)` Perform fling with settling to one of the anchors which is determined by the given velocity. Fling with settling swipeable will always consume all the velocity provided since it will settle at the anchor. In general cases, swipeable flings by itself when being swiped. This method is to be used for nested scroll logic that wraps the swipeable. In nested scroll developer may want to trigger settling fling when the child scroll container reaches the bound.
`Unit`	`snapTo(targetValue: T)` Set the state without any animation and suspend until it's set

Properties
Boolean	`isVisible` Whether the bottom sheet is visible.

Inherited properties

From class SwipeableState

`T`	`currentValue` The current value of the state. If no swipe or animation is in progress, this corresponds to the anchor at which the swipeable is currently settled. If a swipe or animation is in progress, this corresponds the last anchor at which the swipeable was settled before the swipe or animation started.
`Float`	`direction` The direction in which the swipeable is moving, relative to the current currentValue. This will be either 1f if it is is moving from left to right or top to bottom, -1f if it is moving from right to left or bottom to top, or 0f if no swipe or animation is in progress.
`Boolean`	`isAnimationRunning` Whether the state is currently animating.
`State<Float>`	`offset` The current position (in pixels) of the swipeable. You should use this state to offset your content accordingly. The recommended way is to use `Modifier.offsetPx`. This includes the resistance by default, if resistance i