ToggleButtonDefaults

Artifact: androidx.compose.material3:material3

Cmn

@ExperimentalMaterial3ExpressiveApi
object ToggleButtonDefaults

Contains the default values for all five toggle button types.

Summary

Public functions
`ToggleButtonColors`	`@Composable elevatedToggleButtonColors()` Creates a `ToggleButtonColors` that represents the default container and content colors used in a `ElevatedToggleButton`.	Cmn
`ToggleButtonColors`	`@Composable elevatedToggleButtonColors( containerColor: Color, contentColor: Color, disabledContainerColor: Color, disabledContentColor: Color, checkedContainerColor: Color, checkedContentColor: Color )` Creates a `ToggleButtonColors` that represents the default container and content colors used in a `ElevatedToggleButton`.	Cmn
`ToggleButtonColors`	`@Composable outlinedToggleButtonColors()` Creates a `ToggleButtonColors` that represents the default container and content colors used in a `OutlinedToggleButton`.	Cmn
`ToggleButtonColors`	`@Composable outlinedToggleButtonColors( containerColor: Color, contentColor: Color, disabledContainerColor: Color, disabledContentColor: Color, checkedContainerColor: Color, checkedContentColor: Color )` Creates a `ToggleButtonColors` that represents the default container and content colors used in a `OutlinedToggleButton`.	Cmn
`ButtonShapes`	`@Composable shapes()` Creates a `ButtonShapes` that represents the default shape, pressedShape, and checkedShape used in a `ToggleButton`.	Cmn
`ButtonShapes`	`@Composable shapes(shape: Shape?, pressedShape: Shape?, checkedShape: Shape?)` Creates a `ButtonShapes` that represents the default shape, pressedShape, and checkedShape used in a `ToggleButton` and its variants.	Cmn
`ToggleButtonColors`	`@Composable toggleButtonColors()` Creates a `ToggleButtonColors` that represents the default container and content colors used in a `ToggleButton`.	Cmn
`ToggleButtonColors`	`@Composable toggleButtonColors( containerColor: Color, contentColor: Color, disabledContainerColor: Color, disabledContentColor: Color, checkedContainerColor: Color, checkedContentColor: Color )` Creates a `ToggleButtonColors` that represents the default container and content colors used in a `ToggleButton`.	Cmn
`ToggleButtonColors`	`@Composable tonalToggleButtonColors()` Creates a `ToggleButtonColors` that represents the default container and content colors used in a `TonalToggleButton`.	Cmn
`ToggleButtonColors`	`@Composable tonalToggleButtonColors( containerColor: Color, contentColor: Color, disabledContainerColor: Color, disabledContentColor: Color, checkedContainerColor: Color, checkedContentColor: Color )` Creates a `ToggleButtonColors` that represents the default container and content colors used in a `TonalToggleButton`.	Cmn

Public properties
`PaddingValues`	`ContentPadding` The default content padding used by all toglge buttons.	Cmn
`Dp`	`IconSize` The default size of the spacing between an icon and a text when they used inside any toggle button.	Cmn
`Dp`	`IconSpacing` The default size of the spacing between an icon and a text when they used inside any toggle button.	Cmn
`Dp`	`MinHeight` The default min height applied for all toggle buttons.	Cmn
`Shape`	`checkedShape` The default checked shape for `ToggleButton`	Cmn
`Shape`	`pressedShape` The default pressed shape for `ToggleButton`	Cmn
`Shape`	`roundShape` A round shape that can be used for all `ToggleButton`s and its variants	Cmn
`Shape`	`shape` The default unchecked shape for `ToggleButton`	Cmn
`Shape`	`squareShape` A square shape that can be used for all `ToggleButton`s and its variants	Cmn

Public functions

elevatedToggleButtonColors

Cmn

Added in 1.4.0-alpha03

@Composable
fun elevatedToggleButtonColors(): ToggleButtonColors

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

elevatedToggleButtonColors

Cmn

@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
`containerColor: Color = Color.Unspecified`	the container color of this `ElevatedToggleButton` when enabled.
`contentColor: Color = Color.Unspecified`	the content color of this `ElevatedToggleButton` when enabled.
`disabledContainerColor: Color = Color.Unspecified`	the container color of this `ElevatedToggleButton` when not enabled.
`disabledContentColor: Color = Color.Unspecified`	the content color of this `ElevatedToggleButton` when not enabled.
`checkedContainerColor: Color = Color.Unspecified`	the container color of this `ElevatedToggleButton` when checked.
`checkedContentColor: Color = Color.Unspecified`	the content color of this `ElevatedToggleButton` when checked.

outlinedToggleButtonColors

Cmn

Added in 1.4.0-alpha03

@Composable
fun outlinedToggleButtonColors(): ToggleButtonColors

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

outlinedToggleButtonColors

Cmn

@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
`containerColor: Color = Color.Unspecified`	the container color of this `OutlinedToggleButton` when enabled.
`contentColor: Color = Color.Unspecified`	the content color of this `OutlinedToggleButton` when enabled.
`disabledContainerColor: Color = Color.Unspecified`	the container color of this `OutlinedToggleButton` when not enabled.
`disabledContentColor: Color = Color.Unspecified`	the content color of this `OutlinedToggleButton` when not enabled.
`checkedContainerColor: Color = Color.Unspecified`	the container color of this `OutlinedToggleButton` when checked.
`checkedContentColor: Color = Color.Unspecified`	the content color of this `OutlinedToggleButton` when checked.

shapes

Cmn

Added in 1.4.0-alpha03

@Composable
fun shapes(): ButtonShapes

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

shapes

Cmn

Added in 1.4.0-alpha03

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

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

Parameters
`shape: Shape? = null`	the unchecked shape for `ButtonShapes`
`pressedShape: Shape? = null`	the unchecked shape for `ButtonShapes`
`checkedShape: Shape? = null`	the unchecked shape for `ButtonShapes`

toggleButtonColors

Cmn

Added in 1.4.0-alpha03

@Composable
fun toggleButtonColors(): ToggleButtonColors

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

toggleButtonColors

Cmn

@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
`containerColor: Color = Color.Unspecified`	the container color of this `ToggleButton` when enabled.
`contentColor: Color = Color.Unspecified`	the content color of this `ToggleButton` when enabled.
`disabledContainerColor: Color = Color.Unspecified`	the container color of this `ToggleButton` when not enabled.
`disabledContentColor: Color = Color.Unspecified`	the content color of this `ToggleButton` when not enabled.
`checkedContainerColor: Color = Color.Unspecified`	the container color of this `ToggleButton` when checked.
`checkedContentColor: Color = Color.Unspecified`	the content color of this `ToggleButton` when checked.

tonalToggleButtonColors

Cmn

Added in 1.4.0-alpha03

@Composable
fun tonalToggleButtonColors(): ToggleButtonColors

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

tonalToggleButtonColors

Cmn

@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
`containerColor: Color = Color.Unspecified`	the container color of this `TonalToggleButton` when enabled.
`contentColor: Color = Color.Unspecified`	the content color of this `TonalToggleButton` when enabled.
`disabledContainerColor: Color = Color.Unspecified`	the container color of this `TonalToggleButton` when not enabled.
`disabledContentColor: Color = Color.Unspecified`	the content color of this `TonalToggleButton` when not enabled.
`checkedContainerColor: Color = Color.Unspecified`	the container color of this `TonalToggleButton` when checked.
`checkedContentColor: Color = Color.Unspecified`	the content color of this `TonalToggleButton` when checked.

Public properties

ContentPadding

Cmn

Added in 1.4.0-alpha03

val ContentPadding: PaddingValues

The default content padding used by all toglge buttons.

IconSize

Cmn

Added in 1.4.0-alpha03

val IconSize: Dp

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

IconSpacing

Cmn

Added in 1.4.0-alpha03

val IconSpacing: Dp

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

MinHeight

Cmn

Added in 1.4.0-alpha03

val MinHeight: Dp

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.