Android Scanbot SDK API reference/io.scanbot.sdk.ui_v2.common.components/BottomSheetState

BottomSheetState

class BottomSheetState(initialValue: BottomSheetValue, animationSpec: <Error class: unknown class><Float> = SwipeableDefaults.AnimationSpec, confirmValueChange: (BottomSheetValue) -> Boolean = { true })

State of the persistent bottom sheet in ScanbotScaffold.

Parameters

initialValue

The initial value of the state.

animationSpec

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

confirmValueChange

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

Constructors

BottomSheetState

constructor(initialValue: BottomSheetValue, animationSpec: <Error class: unknown class><Float> = SwipeableDefaults.AnimationSpec, confirmValueChange: (BottomSheetValue) -> Boolean = { true })

Types

Companion

object Companion

Properties

currentValue

val currentValue: BottomSheetValue

isCollapsed

val isCollapsed: Boolean

Whether the bottom sheet is collapsed.

isExpanded

val isExpanded: Boolean

Whether the bottom sheet is expanded.

offset

val ~~offset~~: Float

progress

val progress: Float

The fraction of the progress going from currentValue to the targetValue, within 0f..1f bounds, or 1f if the sheet is in a settled state.

swipeableState

val swipeableState: SwipeableV2State<BottomSheetValue>

Functions

collapse

suspend fun collapse()

Collapse the bottom sheet with animation and suspend until it if fully collapsed or animation has been cancelled. This method will throw CancellationException if the animation is interrupted.

expand

suspend fun expand()

Expand the bottom sheet with an animation and suspend until the animation finishes or is cancelled. Note: If the pick height is equal to the sheet height, this method will animate to the Collapsed state.

requireOffset

fun requireOffset(): Float

Require the current offset.