DismissibleModalWideNavigationRailState

fun Saver(
    density: Density,
    animationSpec: AnimationSpec<Float>,
    confirmStateChange: (DismissibleModalWideNavigationRailValue) -> Boolean
): Saver<DismissibleModalWideNavigationRailState, DismissibleModalWideNavigationRailValue>

The default Saver implementation for DismissibleModalWideNavigationRailState.

DismissibleModalWideNavigationRailState(
    initialValue: DismissibleModalWideNavigationRailValue,
    density: Density,
    animationSpec: AnimationSpec<Float>,
    confirmValueChange: (DismissibleModalWideNavigationRailValue) -> Boolean = { true }
)

suspend fun close(): Unit

Close the dismissible modal wide navigation rail with animation and suspend until it is fully closed or the animation has been cancelled. This method will throw CancellationException if the animation interrupted.

suspend fun open(): Unit

Open the dismissible modal wide navigation rail with animation and suspend until it if fully open or the animation has been cancelled. This method will throw CancellationException if the animation is interrupted.

suspend fun snapTo(targetValue: DismissibleModalWideNavigationRailValue): Unit

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

val animationSpec: AnimationSpec<Float>

The animation spec that will be used to animate to a new state

var confirmValueChange: (DismissibleModalWideNavigationRailValue) -> Boolean

Optional callback invoked to confirm or veto a pending state change

val currentOffset: Float

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

val currentValue: DismissibleModalWideNavigationRailValue

The current value of the state.

If no swipe or animation is in progress, this corresponds to the value the dismissible modal wide navigation rail is currently in. If a swipe or an animation is in progress, this corresponds to the value the rail was in before the swipe or animation started.

var initialValue: DismissibleModalWideNavigationRailValue

The initial value of the state

val isAnimationRunning: Boolean

Whether the state is currently animating.

val isOpen: Boolean

Whether the dismissible modal wide navigation rail is open.

val targetValue: DismissibleModalWideNavigationRailValue

The target value of the dismissible modal wide navigation rail state.

If a swipe is in progress, this is the value that the modal rail will 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.