Composable Function

AnimatedPane

The root composable of pane contents in a ThreePaneScaffold that supports default motions during pane switching.

RevenueCat

RevenueCat

Add subscriptions to your apps in minutes

Ad Get started for free

Overload 1

Common
@ExperimentalMaterial3AdaptiveApi
@Composable
fun <
    RoleT : PaneScaffoldRole,
    ScaffoldValueT : PaneScaffoldValue<RoleT>,
> ExtendedPaneScaffoldPaneScope<RoleT, ScaffoldValueT>.AnimatedPane(
    modifier: Modifier = Modifier,
    enterTransition: EnterTransition = motionDataProvider.calculateDefaultEnterTransition(paneRole),
    exitTransition: ExitTransition = motionDataProvider.calculateDefaultExitTransition(paneRole),
    boundsAnimationSpec: FiniteAnimationSpec<IntRect> = PaneMotionDefaults.AnimationSpec,
    dragToResizeHandle: (@Composable (DragToResizeState) -> Unit)? = null,
    content: (@Composable AnimatedPaneScope.() -> Unit),
)

The root composable of pane contents in a ThreePaneScaffold that supports default motions during pane switching. It's recommended to use this composable to wrap your own contents when passing them into pane parameters of the scaffold functions, therefore your panes can have a nice default animation for free.

Parameters
modifier The modifier applied to the AnimatedPane.
enterTransition The EnterTransition used to animate the pane in.
exitTransition The ExitTransition used to animate the pane out.
boundsAnimationSpec The FiniteAnimationSpec used to animate the bounds of the pane when the pane is keeping showing but changing its size and/or position.
dragToResizeHandle The optional handle which will shown when the pane is levitated and drag-to-resizable; the handle will be draggable and clickable to resize the pane freely or among collapsed, partially expanded, and expanded states. See rememberDragToResizeState for more details about how to implement the drag-to-resize behavior.
content The content of the AnimatedPane. Also see AnimatedPaneScope.
Common
Deprecated Keep the old function for binary compatibility

Overload 2

@ExperimentalMaterial3AdaptiveApi
@Composable
fun <
    RoleT : PaneScaffoldRole,
    ScaffoldValueT : PaneScaffoldValue<RoleT>,
> ExtendedPaneScaffoldPaneScope<RoleT, ScaffoldValueT>.AnimatedPane(
    modifier: Modifier = Modifier,
    enterTransition: EnterTransition = motionDataProvider.calculateDefaultEnterTransition(paneRole),
    exitTransition: ExitTransition = motionDataProvider.calculateDefaultExitTransition(paneRole),
    boundsAnimationSpec: FiniteAnimationSpec<IntRect> = PaneMotionDefaults.AnimationSpec,
    content: (@Composable AnimatedPaneScope.() -> Unit),
) = AnimatedPane(modifier, enterTransition, exitTransition, boundsAnimationSpec, null, content)

The root composable of pane contents in a ThreePaneScaffold that supports default motions during pane switching. It's recommended to use this composable to wrap your own contents when passing them into pane parameters of the scaffold functions, therefore your panes can have a nice default animation for free.

Parameters
modifier The modifier applied to the AnimatedPane.
enterTransition The EnterTransition used to animate the pane in.
exitTransition The ExitTransition used to animate the pane out.
boundsAnimationSpec The FiniteAnimationSpec used to animate the bounds of the pane when the pane is keeping showing but changing its size and/or position.
content The content of the AnimatedPane. Also see AnimatedPaneScope.