BottomDrawerState

Kotlin |Java

class BottomDrawerState : SwipeableState<BottomDrawerValue>

kotlin.Any
↳	androidx.compose.material.SwipeableState<androidx.compose.material.BottomDrawerValue>
	↳	androidx.compose.material.BottomDrawerState

State of the BottomDrawerLayout composable.

Summary

Public constructors
`<init>(initialValue: BottomDrawerValue, clock: AnimationClockObservable, confirmStateChange: (BottomDrawerValue) -> Boolean = { true })` State of the BottomDrawerLayout composable.

Public methods
Unit	`close(onClosed: () -> Unit = null)` Close the drawer with an animation.
Unit	`expand(onExpanded: () -> Unit = null)` Expand the drawer with an animation.
Unit	`open(onOpened: () -> Unit = null)` Open the drawer with an animation.

Companion functions
Saver<BottomDrawerState, BottomDrawerValue>	`Saver(clock: AnimationClockObservable, confirmStateChange: (BottomDrawerValue) -> Boolean)` The default Saver implementation for BottomDrawerState.

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	`isClosed` Whether the drawer is closed.
Boolean	`isExpanded` Whether the drawer is expanded.
Boolean	`isOpen` Whether the drawer is open.

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>

BottomDrawerState(
    initialValue: BottomDrawerValue, 
    clock: AnimationClockObservable, 
    confirmStateChange: (BottomDrawerValue) -> Boolean = { true })

State of the BottomDrawerLayout composable.

Parameters
initialValue: BottomDrawerValue	The initial value of the state.
clock: AnimationClockObservable	The animation clock that will be used to drive the animations.
confirmStateChange: (BottomDrawerValue) -> Boolean = { true }	Optional callback invoked to confirm or veto a pending state change.

Public methods

close

fun close(onClosed: () -> Unit = null): Unit

Close the drawer with an animation.

Parameters
onClosed: () -> Unit = null	Optional callback invoked when the drawer has finished closing.

expand

fun expand(onExpanded: () -> Unit = null): Unit

Expand the drawer with an animation.

Parameters
onExpanded: () -> Unit = null	Optional callback invoked when the drawer has finished expanding.

open

fun open(onOpened: () -> Unit = null): Unit

Open the drawer with an animation.

Parameters
onOpened: () -> Unit = null	Optional callback invoked when the drawer has finished opening.

Properties

isClosed

val isClosed: Boolean

Whether the drawer is closed.

isExpanded

val isExpanded: Boolean

Whether the drawer is expanded.

isOpen

val isOpen: Boolean

Whether the drawer is open.

Companion functions

Saver

fun Saver(
    clock: AnimationClockObservable, 
    confirmStateChange: (BottomDrawerValue) -> Boolean
): Saver<BottomDrawerState, BottomDrawerValue>

The default Saver implementation for BottomDrawerState.