ToggleButtonDefaults

@ExperimentalMaterial3ExpressiveApi
object ToggleButtonDefaults

Contains the default values for all five toggle button types.

Properties

MinHeight

val MinHeight = ButtonSmallTokens.ContainerHeight

The default min height applied for all toggle buttons. Note that you can override it by applying Modifier.heightIn directly on the toggle button composable.

IconSpacing

val IconSpacing = ButtonSmallTokens.IconLabelSpace

The default size of the spacing between an icon and a text when they used inside any toggle button.

IconSize

val IconSize = ButtonSmallTokens.IconSize

The default size of the spacing between an icon and a text when they used inside any toggle button.

ContentPadding

val ContentPadding =
    PaddingValues(
        start = ToggleButtonStartPadding,
        top = ButtonVerticalPadding,
        end = ToggleButtonEndPadding,
        bottom = ButtonVerticalPadding,
    )

The default content padding used by all toggle buttons.

roundShape

val roundShape: Shape

A round shape that can be used for all ToggleButtons and its variants

squareShape

val squareShape: Shape

A square shape that can be used for all ToggleButtons and its variants

shape

val shape: Shape

The default unchecked shape for ToggleButton

pressedShape

val pressedShape: Shape

The default pressed shape for ToggleButton

checkedShape

val checkedShape: Shape

The default checked shape for ToggleButton

extraSmallSquareShape

val extraSmallSquareShape: Shape

The default square shape for a extra small toggle button

mediumSquareShape

val mediumSquareShape: Shape

The default square shape for a medium toggle button

largeSquareShape

val largeSquareShape: Shape

The default square shape for a large toggle button

extraLargeSquareShape

val extraLargeSquareShape: Shape

The default square shape for a extra large toggle button

extraSmallPressedShape

val extraSmallPressedShape: Shape

The default pressed shape for a extra small toggle button

mediumPressedShape

val mediumPressedShape: Shape

The default pressed shape for a medium toggle button

largePressedShape

val largePressedShape: Shape

The default pressed shape for a large toggle button

extraLargePressedShape

val extraLargePressedShape: Shape

The default pressed shape for a extra large toggle button

extraSmallCheckedSquareShape

val extraSmallCheckedSquareShape: Shape

The default checked square shape for a extra small toggle button

mediumCheckedSquareShape

val mediumCheckedSquareShape: Shape

The default checked square shape for a medium toggle button

largeCheckedSquareShape

val largeCheckedSquareShape: Shape

The default checked square shape for a large toggle button

extraLargeCheckedSquareShape

val extraLargeCheckedSquareShape: Shape

The default checked square shape for a extra large toggle button

Functions

shapes

@Composable fun shapes() = MaterialTheme.shapes.defaultToggleButtonShapes

Creates a ToggleButtonShapes that represents the default shape, pressedShape, and checkedShape used in a ToggleButton.

shapes

@Composable
    fun shapes(
        shape: Shape? = null,
        pressedShape: Shape? = null,
        checkedShape: Shape? = null,
    ): ToggleButtonShapes

Creates a ToggleButtonShapes that represents the default shape, pressedShape, and checkedShape used in a ToggleButton and its variants.

Parameters

toggleButtonColors

@Composable fun toggleButtonColors() = MaterialTheme.colorScheme.defaultToggleButtonColors

Creates a ToggleButtonColors that represents the default container and content colors used in a ToggleButton.

toggleButtonColors

@Composable
    fun toggleButtonColors(
        containerColor: Color = Color.Unspecified,
        contentColor: Color = Color.Unspecified,
        disabledContainerColor: Color = Color.Unspecified,
        disabledContentColor: Color = Color.Unspecified,
        checkedContainerColor: Color = Color.Unspecified,
        checkedContentColor: Color = Color.Unspecified,
    ): ToggleButtonColors

Creates a ToggleButtonColors that represents the default container and content colors used in a ToggleButton.

Parameters

elevatedToggleButtonColors

@Composable
    fun elevatedToggleButtonColors() = MaterialTheme.colorScheme.defaultElevatedToggleButtonColors

Creates a ToggleButtonColors that represents the default container and content colors used in a ElevatedToggleButton.

elevatedToggleButtonColors

@Composable
    fun elevatedToggleButtonColors(
        containerColor: Color = Color.Unspecified,
        contentColor: Color = Color.Unspecified,
        disabledContainerColor: Color = Color.Unspecified,
        disabledContentColor: Color = Color.Unspecified,
        checkedContainerColor: Color = Color.Unspecified,
        checkedContentColor: Color = Color.Unspecified,
    ): ToggleButtonColors

Creates a ToggleButtonColors that represents the default container and content colors used in a ElevatedToggleButton.

Parameters

tonalToggleButtonColors

@Composable
    fun tonalToggleButtonColors() = MaterialTheme.colorScheme.defaultTonalToggleButtonColors

Creates a ToggleButtonColors that represents the default container and content colors used in a TonalToggleButton.

tonalToggleButtonColors

@Composable
    fun tonalToggleButtonColors(
        containerColor: Color = Color.Unspecified,
        contentColor: Color = Color.Unspecified,
        disabledContainerColor: Color = Color.Unspecified,
        disabledContentColor: Color = Color.Unspecified,
        checkedContainerColor: Color = Color.Unspecified,
        checkedContentColor: Color = Color.Unspecified,
    ): ToggleButtonColors

Creates a ToggleButtonColors that represents the default container and content colors used in a TonalToggleButton.

Parameters

outlinedToggleButtonColors

@Composable
    fun outlinedToggleButtonColors() = MaterialTheme.colorScheme.defaultOutlinedToggleButtonColors

Creates a ToggleButtonColors that represents the default container and content colors used in a OutlinedToggleButton.

outlinedToggleButtonColors

@Composable
    fun outlinedToggleButtonColors(
        containerColor: Color = Color.Unspecified,
        contentColor: Color = Color.Unspecified,
        disabledContainerColor: Color = Color.Unspecified,
        disabledContentColor: Color = Color.Unspecified,
        checkedContainerColor: Color = Color.Unspecified,
        checkedContentColor: Color = Color.Unspecified,
    ): ToggleButtonColors

Creates a ToggleButtonColors that represents the default container and content colors used in a OutlinedToggleButton.

Parameters

shapesFor

@Composable
    fun shapesFor(buttonHeight: Dp): ToggleButtonShapes

Recommended ToggleButtonShapes for a provided toggle button height.

Parameters