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

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

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

For the args create the expected target AnimatedNavState.

open override fun AnimatedContentTransitionScope<AnimatedNavState>.transitionSpec(animatedNavEvent: AnimatedNavEvent): ContentTransform

Builds the default AnimatedContent transition spec.

updateTransition

open override fun updateTransition(args: ImmutableList<T>): 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 then updated when the arguments change.