FloatingToolbarDefaults

Artifact: androidx.compose.material3:material3

Cmn

@ExperimentalMaterial3ExpressiveApi
object FloatingToolbarDefaults

Contains default values used for the floating toolbar implementations.

Summary

Public functions
`Unit`	`@Composable StandardFloatingActionButton( onClick: () -> Unit, modifier: Modifier, shape: Shape, containerColor: Color, contentColor: Color, interactionSource: MutableInteractionSource?, content: @Composable () -> Unit )` Creates a `FloatingActionButton` that represents a toolbar floating action button with standard colors.	Cmn
`Unit`	`@Composable VibrantFloatingActionButton( onClick: () -> Unit, modifier: Modifier, shape: Shape, containerColor: Color, contentColor: Color, interactionSource: MutableInteractionSource?, content: @Composable () -> Unit )` Creates a `FloatingActionButton` that represents a toolbar floating action button with vibrant colors.	Cmn
`FiniteAnimationSpec<T>`	`@Composable <T : Any?> animationSpec()` Returns a default animation spec used for `HorizontalFloatingToolbar`s and `VerticalFloatingToolbar`s.	Cmn
`FloatingToolbarScrollBehavior`	`@ExperimentalMaterial3ExpressiveApi @Composable exitAlwaysScrollBehavior( exitDirection: FloatingToolbarExitDirection, state: FloatingToolbarState, snapAnimationSpec: AnimationSpec<Float>, flingAnimationSpec: DecayAnimationSpec<Float> )` Returns a `FloatingToolbarScrollBehavior`.	Cmn
`Modifier`	`Modifier.floatingToolbarVerticalNestedScroll( expanded: Boolean, onExpand: () -> Unit, onCollapse: () -> Unit, expandScrollDistanceThreshold: Dp, collapseScrollDistanceThreshold: Dp, reverseLayout: Boolean )` This `Modifier` tracks vertical scroll events on the scrolling container that a floating toolbar appears above.	Cmn
`EnterTransition`	`@Composable horizontalEnterTransition(expandFrom: Alignment.Horizontal)` Default enter transition used for `HorizontalFloatingToolbar` when expanding	Cmn
`ExitTransition`	`@Composable horizontalExitTransition(shrinkTowards: Alignment.Horizontal)` Default exit transition used for `HorizontalFloatingToolbar` when shrinking	Cmn
`FloatingToolbarColors`	`@Composable standardFloatingToolbarColors()` Creates a `FloatingToolbarColors` that represents the default standard colors used in the various floating toolbars.	Cmn
`FloatingToolbarColors`	`@Composable standardFloatingToolbarColors( toolbarContainerColor: Color, toolbarContentColor: Color, fabContainerColor: Color, fabContentColor: Color )` Creates a `FloatingToolbarColors` that represents the default standard colors used in the various floating toolbars.	Cmn
`EnterTransition`	`@Composable verticalEnterTransition(expandFrom: Alignment.Vertical)` Default enter transition used for `VerticalFloatingToolbar` when expanding	Cmn
`ExitTransition`	`@Composable verticalExitTransition(shrinkTowards: Alignment.Vertical)` Default exit transition used for `VerticalFloatingToolbar` when shrinking	Cmn
`FloatingToolbarColors`	`@Composable vibrantFloatingToolbarColors()` Creates a `FloatingToolbarColors` that represents the default vibrant colors used in the various floating toolbars.	Cmn
`FloatingToolbarColors`	`@Composable vibrantFloatingToolbarColors( toolbarContainerColor: Color, toolbarContentColor: Color, fabContainerColor: Color, fabContentColor: Color )` Creates a `FloatingToolbarColors` that represents the default vibrant colors used in the various floating toolbars.	Cmn

Public properties
`Dp`	`ContainerElevation` Default elevation used for `HorizontalFloatingToolbar` and `VerticalFloatingToolbar`	Cmn
`Shape`	`ContainerShape` Default shape used for `HorizontalFloatingToolbar` and `VerticalFloatingToolbar`	Cmn
`Dp`	`ContainerSize` Default size used for `HorizontalFloatingToolbar` and `VerticalFloatingToolbar` container	Cmn
`PaddingValues`	`ContentPadding` Default padding used for `HorizontalFloatingToolbar` and `VerticalFloatingToolbar` when content are default size (24dp) icons in `IconButton` that meet the minimum touch target (48.dp).	Cmn
`Dp`	`ScreenOffset` Default offset from the edge of the screen used for `HorizontalFloatingToolbar` and `VerticalFloatingToolbar`.	Cmn
`Dp`	`ScrollDistanceThreshold` A default threshold in `Dp` for the content's scrolling that defines when the toolbar should be collapsed or expanded.	Cmn

Public functions

StandardFloatingActionButton

Cmn

@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
): Unit

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

The FAB's elevation will be controlled by the floating toolbar.

Parameters
`onClick: () -> Unit`	called when this FAB is clicked
`modifier: Modifier = Modifier`	the `Modifier` to be applied to this FAB
`shape: Shape = FloatingActionButtonDefaults.shape`	defines the shape of this FAB's container and shadow
`containerColor: Color = standardFloatingToolbarColors().fabContainerColor`	the color used for the background of this FAB. Defaults to the `FloatingToolbarColors.fabContainerColor` from the `standardFloatingToolbarColors`.
`contentColor: Color = standardFloatingToolbarColors().fabContentColor`	the preferred color for content inside this FAB. Defaults to the `FloatingToolbarColors.fabContentColor` from the `standardFloatingToolbarColors`.
`interactionSource: MutableInteractionSource? = null`	an optional hoisted `MutableInteractionSource` for observing and emitting `Interaction`s for this FAB. You can use this to change the FAB's appearance or preview the FAB in different states. Note that if `null` is provided, interactions will still happen internally.
`content: @Composable () -> Unit`	the content of this FAB, typically an `Icon`

VibrantFloatingActionButton

Cmn

@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
): Unit

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

The FAB's elevation will be controlled by the floating toolbar.

Parameters
`onClick: () -> Unit`	called when this FAB is clicked
`modifier: Modifier = Modifier`	the `Modifier` to be applied to this FAB
`shape: Shape = FloatingActionButtonDefaults.shape`	defines the shape of this FAB's container and shadow
`containerColor: Color = vibrantFloatingToolbarColors().fabContainerColor`	the color used for the background of this FAB. Defaults to the `FloatingToolbarColors.fabContainerColor` from the `vibrantFloatingToolbarColors`.
`contentColor: Color = vibrantFloatingToolbarColors().fabContentColor`	the preferred color for content inside this FAB. Defaults to the `FloatingToolbarColors.fabContentColor` from the `vibrantFloatingToolbarColors`.
`interactionSource: MutableInteractionSource? = null`	an optional hoisted `MutableInteractionSource` for observing and emitting `Interaction`s for this FAB. You can use this to change the FAB's appearance or preview the FAB in different states. Note that if `null` is provided, interactions will still happen internally.
`content: @Composable () -> Unit`	the content of this FAB, typically an `Icon`

animationSpec

Cmn

Added in 1.4.0-alpha06

@Composable
fun <T : Any?> animationSpec(): FiniteAnimationSpec<T>

Returns a default animation spec used for HorizontalFloatingToolbars and VerticalFloatingToolbars.

exitAlwaysScrollBehavior

Cmn

@ExperimentalMaterial3ExpressiveApi
@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.

Parameters
`exitDirection: FloatingToolbarExitDirection`	indicates the direction towards which the floating toolbar exits the screen
`state: FloatingToolbarState = rememberFloatingToolbarState()`	the state object to be used to control or observe the floating toolbar's scroll state. See `rememberFloatingToolbarState` for a state that is remembered across compositions.
`snapAnimationSpec: AnimationSpec<Float> = MotionSchemeKeyTokens.DefaultEffects.value()`	an `AnimationSpec` that defines how the floating toolbar snaps to either fully collapsed or fully extended state when a fling or a drag scrolled it into an intermediate position
`flingAnimationSpec: DecayAnimationSpec<Float> = rememberSplineBasedDecay()`	an `DecayAnimationSpec` that defines how to fling the floating app bar when the user flings the toolbar itself, or the content below it

floatingToolbarVerticalNestedScroll

Cmn

Artifact: androidx.compose.material3:material3

View Source

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.

Essentially, it expands the toolbar when you scroll down past a certain threshold and collapses it when you scroll back up. You can customize the expand and collapse thresholds through the expandScrollDistanceThreshold and collapseScrollDistanceThreshold.

Parameters
`expanded: Boolean`	the current expanded state of the floating toolbar
`onExpand: () -> Unit`	callback to be invoked when the toolbar should expand
`onCollapse: () -> Unit`	callback to be invoked when the toolbar should collapse
`expandScrollDistanceThreshold: Dp = ScrollDistanceThreshold`	the scroll distance (in dp) required to trigger an `onExpand`
`collapseScrollDistanceThreshold: Dp = ScrollDistanceThreshold`	the scroll distance (in dp) required to trigger an `onCollapse`
`reverseLayout: Boolean = false`	indicates that the scrollable content has a reversed scrolling direction

horizontalEnterTransition

Cmn

Added in 1.4.0-alpha06

@Composable
fun horizontalEnterTransition(expandFrom: Alignment.Horizontal): EnterTransition

Default enter transition used for HorizontalFloatingToolbar when expanding

horizontalExitTransition

Cmn

Added in 1.4.0-alpha06

@Composable
fun horizontalExitTransition(shrinkTowards: Alignment.Horizontal): ExitTransition

Default exit transition used for HorizontalFloatingToolbar when shrinking

standardFloatingToolbarColors

Cmn

Added in 1.4.0-alpha06

@Composable
fun standardFloatingToolbarColors(): FloatingToolbarColors

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

standardFloatingToolbarColors

Cmn

@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.

Parameters
`toolbarContainerColor: Color = Color.Unspecified`	the container color for the floating toolbar.
`toolbarContentColor: Color = Color.Unspecified`	the content color for the floating toolbar.
`fabContainerColor: Color = Color.Unspecified`	the container color for an adjacent floating action button.
`fabContentColor: Color = Color.Unspecified`	the content color for an adjacent floating action button.

verticalEnterTransition

Cmn

Added in 1.4.0-alpha06

@Composable
fun verticalEnterTransition(expandFrom: Alignment.Vertical): EnterTransition

Default enter transition used for VerticalFloatingToolbar when expanding

verticalExitTransition

Cmn

Added in 1.4.0-alpha06

@Composable
fun verticalExitTransition(shrinkTowards: Alignment.Vertical): ExitTransition

Default exit transition used for VerticalFloatingToolbar when shrinking

vibrantFloatingToolbarColors

Cmn

Added in 1.4.0-alpha06

@Composable
fun vibrantFloatingToolbarColors(): FloatingToolbarColors

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

vibrantFloatingToolbarColors

Cmn

@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.

Parameters
`toolbarContainerColor: Color = Color.Unspecified`	the container color for the floating toolbar.
`toolbarContentColor: Color = Color.Unspecified`	the content color for the floating toolbar.
`fabContainerColor: Color = Color.Unspecified`	the container color for an adjacent floating action button.
`fabContentColor: Color = Color.Unspecified`	the content color for an adjacent floating action button.

Public properties

ContainerElevation

Cmn

Added in 1.4.0-alpha06

val ContainerElevation: Dp

Default elevation used for HorizontalFloatingToolbar and VerticalFloatingToolbar

ContainerShape

Cmn

Added in 1.4.0-alpha06

val ContainerShape: Shape

Default shape used for HorizontalFloatingToolbar and VerticalFloatingToolbar

ContainerSize

Cmn

Added in 1.4.0-alpha06

val ContainerSize: Dp

Default size used for HorizontalFloatingToolbar and VerticalFloatingToolbar container

ContentPadding

Cmn

Added in 1.4.0-alpha06

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

Cmn

Added in 1.4.0-alpha06

val ScreenOffset: Dp

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

ScrollDistanceThreshold

Cmn

Added in 1.4.0-alpha06

val ScrollDistanceThreshold: Dp

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