FloatingActionButton

Common/AllAndroid/JVM

Functions summary

Unit

@Composable FloatingActionButton(     onClick: () -> Unit,     modifier: Modifier,     shape: Shape,     containerColor: Color,     contentColor: Color,     elevation: FloatingActionButtonElevation,     interactionSource: MutableInteractionSource?,     content: @Composable () -> Unit ) Material Design floating action button

Cmn

Functions

FloatingActionButton

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.5.0-alpha16

@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? = null,
    content: @Composable () -> Unit
): Unit

Material Design floating action button

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

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

import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.Add
import androidx.compose.material3.FloatingActionButton
import androidx.compose.material3.Icon
import androidx.compose.material3.PlainTooltip
import androidx.compose.material3.Text
import androidx.compose.material3.TooltipAnchorPosition
import androidx.compose.material3.TooltipBox
import androidx.compose.material3.TooltipDefaults
import androidx.compose.material3.rememberTooltipState
import androidx.compose.runtime.remember

// A FAB should have a tooltip associated with it.
TooltipBox(
    positionProvider =
        TooltipDefaults.rememberTooltipPositionProvider(TooltipAnchorPosition.Above),
    tooltip = { PlainTooltip { Text("Localized description") } },
    state = rememberTooltipState(),
) {
    FloatingActionButton(onClick = { /* do something */ }) {
        Icon(Icons.Filled.Add, "Localized description")
    }
}

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 (when using elevation)
containerColor: Color = FloatingActionButtonDefaults.containerColor	the color used for the background of this FAB. Use Color.Transparent to have no color.
contentColor: Color = contentColorFor(containerColor)	the 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.
elevation: FloatingActionButtonElevation = FloatingActionButtonDefaults.elevation()	FloatingActionButtonElevation 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.
interactionSource: MutableInteractionSource? = null	an optional hoisted MutableInteractionSource for observing and emitting Interactions 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