rememberSnapFlingBehavior

Functions summary

TargetedFlingBehavior

Creates and remember a FlingBehavior that performs snapping.

Cmn
FlingBehavior
@Composable
rememberSnapFlingBehavior(
    lazyGridState: LazyGridState,
    snapPosition: SnapPosition
)

Create and remember a FlingBehavior for decayed snapping in Lazy Grids.

Cmn
FlingBehavior
@Composable
rememberSnapFlingBehavior(
    lazyListState: LazyListState,
    snapPosition: SnapPosition
)

Create and remember a FlingBehavior for decayed snapping in Lazy Lists.

Cmn

Functions

rememberSnapFlingBehavior

@Composable
fun rememberSnapFlingBehavior(
    snapLayoutInfoProvider: SnapLayoutInfoProvider
): TargetedFlingBehavior

Creates and remember a FlingBehavior that performs snapping.

Parameters
snapLayoutInfoProvider: SnapLayoutInfoProvider

The information about the layout that will do snapping

rememberSnapFlingBehavior

@Composable
fun rememberSnapFlingBehavior(
    lazyGridState: LazyGridState,
    snapPosition: SnapPosition = SnapPosition.Center
): FlingBehavior

Create and remember a FlingBehavior for decayed snapping in Lazy Grids. This will snap the item according to snapPosition.

Parameters
lazyGridState: LazyGridState

The LazyGridState from the LazyGrid where this FlingBehavior will be used.

snapPosition: SnapPosition = SnapPosition.Center

The desired positioning of the snapped item within the main layout. This position should be considered with regards to the start edge of the item and the placement within the viewport.

rememberSnapFlingBehavior

@Composable
fun rememberSnapFlingBehavior(
    lazyListState: LazyListState,
    snapPosition: SnapPosition = SnapPosition.Center
): FlingBehavior

Create and remember a FlingBehavior for decayed snapping in Lazy Lists. This will snap the item according to snapPosition.

Parameters
lazyListState: LazyListState

The LazyListState from the LazyList where this FlingBehavior will be used.

snapPosition: SnapPosition = SnapPosition.Center

The desired positioning of the snapped item within the main layout. This position should be considered with regards to the start edge of the item and the placement within the viewport.