Compose Multiplatform

1.8.0

Compose Multiplatform Material3/androidx.compose.material3/DrawerState

DrawerState

@Stable

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

State of the ModalNavigationDrawer and DismissibleNavigationDrawer composable.

Parameters

initialValue

The initial value of the state.

confirmStateChange

Optional callback invoked to confirm or veto a pending state change.

Constructors

constructor(initialValue: DrawerValue, confirmStateChange: (DrawerValue) -> Boolean = { true })

Types

object Companion

Properties

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.

isAnimationRunning

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.

Functions

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

Set the state of the drawer with specific animation

suspend fun close()

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()

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)

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