FilledTonalButton

Android

Base level Wear Material3 [FilledTonalButton] that offers a single slot to take any content. Used as the container for more opinionated [FilledTonalButton] components that take specific content such as icons and labels.

The [FilledTonalButton] is Stadium-shaped by default and has a max height designed to take no more than two lines of text of [Typography.labelMedium] style. With localisation and/or large font sizes, the text can extend to a maximum of 3 lines in which case, the [FilledTonalButton] height adjusts to accommodate the contents. The [FilledTonalButton] can have an icon or image horizontally parallel to the two lines of text.

[FilledTonalButton] takes the [ButtonDefaults.filledTonalButtonColors] color scheme by default, with muted background, contrasting content color and no border. This is a medium-emphasis button for important actions that don't distract from other onscreen elements, such as final or unblocking actions in a flow with less emphasis than [Button].

Other recommended buttons with [ButtonColors] for different levels of emphasis are: [Button] which defaults to [ButtonDefaults.buttonColors], [OutlinedButton] which defaults to [ButtonDefaults.outlinedButtonColors] and [ChildButton] which defaults to [ButtonDefaults.childButtonColors]. Buttons can also take an image background using [ButtonDefaults.imageBackgroundButtonColors].

Button can be enabled or disabled. A disabled button will not respond to click events.

Last updated: 2024-10-22 13:47

Installation

dependencies {
   implementation("androidx.wear.compose:compose-material3:1.0.0-alpha27")
}

Overloads

@Composable
fun FilledTonalButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    onLongClick: (() -> Unit)? = null,
    onLongClickLabel: String? = null,
    enabled: Boolean = true,
    shape: Shape = ButtonDefaults.shape,
    colors: ButtonColors = ButtonDefaults.filledTonalButtonColors(),
    border: BorderStroke? = null,
    contentPadding: PaddingValues = ButtonDefaults.ContentPadding,
    interactionSource: MutableInteractionSource? = null,
    content: @Composable RowScope.() -> Unit,
)

Parameters

name	description
`onClick`	Will be called when the user clicks the button
`modifier`	Modifier to be applied to the button
`onLongClick`	Called when this button is long clicked (long-pressed). When this callback is set, [onLongClickLabel] should be set as well.
`onLongClickLabel`	Semantic / accessibility label for the [onLongClick] action.
`enabled`	Controls the enabled state of the button. When `false`, this button will not be clickable
`shape`	Defines the button's shape. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material3 Theme
`colors`	[ButtonColors] that will be used to resolve the background and content color for this button in different states. See [ButtonDefaults.filledTonalButtonColors].
`border`	Optional [BorderStroke] that will be used to resolve the border for this button in different states.
`contentPadding`	The spacing values to apply internally between the container and the content
`interactionSource`	an optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s for this button. You can use this to change the button's appearance or preview the button in different states. Note that if `null` is provided, interactions will still happen internally.
`content`	Slot for composable body content displayed on the Button

@Composable
fun FilledTonalButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    onLongClick: (() -> Unit)? = null,
    onLongClickLabel: String? = null,
    secondaryLabel: (@Composable RowScope.() -> Unit)? = null,
    icon: (@Composable BoxScope.() -> Unit)? = null,
    enabled: Boolean = true,
    shape: Shape = ButtonDefaults.shape,
    colors: ButtonColors = ButtonDefaults.filledTonalButtonColors(),
    border: BorderStroke? = null,
    contentPadding: PaddingValues = ButtonDefaults.ContentPadding,
    interactionSource: MutableInteractionSource? = null,
    label: @Composable RowScope.() -> Unit,
)

Parameters

name	description
`onClick`	Will be called when the user clicks the button
`modifier`	Modifier to be applied to the button
`onLongClick`	Called when this button is long clicked (long-pressed). When this callback is set, [onLongClickLabel] should be set as well.
`onLongClickLabel`	Semantic / accessibility label for the [onLongClick] action.
`secondaryLabel`	A slot for providing the button's secondary label. The contents are expected to be text which is "start" aligned if there is an icon preset and "start" or "center" aligned if not. label and secondaryLabel contents should be consistently aligned.
`icon`	A slot for providing the button's icon. The contents are expected to be a horizontally and vertically aligned icon of size [ButtonDefaults.IconSize] or [ButtonDefaults.LargeIconSize].
`enabled`	Controls the enabled state of the button. When `false`, this button will not be clickable
`shape`	Defines the button's shape. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material3 Theme
`colors`	[ButtonColors] that will be used to resolve the background and content color for this button in different states. See [ButtonDefaults.filledTonalButtonColors].
`border`	Optional [BorderStroke] that will be used to resolve the button border in different states.
`contentPadding`	The spacing values to apply internally between the container and the content
`interactionSource`	an optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s for this button. You can use this to change the button's appearance or preview the button in different states. Note that if `null` is provided, interactions will still happen internally.
`label`	A slot for providing the button's main label. The contents are expected to be text which is "start" aligned if there is an icon preset and "start" or "center" aligned if not.

Code Examples

SimpleFilledTonalButtonSample

@Composable
fun SimpleFilledTonalButtonSample(modifier: Modifier = Modifier.fillMaxWidth()) {
    FilledTonalButton(
        onClick = { /* Do something */ },
        label = { Text("Filled Tonal Button") },
        modifier = modifier,
    )
}