circuit-foundation/com.slack.circuit.foundation.animation

Package-level declarations

Types

class AnimatedNavDecoration(animatedScreenTransforms: ImmutableMap<KClass<out Screen>, AnimatedScreenTransform>, decoratorFactory: AnimatedNavDecorator.Factory) : NavDecoration

AnimatedNavDecoration is an implementation of NavDecoration that provides the Navigation AnimatedVisibilityScope for shared elements. It also allows for indepth customization of its AnimatedContent through a AnimatedNavDecorator. AnimatedNavDecoration is the default NavDecoration used by Circuit.

AnimatedNavDecorator

@Stable

interface AnimatedNavDecorator<T : NavArgument, S : AnimatedNavState>

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

AnimatedNavEvent

enum AnimatedNavEvent : Enum<AnimatedNavEvent>

Represents the type of navigation event that occurred within the context of an AnimatedNavDecoration. This is used to drive transitions and other navigation-related behaviors within the AnimatedNavDecoration.

AnimatedNavState

@Stable

interface AnimatedNavState

A state created for the Transition in AnimatedNavDecorator.Decoration.

AnimatedScreenTransform

interface AnimatedScreenTransform

Defines the animated transitions fo a Screen based on particular AnimatedNavEvents.

NoOpAnimatedScreenTransform

object NoOpAnimatedScreenTransform : AnimatedScreenTransform

A default AnimatedScreenTransform that does nothing.

PartialContentTransform

data class PartialContentTransform(val enter: EnterTransition?, val exit: ExitTransition?, val zIndex: Float?, val sizeTransform: SizeTransform?)

Represents a partial ContentTransform for animated navigation.

Functions

asPartialContentTransform

fun ContentTransform.asPartialContentTransform(): PartialContentTransform

Converts a ContentTransform to a PartialContentTransform.