CarouselParallaxScrollEffectState

A state holder for scrollable items to track effect values that are applied by the carouselParallaxScrollEffect modifier.

Use one of the CarouselParallaxScrollEffectState functions to create an instance of this interface using LazyListState or LazyGridState, or implement the interface directly for a custom layout.

Summary

Public functions
CarouselParallaxScrollEffectItemInfo

Returns visual effect values (CarouselParallaxScrollEffectItemInfo) for the item at index.
Cmn

Public properties
Orientation

The scroll orientation of the container.
Cmn

Public functions

calculateItemInfo

Cmn
Added in 1.5.0-alpha28
@FrequentlyChangingValue
fun calculateItemInfo(index: Int): CarouselParallaxScrollEffectItemInfo

Returns visual effect values (CarouselParallaxScrollEffectItemInfo) for the item at index.

Note that this function should not be called during composition. Make sure to call getItemInfo from a graphics, layout, or other Modifier.Node where changes to the underlying info will not cause unwanted recompositions.

Public properties

orientation

Cmn
Added in 1.5.0-alpha28
val orientation: Orientation

The scroll orientation of the container.