litho-core/com.facebook.litho.animation/StyleTransitionScope

StyleTransitionScope

@ExperimentalLithoApi

class StyleTransitionScope

Defines the host properties animated by Style.transition.

Each property is optional. Set a property to an AnimationSpec to animate changes for that property, or set it to null in a later composed transition to remove a previous declaration.

Bounds animate per axis through x, y, width, and height, or as groups through position, size, and bounds. Whether a size change reflows siblings is a mode of the whole host, set only by size and bounds: their functions take reflow, and their properties are visual. The per-axis properties and position refine an axis's spec without changing that mode, so size(spring(), reflow = true); height = tween() still reflows, with height on the tween.

Reading a group property returns its spec only when every axis it covers shares that spec, and null otherwise: after bounds = spring(); height = tween(), bounds and size read null while position still reads the spring.

Properties

var alpha: FiniteAnimationSpec<Float>?

Animates host alpha when the resolved opacity changes.

var bounds: FiniteAnimationSpec<Float>?

Animates mount-space host bounds: x, y, width, and height.

var height: FiniteAnimationSpec<Float>?

Animates the host's mount-space height.

var position: FiniteAnimationSpec<Float>?

Animates the host's mount-space position: x and y.

var rotation: FiniteAnimationSpec<Float>?

Animates host rotation around the Z axis, in degrees.

var rotationX: FiniteAnimationSpec<Float>?

Animates host rotation around the X axis, in degrees.

var rotationY: FiniteAnimationSpec<Float>?

Animates host rotation around the Y axis, in degrees.

var scale: FiniteAnimationSpec<Float>?

Animates uniform host scale by writing the same animated value to scaleX and scaleY.

var size: FiniteAnimationSpec<Float>?

Animates the host's mount-space size: width and height.

var width: FiniteAnimationSpec<Float>?

Animates the host's mount-space width.

var x: FiniteAnimationSpec<Float>?

Animates the host's mount-space x position.

var y: FiniteAnimationSpec<Float>?

Animates the host's mount-space y position.

Functions

fun bounds(spec: FiniteAnimationSpec<Float>, reflow: Boolean = false)

Animates mount-space host bounds with spec, like the bounds property.

fun size(spec: FiniteAnimationSpec<Float>, reflow: Boolean = false)

Animates the host's size with spec, like the size property.