State of Compose 2023 results are in! Click here to learn more

← Back to Material 3 Compose

FloatingActionButton

Component
in
Material 3
. Since 1.0.0

Overview

Code Examples

<a href="https://m3.material.io/components/floating-action-button/overview" class="external" target="_blank">Material Design floating action button</a>.

The FAB represents the most important action on a screen. It puts key actions within reach.

!FAB image(https://developer.android.com/images/reference/androidx/compose/material3/fab.png)

FAB typically contains an icon, for a FAB with text and an icon, see ExtendedFloatingActionButton.

Overloads

FloatingActionButton

@Composable
fun FloatingActionButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    shape: Shape = FloatingActionButtonDefaults.shape,
    containerColor: Color = FloatingActionButtonDefaults.containerColor,
    contentColor: Color = contentColorFor(containerColor),
    elevation: FloatingActionButtonElevation = FloatingActionButtonDefaults.elevation(),
    interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
    content: @Composable () -> Unit,
)

Parameters

NameDescription
onClickcalled when this FAB is clicked
modifierthe Modifier to be applied to this FAB
shapedefines the shape of this FAB's container and shadow (when using elevation)
containerColorthe color used for the background of this FAB. Use Color.Transparent to have no color.
contentColorthe preferred color for content inside this FAB. Defaults to either the matching content color for containerColor, or to the current LocalContentColor if containerColor is not a color from the theme.
elevationFloatingActionButtonElevation used to resolve the elevation for this FAB in different states. This controls the size of the shadow below the FAB. Additionally, when the container color is ColorScheme.surface, this controls the amount of primary color applied as an overlay. See also: Surface.
interactionSourcethe MutableInteractionSource representing the stream of Interactions for this FAB. You can create and pass in your own remembered instance to observe Interactions and customize the appearance / behavior of this FAB in different states.
contentthe content of this FAB, typically an Icon