🌈 Create new beautiful Compose Gradients with our new wesite ->
Class

SheetState

State of a sheet composable, such as ModalBottomSheet Contains states relating to its swipe position as well as animations between state values.

Source set: Common
public class SheetState internal constructor(
    internal val enabledValues: Set<SheetValue>,
    internal val positionalThreshold: () -> Float,
    internal val velocityThreshold: () -> Float,
    initialValue: SheetValue,
    internal val confirmValueChange: (SheetValue) -> Boolean,
    internal val isBottomSheetPartiallyExpandedDeterministicEnabled: Boolean,
)

State of a sheet composable, such as ModalBottomSheet

Contains states relating to its swipe position as well as animations between state values.

Parameters
enabledValues The set of SheetValues that the bottom sheet can settle in. This is the direct source of truth for available states; if a value is included here, the component will attempt to create an anchor for it.
positionalThreshold The positional threshold, in px, to be used when calculating the target state while a drag is in progress and when settling after the drag ends. This is the distance from the start of a transition. It will be, depending on the direction of the interaction, added or subtracted from/to the origin offset. It should always be a positive value.
velocityThreshold The velocity threshold (in px per second) that the end velocity has to exceed in order to animate to the next state, even if the positionalThreshold has not been reached.
initialValue The initial value of the state.
confirmValueChange Optional callback invoked to confirm or veto a pending state change.

Properties

currentValue

Source set: Common
public val currentValue: SheetValue

The current value of the state.

If no swipe or animation is in progress, this corresponds to the state the bottom sheet is currently in. If a swipe or an animation is in progress, this corresponds the state the sheet was in before the swipe or animation started.

targetValue

Source set: Common
public val targetValue: SheetValue

The target value of the bottom sheet state.

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

isVisible

Source set: Common
public val isVisible: Boolean

Whether the modal bottom sheet is visible.

isAnimationRunning

Source set: Common
public val isAnimationRunning: Boolean

Whether an expanding or collapsing sheet animation is currently in progress.

See expand, partialExpand, show or hide for more information.

hasExpandedState

Source set: Common
public val hasExpandedState: Boolean

Whether the sheet has an expanded state defined.

hasPartiallyExpandedState

Source set: Common
public val hasPartiallyExpandedState: Boolean

Whether the modal bottom sheet has a partially expanded state defined.

Functions

requireOffset

Source set: Common
public fun requireOffset(): Float

Require the current offset (in pixels) of the bottom sheet.

The offset will be initialized during the first measurement phase of the provided sheet content.

These are the phases: Composition { -> Effects } -> Layout { Measurement -> Placement } -> Drawing

During the first composition, an IllegalStateException is thrown. In subsequent compositions, the offset will be derived from the anchors of the previous pass. Always prefer accessing the offset from a LaunchedEffect as it will be scheduled to be executed the next frame, after layout.

Throws: IllegalStateException

If the offset has not been initialized yet

expand

Source set: Common
public suspend fun expand()

If confirmValueChange returns true, fully expand the bottom sheet with animation and suspend until it is fully expanded or animation has been cancelled.

Throws: CancellationException

if the animation is interrupted

partialExpand

Source set: Common
public suspend fun partialExpand()

If confirmValueChange returns true, animate the bottom sheet and suspend until it is partially expanded or animation has been cancelled.

Throws: CancellationException

if the animation is interrupted

Throws: IllegalStateException

if skipPartiallyExpanded is set to true

show

Source set: Common
public suspend fun show()

If confirmValueChange returns true, expand the bottom sheet with animation and suspend until it is PartiallyExpanded if defined, else Expanded.

Throws: CancellationException

if the animation is interrupted

hide

Source set: Common
public suspend fun hide()

If confirmValueChange returns true, hide the bottom sheet with animation and suspend until it is fully hidden or animation has been cancelled.

Throws: CancellationException

if the animation is interrupted

Members

Companion

Source set: Common
public companion object

Functions

Saver

Source set: Common
public fun Saver(
            enabledValues: Set<SheetValue>,
            positionalThreshold: () -> Float,
            velocityThreshold: () -> Float,
            confirmValueChange: (SheetValue) -> Boolean,
        ): Saver<SheetState, SheetValue>

The default Saver implementation for SheetState.

Saver

Source set: Common
@Deprecated(
            message = "Use the Saver that takes a set of enabled values.",
            replaceWith =
                ReplaceWith(
                    "Saver(enabledValues = buildSet { " +
                        "add(SheetValue.Expanded); " +
                        "if (!skipPartiallyExpanded) add(SheetValue.PartiallyExpanded); " +
                        "if (!skipHiddenState) add(SheetValue.Hidden) " +
                        "}, positionalThreshold, velocityThreshold, confirmValueChange)",
                    "androidx.compose.material3.SheetValue",
                ),
        )
        public fun Saver(
            skipPartiallyExpanded: Boolean,
            positionalThreshold: () -> Float,
            velocityThreshold: () -> Float,
            confirmValueChange: (SheetValue) -> Boolean,
            skipHiddenState: Boolean,
        ): Saver<SheetState, SheetValue>

Saver

Source set: Common
@Deprecated(
            level = DeprecationLevel.HIDDEN,
            message = "Maintained for binary compatibility.",
        )
        public fun Saver(
            skipPartiallyExpanded: Boolean,
            confirmValueChange: (SheetValue) -> Boolean,
            density: Density,
            skipHiddenState: Boolean,
        ): Saver<SheetState, SheetValue>

Content updated: