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, clock: AnimationClockObservable, animationSpec: AnimationSpec<Float> = SwipeableConstants.DefaultAnimationSpec, confirmStateChange: (ModalBottomSheetValue) -> Boolean = { true })` State of the ModalBottomSheetLayout composable.

Public methods
Unit	`hide(onHidden: () -> Unit = null)` Hide the bottom sheet, with an animation.
Unit	`show(onShown: () -> Unit = null)` Show the bottom sheet, with an animation.

Companion functions
Saver<ModalBottomSheetState, *>	`Saver(clock: AnimationClockObservable, 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, onEnd: (AnimationEndReason, T) -> Unit = null)

Set the state to the target value by starting an animation.

Unit

snapTo(targetValue: T)

Set the state to the target value immediately, without any animation.

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

Inherited properties

From class SwipeableState

`Float`	`direction` The direction in which the swipeable is moving, relative to the current value. 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 is enabled.
`State<Float>`	`overflow` The amount by which the swipeable has been swiped past its bounds.
`SwipeProgress<T>`	`progress` Information about the ongoing swipe or animation, if any. See SwipeProgress for details. If no swipe or animation is in progress, this returns `SwipeProgress(value, value, 1f)`.
`T`	`targetValue` The target value of the state. If a swipe is in progress, this is the value that the swipeable would animate to if the swipe finished. If an animation is running, this is the target value of that animation. Finally, if no swipe or animation is in progress, this is the same as the value.
`T`	`value` 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.

Public constructors

<init>

ModalBottomSheetState(
    initialValue: ModalBottomSheetValue, 
    clock: AnimationClockObservable, 
    animationSpec: AnimationSpec<Float> = SwipeableConstants.DefaultAnimationSpec, 
    confirmStateChange: (ModalBottomSheetValue) -> Boolean = { true })

State of the ModalBottomSheetLayout composable.

Parameters
initialValue: ModalBottomSheetValue	The initial value of the state.
clock: AnimationClockObservable	The animation clock that will be used to drive the animations.
animationSpec: AnimationSpec<Float> = SwipeableConstants.DefaultAnimationSpec	The default animation that will be used to animate to a new state.
confirmStateChange: (ModalBottomSheetValue) -> Boolean = { true }	Optional callback invoked to confirm or veto a pending state change.

Public methods

hide

fun hide(onHidden: () -> Unit = null): Unit

Hide the bottom sheet, with an animation.

Parameters
onHidden: () -> Unit = null	Optional callback invoked when the bottom sheet has been hidden.

show

fun show(onShown: () -> Unit = null): Unit

Show the bottom sheet, with an animation.

Parameters
onShown: () -> Unit = null	Optional callback invoked when the bottom sheet has been shown.

Properties

isVisible

val isVisible: Boolean

Whether the bottom sheet is visible.

Companion functions

Saver

fun Saver(
    clock: AnimationClockObservable, 
    animationSpec: AnimationSpec<Float>, 
    confirmStateChange: (ModalBottomSheetValue) -> Boolean
): Saver<ModalBottomSheetState, *>

The default Saver implementation for ModalBottomSheetState.