circuit-foundation/com.slack.circuit.foundation/NavigatorDefaults/DefaultDecorator

DefaultDecorator

class DefaultDecorator<T : NavArgument> : AnimatedNavDecorator<T, NavigatorDefaults.DefaultDecorator.DefaultAnimatedState<T>> (source)

Constructors

DefaultDecorator

constructor()

Types

DefaultAnimatedState

data class DefaultAnimatedState<T : NavArgument>(val args: ImmutableList<T>) : AnimatedNavState

Functions

Decoration

@Composable

open override fun AnimatedContentScope.Decoration(targetState: NavigatorDefaults.DefaultDecorator.DefaultAnimatedState<T>, innerContent: @Composable (T) -> Unit)

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

targetState

open override fun targetState(args: ImmutableList<T>, backStackDepth: Int): NavigatorDefaults.DefaultDecorator.DefaultAnimatedState<T>

For the args and backstack create the expected target AnimatedNavState.

transitionSpec

@Composable

open override fun Transition<NavigatorDefaults.DefaultDecorator.DefaultAnimatedState<T>>.transitionSpec(): AnimatedContentTransitionScope<NavigatorDefaults.DefaultDecorator.DefaultAnimatedState<T>>.() -> ContentTransform

Builds the AnimatedContent transition spec.

updateTransition

@Composable

open override fun updateTransition(args: ImmutableList<T>, backStackDepth: Int): Transition<NavigatorDefaults.DefaultDecorator.DefaultAnimatedState<T>>

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.