FilledTonalToggleButton API Reference in Material 3 Compose

Material Design toggle button Toggle button is a toggleable button that switches between primary and tonal colors depending on checked's value.

FilledTonalToggleButton

Source set: Common

@Composable
public fun FilledTonalToggleButton(
    checked: Boolean,
    onCheckedChange: (Boolean) -> Unit,
    modifier: Modifier = Modifier,
    buttonSize: ToggleButtonSize = FilledTonalToggleButtonDefaults.size,
    enabled: Boolean = true,
    icon: @Composable (() -> Unit)? = null,
    shapes: ToggleButtonShapes = FilledTonalToggleButtonDefaults.shapesFor(buttonSize),
    colors: ToggleButtonColors = FilledTonalToggleButtonDefaults.colors(),
    elevation: ToggleButtonElevation? = FilledTonalToggleButtonDefaults.elevation(),
    border: BorderStroke? = null,
    contentPadding: PaddingValues =
        FilledTonalToggleButtonDefaults.contentPaddingFor(buttonSize, hasStartIcon = icon != null),
    interactionSource: MutableInteractionSource? = null,
    content: @Composable RowScope.() -> Unit,
)

Parameters


checked	whether the toggle button is toggled on or off.
onCheckedChange	called when the toggle button is clicked.
modifier	the Modifier to be applied to the toggle button.
buttonSize	the ToggleButtonSize of this toggle button, controlling its height, padding, and icon sizing.
enabled	controls the enabled state of this toggle button. When `false`, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.
icon	optional icon to be placed before the `content`.
shapes	the ToggleButtonShapes used for this toggle button.
colors	ToggleButtonColors used for this toggle button. See FilledTonalToggleButtonDefaults.colors.
elevation	ToggleButtonElevation used for this button. See FilledTonalToggleButtonDefaults.elevation.
border	the border to draw around the container.
contentPadding	the spacing values to apply internally.
interactionSource	an optional hoisted MutableInteractionSource for observing and emitting Interactions for this toggle button. You can use this to change the toggle button's appearance or preview the toggle button in different states. Note that if `null` is provided, interactions will still happen internally.
content	The content displayed on the toggle button.