Whether the current stack item and all of its enclosing stack items participate in their visibility transitions. Content remains composed when this is false.

Functions

defaultStackContextResolver

fun <Context, ItemType, Key : Any> defaultStackContextResolver(contextFactory: ContextFactory<ItemType, Context, StackCreationContext<ItemType>>, keyFor: (ItemType) -> Key): ContextResolver<ItemType, Key, Context, StackCreationContext<ItemType>>

getOrCreateDispatcher

inline fun <D : CapabilityDispatcher> StackAnimatorState<*, *, *>.getOrCreateDispatcher(noinline factory: (StackCycleController) -> D): D

indexOf

fun <ItemType> StackCreationContext<ItemType>.indexOf(item: ItemType): Int

previousIndexOf

fun <ItemType> StackCreationContext<ItemType>.previousIndexOf(item: ItemType): Int?

rememberStackAnimatorState

@Composable

fun <ItemType, Key : Any, Context, CreationContext> rememberStackAnimatorState(stack: State<List<ItemType>>, factory: ItemAnimationFactory<ItemType, Key, Context>, resolver: ContextResolver<ItemType, Key, Context, CreationContext>, affectedItemsPolicy: AffectedItemsPolicy<ItemType, Key, Context> = remember { AffectedItemsPolicy.fromTop() }, maxAffected: Int = Int.MAX_VALUE, scope: CoroutineScope = rememberCoroutineScope(), renderOrder: RenderOrderStrategy<Key> = remember { RenderOrderStrategy.insertionOrder() }): StackAnimatorState<ItemType, Key, Context>

@Composable

@JvmName(name = "rememberStackAnimatorStateStackItemContext")

fun <ItemType, Key : Any> rememberStackAnimatorState(stack: State<List<ItemType>>, keyFor: (ItemType) -> Key, factory: ItemAnimationFactory<ItemType, Key, StackItemPosition>, affectedItemsPolicy: AffectedItemsPolicy<ItemType, Key, StackItemPosition> = remember { AffectedItemsPolicy.fromTop() }, maxAffected: Int = Int.MAX_VALUE, scope: CoroutineScope = rememberCoroutineScope(), renderOrder: RenderOrderStrategy<Key> = remember { RenderOrderStrategy.insertionOrder() }): StackAnimatorState<ItemType, Key, StackItemPosition>

@Composable

fun <ItemType, Key : Any, Context> rememberStackAnimatorState(stack: State<List<ItemType>>, keyFor: (ItemType) -> Key, factory: ItemAnimationFactory<ItemType, Key, Context>, contextFactory: ContextFactory<ItemType, Context, StackCreationContext<ItemType>>, affectedItemsPolicy: AffectedItemsPolicy<ItemType, Key, Context> = remember { AffectedItemsPolicy.fromTop() }, maxAffected: Int = Int.MAX_VALUE, scope: CoroutineScope = rememberCoroutineScope(), renderOrder: RenderOrderStrategy<Key> = remember { RenderOrderStrategy.insertionOrder() }): StackAnimatorState<ItemType, Key, Context>

StackAnimatorLayout

@Composable

fun <ItemType : Any, Key : Any, Context> StackAnimatorLayout(animator: StackAnimatorState<ItemType, Key, Context>, modifier: Modifier = Modifier, retentionPolicy: StackTransitionRetentionPolicy<Key> = StackTransitionRetentionPolicy.adjacent(), parentAnimatedVisibilityScope: AnimatedVisibilityScope? = LocalStackAnimatedVisibilityScope.current, content: @Composable AnimatedVisibilityScope.(Key, ItemType) -> Unit)

Renders stack items with an AnimatedVisibilityScope derived from the topmost stack item.

@Composable

fun <ItemType, Key : Any, Context> StackAnimatorLayout(animator: StackAnimatorState<ItemType, Key, Context>, transition: Transition<Key?>, parentAnimatedVisibilityScope: AnimatedVisibilityScope?, modifier: Modifier = Modifier, retainWhileTransitionRunning: (Key, ItemType) -> Boolean = { _, _ -> true }, content: @Composable AnimatedVisibilityScope.(Key, ItemType) -> Unit)

Renders stack items with an AnimatedVisibilityScope derived from transition.