SheetState
State of a sheet composable, such as ModalBottomSheet
Contains states relating to its swipe position as well as animations between state values.
Parameters
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.
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.
The initial value of the state.
Optional callback invoked to confirm or veto a pending state change.
Whether the hidden state should be skipped. If true, the sheet will always expand to the Expanded state and move to the PartiallyExpanded if available, either programmatically or by user interaction.
Constructors
Properties
The current value of the state.
Whether the sheet has an expanded state defined.
Whether the modal bottom sheet has a partially expanded state defined.
Whether an expanding or collapsing sheet animation is currently in progress.
The target value of the bottom sheet state.
Functions
If confirmValueChange returns true, fully expand the bottom sheet with animation and suspend until it is fully expanded or animation has been cancelled.
If confirmValueChange returns true, hide the bottom sheet with animation and suspend until it is fully hidden or animation has been cancelled.
If confirmValueChange returns true, animate the bottom sheet and suspend until it is partially expanded or animation has been cancelled.
Require the current offset (in pixels) of the bottom sheet.
If confirmValueChange returns true, expand the bottom sheet with animation and suspend until it is PartiallyExpanded if defined, else Expanded.