core/com.orange.ouds.core.component/OudsFloatingActionButton

OudsFloatingActionButton

fun OudsFloatingActionButton(icon: OudsIcon, onClick: () -> Unit, modifier: Modifier = Modifier, shape: Shape = OudsFloatingActionButtonDefaults.shape, appearance: OudsFloatingActionButtonAppearance = OudsFloatingActionButtonDefaults.Appearance, interactionSource: MutableInteractionSource? = null)

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

Design

Name	FAB
Version	Draft

Parameters

icon

Icon for this FAB.

onClick

Called when this FAB is clicked.

modifier

The Modifier to be applied to this FAB.

shape

Defines the shape of this FAB's container and shadow.

appearance

Appearance of the FAB among OudsFloatingActionButtonAppearance values.

interactionSource

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.

Samples

OudsFloatingActionButton(
    icon = OudsIcon(
        imageVector = Icons.Filled.FavoriteBorder,
        contentDescription = "Content description"
    ),
    onClick = { /* Do something! */ }
)

OudsFloatingActionButton(
    icon = OudsIcon(
        painter = rememberRainbowHeartPainter(),
        contentDescription = "Content description",
        tinted = false
    ),
    onClick = { /* Do something! */ },
    appearance = OudsFloatingActionButtonAppearance.Strong
)

@Composable

fun ~~OudsFloatingActionButton~~(icon: OudsFloatingActionButtonIcon, onClick: () -> Unit, modifier: Modifier = Modifier, shape: Shape = OudsFloatingActionButtonDefaults.shape, appearance: OudsFloatingActionButtonAppearance = OudsFloatingActionButtonDefaults.Appearance, interactionSource: MutableInteractionSource? = null)

Deprecated