Compose Multiplatform Material3/androidx.compose.material3/FloatingToolbarDefaults

FloatingToolbarDefaults

object FloatingToolbarDefaults

Contains default values used for the floating toolbar implementations.

Properties

ContainerCollapsedElevation

val ContainerCollapsedElevation: Dp

Default collapsed elevation used for HorizontalFloatingToolbar and VerticalFloatingToolbar

ContainerCollapsedElevationWithFab

val ContainerCollapsedElevationWithFab: Dp

Default collapsed elevation used for HorizontalFloatingToolbar and VerticalFloatingToolbar with FAB.

ContainerExpandedElevation

val ContainerExpandedElevation: Dp

Default expanded elevation used for HorizontalFloatingToolbar and VerticalFloatingToolbar

ContainerExpandedElevationWithFab

val ContainerExpandedElevationWithFab: Dp

Default expanded elevation used for HorizontalFloatingToolbar and VerticalFloatingToolbar with FAB.

ContainerShape

@get:Composable

val ContainerShape: Shape

Default shape used for HorizontalFloatingToolbar and VerticalFloatingToolbar

ContainerSize

val ContainerSize: Dp

Default size used for HorizontalFloatingToolbar and VerticalFloatingToolbar container

ContentPadding

val ContentPadding: PaddingValues

Default padding used for HorizontalFloatingToolbar and VerticalFloatingToolbar when content are default size (24dp) icons in IconButton that meet the minimum touch target (48.dp).

ScreenOffset

val ScreenOffset: Dp

Default offset from the edge of the screen used for HorizontalFloatingToolbar and VerticalFloatingToolbar.

ScrollDistanceThreshold

val ScrollDistanceThreshold: Dp

A default threshold in Dp for the content's scrolling that defines when the toolbar should be collapsed or expanded.

Functions

animationSpec

@Composable

fun <T> animationSpec(): FiniteAnimationSpec<T>

Returns a default animation spec used for HorizontalFloatingToolbars and VerticalFloatingToolbars.

exitAlwaysScrollBehavior

@Composable

fun exitAlwaysScrollBehavior(exitDirection: FloatingToolbarExitDirection, state: FloatingToolbarState = rememberFloatingToolbarState(), snapAnimationSpec: AnimationSpec<Float> = MotionSchemeKeyTokens.DefaultEffects.value(), flingAnimationSpec: DecayAnimationSpec<Float> = rememberSplineBasedDecay()): FloatingToolbarScrollBehavior

Returns a FloatingToolbarScrollBehavior. A floating toolbar that is set up with this FloatingToolbarScrollBehavior will immediately collapse when the content is pulled up, and will immediately appear when the content is pulled down.

floatingToolbarVerticalNestedScroll

fun Modifier.floatingToolbarVerticalNestedScroll(expanded: Boolean, onExpand: () -> Unit, onCollapse: () -> Unit, expandScrollDistanceThreshold: Dp = ScrollDistanceThreshold, collapseScrollDistanceThreshold: Dp = ScrollDistanceThreshold, reverseLayout: Boolean = false): Modifier

This Modifier tracks vertical scroll events on the scrolling container that a floating toolbar appears above. It then calls onExpand and onCollapse to adjust the toolbar's state based on the scroll direction and distance.

horizontalEnterTransition

@Composable

fun horizontalEnterTransition(expandFrom: Alignment.Horizontal): EnterTransition

Default enter transition used for HorizontalFloatingToolbar when expanding

horizontalExitTransition

@Composable

fun horizontalExitTransition(shrinkTowards: Alignment.Horizontal): ExitTransition

Default exit transition used for HorizontalFloatingToolbar when shrinking

StandardFloatingActionButton

@Composable

fun StandardFloatingActionButton(onClick: () -> Unit, modifier: Modifier = Modifier, shape: Shape = FloatingActionButtonDefaults.shape, containerColor: Color = standardFloatingToolbarColors().fabContainerColor, contentColor: Color = standardFloatingToolbarColors().fabContentColor, interactionSource: MutableInteractionSource? = null, content: @Composable () -> Unit)

Creates a FloatingActionButton that represents a toolbar floating action button with standard colors.

standardFloatingToolbarColors

@Composable

fun standardFloatingToolbarColors(): FloatingToolbarColors

@Composable

fun standardFloatingToolbarColors(toolbarContainerColor: Color = Color.Unspecified, toolbarContentColor: Color = Color.Unspecified, fabContainerColor: Color = Color.Unspecified, fabContentColor: Color = Color.Unspecified): FloatingToolbarColors

Creates a FloatingToolbarColors that represents the default standard colors used in the various floating toolbars.

verticalEnterTransition

@Composable

fun verticalEnterTransition(expandFrom: Alignment.Vertical): EnterTransition

Default enter transition used for VerticalFloatingToolbar when expanding

verticalExitTransition

@Composable

fun verticalExitTransition(shrinkTowards: Alignment.Vertical): ExitTransition

Default exit transition used for VerticalFloatingToolbar when shrinking

VibrantFloatingActionButton

@Composable

fun VibrantFloatingActionButton(onClick: () -> Unit, modifier: Modifier = Modifier, shape: Shape = FloatingActionButtonDefaults.shape, containerColor: Color = vibrantFloatingToolbarColors().fabContainerColor, contentColor: Color = vibrantFloatingToolbarColors().fabContentColor, interactionSource: MutableInteractionSource? = null, content: @Composable () -> Unit)

Creates a FloatingActionButton that represents a toolbar floating action button with vibrant colors.

vibrantFloatingToolbarColors

@Composable

fun vibrantFloatingToolbarColors(): FloatingToolbarColors

@Composable

fun vibrantFloatingToolbarColors(toolbarContainerColor: Color = Color.Unspecified, toolbarContentColor: Color = Color.Unspecified, fabContainerColor: Color = Color.Unspecified, fabContentColor: Color = Color.Unspecified): FloatingToolbarColors

Creates a FloatingToolbarColors that represents the default vibrant colors used in the various floating toolbars.