DrawerState

Artifact: androidx.compose.material3:material3

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• Cmn

  class DrawerState

---

State of the ModalNavigationDrawer and DismissibleNavigationDrawer composable.

Summary

Public companion functions
Saver<DrawerState, DrawerValue>	Saver(confirmStateChange: (DrawerValue) -> Boolean) The default Saver implementation for DrawerState.	Cmn

Public constructors
DrawerState(     initialValue: DrawerValue,     confirmStateChange: (DrawerValue) -> Boolean )	Cmn

Public functions
suspend Unit	animateTo(targetValue: DrawerValue, anim: AnimationSpec<Float>) This function is deprecated. This method has been replaced by the open and close methods.	Cmn
suspend Unit	close() Close the drawer with animation and suspend until it if fully closed or animation has been cancelled.	Cmn
suspend Unit	open() Open the drawer with animation and suspend until it if fully opened or animation has been cancelled.	Cmn
suspend Unit	snapTo(targetValue: DrawerValue) Set the state without any animation and suspend until it's set	Cmn

Public properties
Float	currentOffset The current position (in pixels) of the drawer sheet, or Float.NaN before the offset is initialized.	Cmn
DrawerValue	currentValue The current value of the state.	Cmn
Boolean	isAnimationRunning Whether the state is currently animating.	Cmn
Boolean	isClosed Whether the drawer is closed.	Cmn
Boolean	isOpen Whether the drawer is open.	Cmn
State<Float>	offset This property is deprecated. Please access the offset through currentOffset, which returns the value directly instead of wrapping it in a state object.	Cmn
DrawerValue	targetValue The target value of the drawer state.	Cmn

Public companion functions

Saver

Cmn

Added in 1.0.0

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

The default Saver implementation for DrawerState.

Public constructors

DrawerState

Cmn

Added in 1.0.0

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

Parameters
initialValue: DrawerValue	The initial value of the state.
confirmStateChange: (DrawerValue) -> Boolean = { true }	Optional callback invoked to confirm or veto a pending state change.

Public functions

animateTo

Cmn

Added in 1.0.0

Deprecated in 1.2.0

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

This function is deprecated.
This method has been replaced by the open and close methods. The animation spec is now an implementation detail of ModalDrawer.

Set the state of the drawer with specific animation

Parameters
targetValue: DrawerValue	The new value to animate to.
anim: AnimationSpec<Float>	The animation that will be used to animate to the new value.

close

Cmn

Added in 1.0.0

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

Returns
Unit	the reason the close animation ended

open

Cmn

Added in 1.0.0

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

Returns
Unit	the reason the open animation ended

snapTo

Cmn

Added in 1.0.0

suspend fun snapTo(targetValue: DrawerValue): Unit

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

Parameters
targetValue: DrawerValue	The new target value

Public properties

currentOffset

Cmn

Added in 1.2.0

val currentOffset: Float

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

See also
offset	for more information.

currentValue

Cmn

Added in 1.0.0

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

Cmn

Added in 1.0.0

val isAnimationRunning: Boolean

Whether the state is currently animating.

isClosed

Cmn

Added in 1.0.0

val isClosed: Boolean

Whether the drawer is closed.

isOpen

Cmn

Added in 1.0.0

val isOpen: Boolean

Whether the drawer is open.

offset

Cmn

Added in 1.0.0

Deprecated in 1.2.0

val offset: State<Float>

This property is deprecated.
Please access the offset through currentOffset, which returns the value directly instead of wrapping it in a state object.

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

See also
offset	for more information.

targetValue

Cmn

Added in 1.0.0

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.