circuit-foundation/com.slack.circuit.foundation/AnimatedNavDecorator

AnimatedNavDecorator

interface AnimatedNavDecorator<T : NavArgument, S : AnimatedNavState>(source)

todo Finish docs.

AnimatedNavDecorator is used by AnimatedNavDecoration as a way to provide hooks into its AnimatedContent, allowing for custom navigation animations.

Inheritors

DefaultDecorator

Types

interface Factory

Functions

abstract fun AnimatedContentScope.Decoration(targetState: S, innerContent: @Composable (T) -> Unit)

For the targetState, decorate the innerContent as the content of AnimatedContent

abstract fun targetState(args: ImmutableList<T>, backStackDepth: Int): S

For the args and backstack create the expected target AnimatedNavState.

abstract fun Transition<S>.transitionSpec(): AnimatedContentTransitionScope<S>.() -> ContentTransform

Builds the AnimatedContent transition spec.

updateTransition

abstract fun updateTransition(args: ImmutableList<T>, backStackDepth: Int): Transition<S>

Sets up a Transition for driving an AnimatedContent used to navigate between screens. The transition should be setup from the current NavDecoration.DecoratedContent arguments and backstack depth, and then updated when the arguments or backstack depth change.