Jenga/io.github.joelkanyi.jenga.component.fab/JengaFab

JengaFab

fun JengaFab(onClick: () -> Unit, modifier: Modifier = Modifier, shape: Shape = JengaFabDefaults.shape, colors: JengaFabColors = JengaFabDefaults.colors(), elevation: Dp = JengaFabDefaults.elevation, shadowColor: Color = JengaTheme.components.fab?.shadowColor ?: JengaFabDefaults.ShadowColor, size: Dp = JengaTheme.components.fab?.size ?: JengaFabDefaults.Size, content: @Composable () -> Unit)(source)

A floating action button: a prominent, elevated action with an icon.

Parameters

onClick

called when tapped.

modifier

the Modifier for this FAB.

shape

the FAB shape; defaults to JengaFabDefaults.shape.

colors

the color set; defaults to JengaFabDefaults.colors.

elevation

the shadow elevation.

shadowColor

the shadow color; defaults to the theme's value, else JengaFabDefaults.ShadowColor.

size

the FAB edge length; defaults to the theme's value, else JengaFabDefaults.Size.

content

the FAB content (typically a single icon); inherits content color.

Samples

JengaFab(
    onClick = { },
    content = {
        JengaIcon(
            imageVector = JengaIcons.Add,
            contentDescription = "Add",
        )
    },
)