multipaz-compose/org.multipaz.compose.cards/VerticalCardListState

VerticalCardListState

@Stable

class VerticalCardListState(val scrollState: ScrollState, val model: VerticalCardListModel = VerticalCardListModel())

State object for VerticalCardList.

Use rememberVerticalCardListState to create an instance.

Parameters

scrollState

the scroll state for the list.

model

underlying platform-agnostic VerticalCardListModel.

Constructors

VerticalCardListState

constructor(scrollState: ScrollState, model: VerticalCardListModel = VerticalCardListModel())

Properties

animateListTransitions

var animateListTransitions: Boolean

Whether to animate spatial transitions (like sliding cards) when entering this screen.

displayOrderIdentifiers

var displayOrderIdentifiers: List<String>

The current display order of the cards, tracked by identifier.

dragCurrentY

var dragCurrentY: Float

The current Y position of the dragged card.

draggedCardIdentifier

var draggedCardIdentifier: String?

The identifier of the card currently being dragged, if any.

dragJustEnded

var dragJustEnded: Boolean

Whether a drag operation just ended.

lastFocusedCardIdentifier

var lastFocusedCardIdentifier: String?

The identifier of the last focused card, used to preserve animations across navigation.

model

val model: VerticalCardListModel

scrollState

val scrollState: ScrollState

showPlaceholderWhenEmpty

var showPlaceholderWhenEmpty: Boolean

Whether to show a dashed placeholder card when the card list is empty.

showTopContent

var showTopContent: Boolean

Whether the top content composable should be shown when no card is focused.

topContentHeightPx

var topContentHeightPx: Float

The measured height of the top content in pixels.

unfocusTrigger

var unfocusTrigger: Int

Trigger counter for requesting an in-place unfocus animation.

Functions

unfocus

suspend fun unfocus()

Unfocuses the currently focused card with an animation.