DrawerState

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

State of the ModalNavigationDrawer and DismissibleNavigationDrawer composable.

Parameters

Properties

isOpen

public val isOpen: Boolean

Whether the drawer is open.

isClosed

public val isClosed: Boolean

Whether the drawer is closed.

currentValue

public 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

public val isAnimationRunning: Boolean

Whether the state is currently animating.

targetValue

public 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

@Deprecated(
        message =
            "Please access the offset through currentOffset, which returns the value " +
                "directly instead of wrapping it in a state object.",
        replaceWith = ReplaceWith("currentOffset"),
    )
    public val offset: State<Float> =
        object : State<Float> {
            override val value: Float
                get() = anchoredDraggableState.offset
        }

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

currentOffset

public val currentOffset: Float

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

Functions

open

public 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

Return

the reason the open animation ended

close

public 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

Return

the reason the close animation ended

animateTo

@Deprecated(
        message =
            "This method has been replaced by the open and close methods. The animation " +
                "spec is now an implementation detail of ModalDrawer."
    )
    public suspend fun animateTo(targetValue: DrawerValue, anim: AnimationSpec<Float>)

Set the state of the drawer with specific animation

Parameters

snapTo

public suspend fun snapTo(targetValue: DrawerValue)

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

Parameters

Members

Companion

public companion object

Functions

Saver

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

The default Saver implementation for DrawerState.