{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

IconButtonDefaults


Contains the default values used by all icon button types.

Summary

Public functions

IconButtonColors
@Composable
filledIconButtonColors(
    containerColor: Color,
    contentColor: Color,
    disabledContainerColor: Color,
    disabledContentColor: Color
)

Creates a IconButtonColors that represents the default colors used in a FilledIconButton.

Cmn
IconToggleButtonColors
@Composable
filledIconToggleButtonColors(
    containerColor: Color,
    contentColor: Color,
    disabledContainerColor: Color,
    disabledContentColor: Color,
    checkedContainerColor: Color,
    checkedContentColor: Color
)

Creates a IconToggleButtonColors that represents the default colors used in a FilledIconToggleButton.

Cmn
IconButtonColors
@Composable
filledTonalIconButtonColors(
    containerColor: Color,
    contentColor: Color,
    disabledContainerColor: Color,
    disabledContentColor: Color
)

Creates a IconButtonColors that represents the default colors used in a FilledTonalIconButton.

Cmn
IconToggleButtonColors
@Composable
filledTonalIconToggleButtonColors(
    containerColor: Color,
    contentColor: Color,
    disabledContainerColor: Color,
    disabledContentColor: Color,
    checkedContainerColor: Color,
    checkedContentColor: Color
)

Creates a IconToggleButtonColors that represents the default colors used in a FilledTonalIconToggleButton.

Cmn
IconButtonColors

Creates a IconButtonColors that represents the default colors used in a IconButton.

Cmn
IconButtonColors
@Composable
iconButtonColors(
    containerColor: Color,
    contentColor: Color,
    disabledContainerColor: Color,
    disabledContentColor: Color
)

Creates a IconButtonColors that represents the default colors used in a IconButton.

Cmn
IconToggleButtonColors
@Composable
iconToggleButtonColors(
    containerColor: Color,
    contentColor: Color,
    disabledContainerColor: Color,
    disabledContentColor: Color,
    checkedContainerColor: Color,
    checkedContentColor: Color
)

Creates a IconToggleButtonColors that represents the default colors used in a IconToggleButton.

Cmn
BorderStroke

Represents the BorderStroke for an OutlinedIconButton, depending on its enabled state.

Cmn
IconButtonColors
@Composable
outlinedIconButtonColors(
    containerColor: Color,
    contentColor: Color,
    disabledContainerColor: Color,
    disabledContentColor: Color
)

Creates a IconButtonColors that represents the default colors used in a OutlinedIconButton.

Cmn
BorderStroke?

Represents the BorderStroke for an OutlinedIconButton, depending on its enabled and checked state.

Cmn
IconToggleButtonColors
@Composable
outlinedIconToggleButtonColors(
    containerColor: Color,
    contentColor: Color,
    disabledContainerColor: Color,
    disabledContentColor: Color,
    checkedContainerColor: Color,
    checkedContentColor: Color
)

Creates a IconToggleButtonColors that represents the default colors used in a OutlinedIconToggleButton.

Cmn

Public properties

Shape

Default shape for a filled icon button.

Cmn
Shape

Default shape for an outlined icon button.

Cmn

Public functions

filledIconButtonColors

@Composable
fun filledIconButtonColors(
    containerColor: Color = FilledIconButtonTokens.ContainerColor.value,
    contentColor: Color = contentColorFor(containerColor),
    disabledContainerColor: Color = FilledIconButtonTokens.DisabledContainerColor.value .copy(alpha = FilledIconButtonTokens.DisabledContainerOpacity),
    disabledContentColor: Color = FilledIconButtonTokens.DisabledColor.value .copy(alpha = FilledIconButtonTokens.DisabledOpacity)
): IconButtonColors

Creates a IconButtonColors that represents the default colors used in a FilledIconButton.

Parameters
containerColor: Color = FilledIconButtonTokens.ContainerColor.value

the container color of this icon button when enabled.

contentColor: Color = contentColorFor(containerColor)

the content color of this icon button when enabled.

disabledContainerColor: Color = FilledIconButtonTokens.DisabledContainerColor.value .copy(alpha = FilledIconButtonTokens.DisabledContainerOpacity)

the container color of this icon button when not enabled.

disabledContentColor: Color = FilledIconButtonTokens.DisabledColor.value .copy(alpha = FilledIconButtonTokens.DisabledOpacity)

the content color of this icon button when not enabled.

filledIconToggleButtonColors

@Composable
fun filledIconToggleButtonColors(
    containerColor: Color = FilledIconButtonTokens.UnselectedContainerColor.value,
    contentColor: Color = FilledIconButtonTokens.ToggleUnselectedColor.value,
    disabledContainerColor: Color = FilledIconButtonTokens.DisabledContainerColor.value .copy(alpha = FilledIconButtonTokens.DisabledContainerOpacity),
    disabledContentColor: Color = FilledIconButtonTokens.DisabledColor.value .copy(alpha = FilledIconButtonTokens.DisabledOpacity),
    checkedContainerColor: Color = FilledIconButtonTokens.SelectedContainerColor.value,
    checkedContentColor: Color = contentColorFor(checkedContainerColor)
): IconToggleButtonColors

Creates a IconToggleButtonColors that represents the default colors used in a FilledIconToggleButton.

Parameters
containerColor: Color = FilledIconButtonTokens.UnselectedContainerColor.value

the container color of this icon button when enabled.

contentColor: Color = FilledIconButtonTokens.ToggleUnselectedColor.value

the content color of this icon button when enabled.

disabledContainerColor: Color = FilledIconButtonTokens.DisabledContainerColor.value .copy(alpha = FilledIconButtonTokens.DisabledContainerOpacity)

the container color of this icon button when not enabled.

disabledContentColor: Color = FilledIconButtonTokens.DisabledColor.value .copy(alpha = FilledIconButtonTokens.DisabledOpacity)

the content color of this icon button when not enabled.

checkedContainerColor: Color = FilledIconButtonTokens.SelectedContainerColor.value

the container color of this icon button when checked.

checkedContentColor: Color = contentColorFor(checkedContainerColor)

the content color of this icon button when checked.

filledTonalIconButtonColors

@Composable
fun filledTonalIconButtonColors(
    containerColor: Color = FilledTonalIconButtonTokens.ContainerColor.value,
    contentColor: Color = contentColorFor(containerColor),
    disabledContainerColor: Color = FilledTonalIconButtonTokens.DisabledContainerColor.value .copy(alpha = FilledTonalIconButtonTokens.DisabledContainerOpacity),
    disabledContentColor: Color = FilledTonalIconButtonTokens.DisabledColor.value .copy(alpha = FilledTonalIconButtonTokens.DisabledOpacity)
): IconButtonColors

Creates a IconButtonColors that represents the default colors used in a FilledTonalIconButton.

Parameters
containerColor: Color = FilledTonalIconButtonTokens.ContainerColor.value

the container color of this icon button when enabled.

contentColor: Color = contentColorFor(containerColor)

the content color of this icon button when enabled.

disabledContainerColor: Color = FilledTonalIconButtonTokens.DisabledContainerColor.value .copy(alpha = FilledTonalIconButtonTokens.DisabledContainerOpacity)

the container color of this icon button when not enabled.

disabledContentColor: Color = FilledTonalIconButtonTokens.DisabledColor.value .copy(alpha = FilledTonalIconButtonTokens.DisabledOpacity)

the content color of this icon button when not enabled.

filledTonalIconToggleButtonColors

@Composable
fun filledTonalIconToggleButtonColors(
    containerColor: Color = FilledTonalIconButtonTokens.UnselectedContainerColor.value,
    contentColor: Color = contentColorFor(containerColor),
    disabledContainerColor: Color = FilledTonalIconButtonTokens.DisabledContainerColor.value .copy(alpha = FilledTonalIconButtonTokens.DisabledContainerOpacity),
    disabledContentColor: Color = FilledTonalIconButtonTokens.DisabledColor.value .copy(alpha = FilledTonalIconButtonTokens.DisabledOpacity),
    checkedContainerColor: Color = FilledTonalIconButtonTokens.SelectedContainerColor.value,
    checkedContentColor: Color = FilledTonalIconButtonTokens.ToggleSelectedColor.value
): IconToggleButtonColors

Creates a IconToggleButtonColors that represents the default colors used in a FilledTonalIconToggleButton.

Parameters
containerColor: Color = FilledTonalIconButtonTokens.UnselectedContainerColor.value

the container color of this icon button when enabled.

contentColor: Color = contentColorFor(containerColor)

the content color of this icon button when enabled.

disabledContainerColor: Color = FilledTonalIconButtonTokens.DisabledContainerColor.value .copy(alpha = FilledTonalIconButtonTokens.DisabledContainerOpacity)

the container color of this icon button when not enabled.

disabledContentColor: Color = FilledTonalIconButtonTokens.DisabledColor.value .copy(alpha = FilledTonalIconButtonTokens.DisabledOpacity)

the content color of this icon button when not enabled.

checkedContainerColor: Color = FilledTonalIconButtonTokens.SelectedContainerColor.value

the container color of this icon button when checked.

checkedContentColor: Color = FilledTonalIconButtonTokens.ToggleSelectedColor.value

the content color of this icon button when checked.

iconButtonColors

@Composable
fun iconButtonColors(): IconButtonColors

Creates a IconButtonColors that represents the default colors used in a IconButton.

iconButtonColors

@Composable
fun iconButtonColors(
    containerColor: Color = Color.Unspecified,
    contentColor: Color = LocalContentColor.current,
    disabledContainerColor: Color = Color.Unspecified,
    disabledContentColor: Color = contentColor.copy(alpha = IconButtonTokens.DisabledIconOpacity)
): IconButtonColors

Creates a IconButtonColors that represents the default colors used in a IconButton.

Parameters
containerColor: Color = Color.Unspecified

the container color of this icon button when enabled.

contentColor: Color = LocalContentColor.current

the content color of this icon button when enabled.

disabledContainerColor: Color = Color.Unspecified

the container color of this icon button when not enabled.

disabledContentColor: Color = contentColor.copy(alpha = IconButtonTokens.DisabledIconOpacity)

the content color of this icon button when not enabled.

iconToggleButtonColors

@Composable
fun iconToggleButtonColors(
    containerColor: Color = Color.Transparent,
    contentColor: Color = LocalContentColor.current,
    disabledContainerColor: Color = Color.Transparent,
    disabledContentColor: Color = contentColor.copy(alpha = IconButtonTokens.DisabledIconOpacity),
    checkedContainerColor: Color = Color.Transparent,
    checkedContentColor: Color = IconButtonTokens.SelectedIconColor.value
): IconToggleButtonColors

Creates a IconToggleButtonColors that represents the default colors used in a IconToggleButton.

Parameters
containerColor: Color = Color.Transparent

the container color of this icon button when enabled.

contentColor: Color = LocalContentColor.current

the content color of this icon button when enabled.

disabledContainerColor: Color = Color.Transparent

the container color of this icon button when not enabled.

disabledContentColor: Color = contentColor.copy(alpha = IconButtonTokens.DisabledIconOpacity)

the content color of this icon button when not enabled.

checkedContainerColor: Color = Color.Transparent

the container color of this icon button when checked.

checkedContentColor: Color = IconButtonTokens.SelectedIconColor.value

the content color of this icon button when checked.

outlinedIconButtonBorder

@Composable
fun outlinedIconButtonBorder(enabled: Boolean): BorderStroke

Represents the BorderStroke for an OutlinedIconButton, depending on its enabled state.

Parameters
enabled: Boolean

whether the icon button is enabled

outlinedIconButtonColors

@Composable
fun outlinedIconButtonColors(
    containerColor: Color = Color.Transparent,
    contentColor: Color = LocalContentColor.current,
    disabledContainerColor: Color = Color.Transparent,
    disabledContentColor: Color = contentColor.copy(alpha = OutlinedIconButtonTokens.DisabledOpacity)
): IconButtonColors

Creates a IconButtonColors that represents the default colors used in a OutlinedIconButton.

Parameters
containerColor: Color = Color.Transparent

the container color of this icon button when enabled.

contentColor: Color = LocalContentColor.current

the content color of this icon button when enabled.

disabledContainerColor: Color = Color.Transparent

the container color of this icon button when not enabled.

disabledContentColor: Color = contentColor.copy(alpha = OutlinedIconButtonTokens.DisabledOpacity)

the content color of this icon button when not enabled.

outlinedIconToggleButtonBorder

@Composable
fun outlinedIconToggleButtonBorder(enabled: Boolean, checked: Boolean): BorderStroke?

Represents the BorderStroke for an OutlinedIconButton, depending on its enabled and checked state.

Parameters
enabled: Boolean

whether the icon button is enabled

checked: Boolean

whether the icon button is checked

outlinedIconToggleButtonColors

@Composable
fun outlinedIconToggleButtonColors(
    containerColor: Color = Color.Transparent,
    contentColor: Color = LocalContentColor.current,
    disabledContainerColor: Color = Color.Transparent,
    disabledContentColor: Color = contentColor.copy(alpha = OutlinedIconButtonTokens.DisabledOpacity),
    checkedContainerColor: Color = OutlinedIconButtonTokens.SelectedContainerColor.value,
    checkedContentColor: Color = contentColorFor(checkedContainerColor)
): IconToggleButtonColors

Creates a IconToggleButtonColors that represents the default colors used in a OutlinedIconToggleButton.

Parameters
containerColor: Color = Color.Transparent

the container color of this icon button when enabled.

contentColor: Color = LocalContentColor.current

the content color of this icon button when enabled.

disabledContainerColor: Color = Color.Transparent

the container color of this icon button when not enabled.

disabledContentColor: Color = contentColor.copy(alpha = OutlinedIconButtonTokens.DisabledOpacity)

the content color of this icon button when not enabled.

checkedContainerColor: Color = OutlinedIconButtonTokens.SelectedContainerColor.value

the container color of this icon button when checked.

checkedContentColor: Color = contentColorFor(checkedContainerColor)

the content color of this icon button when checked.

Public properties

filledShape

val filledShapeShape

Default shape for a filled icon button.

outlinedShape

val outlinedShapeShape

Default shape for an outlined icon button.