DrawerState

class DrawerState(
initialValue: DrawerValue,
internal val confirmStateChange: (DrawerValue) -> Boolean = { true },
)

State of the ModalNavigationDrawer and DismissibleNavigationDrawer composable.

Parameters

Properties

isOpen

val isOpen: Boolean

Whether the drawer is open.

isClosed

val isClosed: Boolean

Whether the drawer is closed.

currentValue

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.

isAnimationRunning

val isAnimationRunning: Boolean

Whether the state is currently animating.

targetValue

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.

offset

val offset: State<Float>

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

currentOffset

val currentOffset: Float

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

Functions

open

suspend fun open() =
        animateTo(targetValue = DrawerValue.Open, animationSpec = openDrawerMotionSpec)

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

Returns

close

suspend fun close() =
        animateTo(targetValue = DrawerValue.Closed, animationSpec = closeDrawerMotionSpec)

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

Returns

animateTo

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

Set the state of the drawer with specific animation

Parameters

snapTo

suspend fun snapTo(targetValue: DrawerValue)

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

Parameters

Companion Object

Methods

fun Saver(confirmStateChange: (DrawerValue) -> Boolean) =
            Saver<DrawerState, DrawerValue>(
                save = { it.currentValue },
                restore = { DrawerState(it, confirmStateChange) },
            )

The default Saver implementation for DrawerState.