DrawerState

fun Saver(confirmStateChange: (DrawerValue) -> Boolean): Saver<DrawerState, DrawerValue>

The default Saver implementation for DrawerState.

suspend fun animateTo(targetValue: DrawerValue, anim: AnimationSpec<Float>): Unit

Set the state of the drawer with specific animation

suspend fun close(): Unit

Close the drawer with animation and suspend until it if fully closed or animation has been cancelled. This method will throw CancellationException if the animation is interrupted

suspend fun open(): Unit

Open the drawer with animation and suspend until it if fully opened or animation has been cancelled. This method will throw CancellationException if the animation is interrupted

suspend fun snapTo(targetValue: DrawerValue): Unit

Set the state without any animation and suspend until it's set

val currentOffset: Float

The current position (in pixels) of the drawer sheet, or Float.NaN before the offset is initialized.

val currentValue: DrawerValue

The current value of the state.

If no swipe or animation is in progress, this corresponds to the start the drawer currently in. If a swipe or an animation is in progress, this corresponds the state drawer was in before the swipe or animation started.

val isAnimationRunning: Boolean

Whether the state is currently animating.

val isClosed: Boolean

Whether the drawer is closed.

val isOpen: Boolean

Whether the drawer is open.

val offset: State<Float>

The current position (in pixels) of the drawer sheet, or Float.NaN before the offset is initialized.

val targetValue: DrawerValue

The target value of the drawer state.

If a swipe is in progress, this is the value that the Drawer would animate to if the swipe finishes. 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 currentValue.