Design/net.ikea.skapa.ui.components/SheetState

SheetState

class SheetState(initialValue: SheetValue, animationSpec: AnimationSpec<Float> = SwipeableDefaults.AnimationSpec, val confirmStateChange: (SheetValue) -> Boolean = { true }) : SwipeableState<SheetValue>

State of the SheetState composable.

Parameters

initialValue

The initial value of the state.

animationSpec

The default animation that will be used to animate to a new state.

confirmStateChange

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

Constructors

constructor(initialValue: SheetValue, animationSpec: AnimationSpec<Float> = SwipeableDefaults.AnimationSpec, confirmStateChange: (SheetValue) -> Boolean = { true })

Properties

confirmStateChange

val confirmStateChange: (SheetValue) -> Boolean

currentDialogValue

var currentDialogValue: SheetValue

var currentValue: SheetValue

val direction: Float

isAnimationRunning

var isAnimationRunning: Boolean

val isVisible: Boolean

Whether the sheet is visible.

val offset: State<Float>

val overflow: State<Float>

val progress: SwipeProgress<SheetValue>

val targetValue: SheetValue

Functions

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

suspend fun hide()

Hide the sheet with animation and suspend until it if fully hidden or animation has been cancelled.

fun performDrag(delta: Float): Float

suspend fun performFling(velocity: Float)

suspend fun show()

Show the sheet with animation and suspend until it's shown.

suspend fun snapTo(targetValue: SheetValue)