decompose-extensions/com.nxoim.caif.decompose

Package-level declarations

Types

class CupertinoStackAnimation(overlayAlphaPerDepth: Float = CupertinoOverlayAlphaPerDepthDefault, slideSpringDuration: Duration = 320.milliseconds) : BaseItemAnimation<StackAnimationContext> , SwipeCapability

DecomposeAnimationFactory

fun interface DecomposeAnimationFactory<in Configuration : Any, in Child : Any> : ItemAnimationFactory<Child, Configuration, StackAnimationContext>

MaterialStackAnimation

class MaterialStackAnimation : BaseItemAnimation<StackAnimationContext> , PredictiveBackCapability

PredictiveBackCapability

interface PredictiveBackCapability

PredictiveBackCapabilityDispatcher

class PredictiveBackCapabilityDispatcher(cycleController: StackCycleController) : BaseCapabilityDispatcher<PredictiveBackCapability>

StackAnimationContext

data class StackAnimationContext(val position: StackItemPosition, val environment: StackAnimationEnvironment)

StackAnimationEnvironment

data class StackAnimationEnvironment(val viewportSize: Size, val layoutDirection: LayoutDirection, val density: Density)

StackGestureParticipant

class StackGestureParticipant(canPop: () -> Boolean, parent: BackGestureParticipant?, startLocal: () -> Unit, updateLocal: Density.(Offset, Long, SwipeDirection) -> Unit, confirmLocal: Density.(Velocity) -> Unit, cancelLocal: Density.(Velocity) -> Unit) : BackGestureParticipant

SwipeCapability

interface SwipeCapability

SwipeCapabilityDispatcher

class SwipeCapabilityDispatcher(cycleController: StackCycleController) : BaseCapabilityDispatcher<SwipeCapability>

Properties

LocalDecomposeAnimationFactory

val LocalDecomposeAnimationFactory: ProvidableCompositionLocal<DecomposeAnimationFactory<Any, Any>>

LocalParentBackGesture

val LocalParentBackGesture: ProvidableCompositionLocal<BackGestureParticipant?>

Functions

adaptiveOverlayAlpha

fun adaptiveOverlayAlpha(position: StackItemPosition, overlayAlphaPerDepth: Float = AdaptiveOverlayAlphaPerDepthDefault): Float

adaptiveStackAnimation

fun adaptiveStackAnimation(overlayAlphaPerDepth: Float = CupertinoOverlayAlphaPerDepthDefault, slideSpringDuration: Duration = 320.milliseconds): ItemAnimation<StackAnimationContext>

cupertinoOverlayAlpha

fun cupertinoOverlayAlpha(position: StackItemPosition, overlayAlphaPerDepth: Float = AdaptiveOverlayAlphaPerDepthDefault): Float

cupertinoStackAnimation

fun cupertinoStackAnimation(overlayAlphaPerDepth: Float = CupertinoOverlayAlphaPerDepthDefault, slideSpringDuration: Duration = 320.milliseconds): ItemAnimation<StackAnimationContext>

decomposeAnimations

fun <Configuration : Any, Child : Any> decomposeAnimations(default: () -> ItemAnimation<StackAnimationContext> = { adaptiveStackAnimation() }): DecomposeAnimationFactory<Configuration, Child>

Creates a DecomposeAnimationFactory with a default animation for all items.

fun <Configuration : Any, Child : Any> decomposeAnimations(selector: (Child) -> ItemAnimation<StackAnimationContext>): DecomposeAnimationFactory<Configuration, Child>

Creates an exhaustive DecomposeAnimationFactory mapping Child to animations.

fun <Configuration : Any, Child : Any> decomposeAnimations(selector: (Configuration, Child) -> ItemAnimation<StackAnimationContext>): DecomposeAnimationFactory<Configuration, Child>

Creates an exhaustive DecomposeAnimationFactory mapping Configuration and Child to animations.

fun <Configuration : Any, Child : Any> decomposeAnimations(default: () -> ItemAnimation<StackAnimationContext>, selector: (Child) -> ItemAnimation<StackAnimationContext>?): DecomposeAnimationFactory<Configuration, Child>

Creates a DecomposeAnimationFactory with a customizable default fallback.

decomposeKeyBackHandler

@Composable

fun Modifier.decomposeKeyBackHandler(canPop: Boolean, onPop: () -> Unit, predictiveBackDispatcher: PredictiveBackCapabilityDispatcher, animationSpec: AnimationSpec<Float> = smooth(), initialVelocity: Float = 20.0f, scope: CoroutineScope = rememberCoroutineScope()): Modifier

DecomposeStack

@Composable

fun <Configuration : Any, Child : Any> DecomposeStack(stack: Value<ChildStack<Configuration, Child>>, onPop: () -> Unit, modifier: Modifier = Modifier, backHandler: BackHandler? = null, animationFactory: DecomposeAnimationFactory<Configuration, Child> = remember { DecomposeAnimationFactory() }, enableGestures: Boolean = true, content: @Composable AnimatedVisibilityScope.(Child) -> Unit)

@Composable

fun <Configuration : Any, Child : Any> DecomposeStack(stack: Value<ChildStack<Configuration, Child>>, onPop: () -> Unit, animations: (Child) -> ItemAnimation<StackAnimationContext>, modifier: Modifier = Modifier, backHandler: BackHandler? = null, enableGestures: Boolean = true, content: @Composable AnimatedVisibilityScope.(Child) -> Unit)

materialStackAnimation

fun materialStackAnimation(): ItemAnimation<StackAnimationContext>

rememberDecomposeAnimations

@Composable

fun <Configuration : Any, Child : Any> rememberDecomposeAnimations(default: () -> ItemAnimation<StackAnimationContext> = { adaptiveStackAnimation() }): DecomposeAnimationFactory<Configuration, Child>

Creates a remembered DecomposeAnimationFactory with a default animation for all items.

@Composable

fun <Configuration : Any, Child : Any> rememberDecomposeAnimations(selector: (Child) -> ItemAnimation<StackAnimationContext>): DecomposeAnimationFactory<Configuration, Child>

Creates a remembered DecomposeAnimationFactory mapping Child to animations.

@Composable

fun <Configuration : Any, Child : Any> rememberDecomposeAnimations(selector: (Configuration, Child) -> ItemAnimation<StackAnimationContext>): DecomposeAnimationFactory<Configuration, Child>

Creates a remembered DecomposeAnimationFactory mapping Configuration and Child to animations.

rememberStackAnimationEnvironmentState

@Composable

fun BoxWithConstraintsScope.rememberStackAnimationEnvironmentState(): State<StackAnimationEnvironment>

selectableStackAnimation

fun selectableStackAnimation(swipe: () -> ItemAnimation<StackAnimationContext> = { CupertinoStackAnimation() }, predictiveBack: () -> ItemAnimation<StackAnimationContext> = { MaterialStackAnimation() }): ItemAnimation<StackAnimationContext>

stackAnimationContextFactory

fun <ItemType> stackAnimationContextFactory(environment: () -> StackAnimationEnvironment): ContextFactory<ItemType, StackAnimationContext, StackCreationContext<ItemType>>

StackBackHandler

@Composable

fun StackBackHandler(backHandler: BackHandler, canPop: Boolean, predictiveBackDispatcher: PredictiveBackCapabilityDispatcher, onPop: () -> Unit)

updatedCupertinoSlideOffset

fun updatedCupertinoSlideOffset(current: Offset, delta: Offset): Offset