swing-ui-animation/org.jetbrains.compose.swing.animation/AnimatedContentTransitionScope

AnimatedContentTransitionScope

sealed interface AnimatedContentTransitionScope<S> : Transition.Segment<S>

The receiver of an AnimatedContent's transitionSpec: a segment of the container's transition, plus slides into and out of the container's edges, which need the container's size.

AnimatedContent(
    targetState = page,
    transitionSpec = {
        slideIntoContainer(SlideDirection.Left) togetherWith slideOutOfContainer(SlideDirection.Left)
    },
) { Page(it) }

Types

SlideDirection

@Immutable

@JvmInline

value class SlideDirection

Which way content travels in slideIntoContainer and out in slideOutOfContainer.

Properties

contentAlignment

abstract val contentAlignment: Alignment

Where the container places content inside itself; the AnimatedContent's own parameter.

initialState

abstract val initialState: S

Initial state of a Transition Segment. This is the state that transition starts from.

KeepUntilTransitionsFinished

open val ExitTransition.Companion.KeepUntilTransitionsFinished: ExitTransition

An exit transition that keeps the old content composed until the whole transition has finished, instead of removing it when its own exit ends.

targetState

abstract val targetState: S

Target state of a Transition Segment. This is the state that transition will end on.

Functions

isTransitioningTo

open infix fun S.isTransitioningTo(targetState: S): Boolean

Returns whether the provided state matches the initialState&& the provided targetState matches Segment.targetState.

slideIntoContainer

abstract fun slideIntoContainer(towards: AnimatedContentTransitionScope.SlideDirection, animationSpec: FiniteAnimationSpec<Point> = spring(visibilityThreshold = pointVisibilityThreshold()), initialOffset: (offsetForFullSlide: Int) -> Int = { it }): EnterTransition

Slides the arriving content in from the container's edge, traveling towards.

slideOutOfContainer

abstract fun slideOutOfContainer(towards: AnimatedContentTransitionScope.SlideDirection, animationSpec: FiniteAnimationSpec<Point> = spring(visibilityThreshold = pointVisibilityThreshold()), targetOffset: (offsetForFullSlide: Int) -> Int = { it }): ExitTransition

Slides the old content out to the container's edge, traveling towards.

using

abstract infix fun ContentTransform.using(sizeTransform: SizeTransform?): ContentTransform

Replaces the SizeTransform of this content transform. using null turns off the size animation.