Start native apps faster with the Composables CLI ->
Composable Function

rememberDeferredTransition

Creates and remembers a DeferredTransition for a given DeferredTransitionState.

rememberDeferredTransition

Source set: Common
@Composable
public fun <T> rememberDeferredTransition(
    transitionState: DeferredTransitionState<T>,
    label: String? = null,
): DeferredTransition<T>

Creates and remembers a DeferredTransition for a given DeferredTransitionState.

A DeferredTransition allows for a two-stage state update:

    targetState remains unchanged, while the new target is exposed via pendingTargetState. This allows higher-level components to implement custom behavior (e.g., manual gesture tracking) while the automatic transition is "held".

  1. Deferred Phase: Initiated by DeferredTransitionState.defer. The transition's

    2. pendingTargetState is cleared and targetState is updated, starting the automatic transition animations.

  2. Automatic Phase: Initiated by DeferredTransitionState.animateTo. The

Parameters
transitionState The DeferredTransitionState that manages the current and target states.
label An optional label for the transition to be displayed in Android Studio's Animation Preview.

Return

A DeferredTransition that will update whenever transitionState changes.