Compose Unstyled 2.0 is out! Check the official announcement blog ->
Composable Function

rememberTransition

Creates and remembers a DeferredTransition for a given DeferredTransitionState.

rememberTransition

Source set: Common
@ExperimentalDeferredTransitionApi
@Composable
public fun <T> rememberTransition(
    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:

  1. Deferred Phase: Initiated by DeferredTransitionState.defer. The transition's 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".
  2. Automatic Phase: Initiated by DeferredTransitionState.animateTo. The pendingTargetState is cleared and targetState is updated, starting the automatic transition animations.

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.

Returns
A DeferredTransition that will update whenever transitionState changes.

rememberTransition

Source set: Common
@Composable
public fun <T> rememberTransition(
    transitionState: TransitionState<T>,
    label: String? = null,
): Transition<T>

Creates a Transition and puts it in the currentState of the provided transitionState. If the TransitionState.targetState changes, the Transition will change where it will animate to.

Remember: The provided transitionState needs to be remembered.

Compared to updateTransition that takes a targetState, this function supports a different initial state than the first targetState. Here is an example:

In most cases, it is recommended to reuse the same transitionState that is remembered, such that Transition preserves continuity when targetState is changed. However, in some rare cases it is more critical to immediately snap to a state change (e.g. in response to a user interaction). This can be achieved by creating a new transitionState:

Last updated: