IconButtonDefaults
-
Cmn
object IconButtonDefaults
Contains the default values for all four icon and icon toggle button types.
Summary
Nested types |
|---|
value class IconButtonDefaults.IconButtonWidthOptionClass that describes the different supported widths of the |
Public functions |
||
|---|---|---|
DpSize |
@ExperimentalMaterial3ExpressiveApiDefault container size for any extra large icon button. |
Cmn
|
DpSize |
@ExperimentalMaterial3ExpressiveApiDefault container size for any extra small icon button. |
Cmn
|
IconButtonColors |
Creates a |
Cmn
|
IconButtonColors |
@ComposableCreates a |
Cmn
|
IconToggleButtonColors |
Creates a |
Cmn
|
IconToggleButtonColors |
@ComposableCreates a |
Cmn
|
IconButtonColors |
Creates a |
Cmn
|
IconButtonColors |
@ComposableCreates a |
Cmn
|
IconToggleButtonColors |
Creates a |
Cmn
|
IconToggleButtonColors |
@ComposableCreates a |
Cmn
|
IconButtonColors |
Contains the default values used by |
Cmn
|
IconButtonColors |
@ComposableCreates a |
Cmn
|
IconButtonColors |
Creates a |
Cmn
|
IconButtonColors |
@ComposableCreates a |
Cmn
|
IconToggleButtonColors |
Creates a |
Cmn
|
IconToggleButtonColors |
@ComposableCreates a |
Cmn
|
IconToggleButtonColors |
Creates a |
Cmn
|
IconToggleButtonColors |
@ComposableCreates a |
Cmn
|
DpSize |
@ExperimentalMaterial3ExpressiveApiDefault container size for any large icon button. |
Cmn
|
DpSize |
@ExperimentalMaterial3ExpressiveApiDefault container size for any medium icon button. |
Cmn
|
BorderStroke |
@ComposableRepresents the |
Cmn
|
IconButtonColors |
Creates a |
Cmn
|
IconButtonColors |
@ComposableCreates a |
Cmn
|
BorderStroke |
@ComposableRepresents the |
Cmn
|
IconButtonColors |
Creates a |
Cmn
|
IconButtonColors |
@ComposableCreates a |
Cmn
|
BorderStroke? |
@ComposableRepresents the |
Cmn
|
IconToggleButtonColors |
Creates a |
Cmn
|
IconToggleButtonColors |
@ComposableCreates a |
Cmn
|
BorderStroke? |
@ComposableRepresents the |
Cmn
|
IconToggleButtonColors |
Creates a |
Cmn
|
IconToggleButtonColors |
@ComposableCreates a |
Cmn
|
IconButtonShapes |
Creates a |
Cmn
|
IconButtonShapes |
@ExperimentalMaterial3ExpressiveApiCreates a |
Cmn
|
DpSize |
@ExperimentalMaterial3ExpressiveApiDefault container size for any small icon button. |
Cmn
|
IconToggleButtonShapes |
Creates a |
Cmn
|
IconToggleButtonShapes |
@ExperimentalMaterial3ExpressiveApiCreates a |
Cmn
|
Public properties |
||
|---|---|---|
Shape |
Default selected shape for any small, square icon button. |
Cmn
|
Dp |
Default size for any xlarge icon button. |
Cmn
|
Shape |
Default pressed shape for any extra large icon button. |
Cmn
|
Shape |
Default shape for any extra large icon button. |
Cmn
|
Shape |
Default selected shape for any extra large icon button. |
Cmn
|
Shape |
Default selected shape for any extra large, square icon button. |
Cmn
|
Shape |
Default shape for any extra large icon button. |
Cmn
|
Dp |
Default container for any extra small icon button. |
Cmn
|
Shape |
Default pressed shape for any extra small icon button. |
Cmn
|
Shape |
Default round shape for any extra small icon button. |
Cmn
|
Shape |
Default selected shape for any extra small icon button. |
Cmn
|
Shape |
Default selected shape for any extra small, square icon button. |
Cmn
|
Shape |
Default square shape for any extra small icon button. |
Cmn
|
Shape |
Default shape for a filled icon button. |
Cmn
|
Dp |
Default size for any large icon button. |
Cmn
|
Shape |
Default pressed shape for any large icon button. |
Cmn
|
Shape |
Default shape for any large icon button. |
Cmn
|
Shape |
Default selected shape for any large icon button. |
Cmn
|
Shape |
Default selected shape for any large, square icon button. |
Cmn
|
Shape |
Default shape for any large icon button. |
Cmn
|
Dp |
Default container size for any medium icon button. |
Cmn
|
Shape |
Default pressed shape for any medium icon button. |
Cmn
|
Shape |
Default shape for any medium icon button. |
Cmn
|
Shape |
Default selected shape for any medium icon button. |
Cmn
|
Shape |
Default selected shape for any medium, square icon button. |
Cmn
|
Shape |
Default shape for any medium icon button. |
Cmn
|
Shape |
Default shape for an outlined icon button. |
Cmn
|
Dp |
Default size for any small icon button. |
Cmn
|
Shape |
Default pressed shape for any small icon button. |
Cmn
|
Shape |
Default shape for any small icon button. |
Cmn
|
Shape |
Default selected shape for any small icon button. |
Cmn
|
Shape |
Default square shape for any small icon button. |
Cmn
|
Shape |
Default ripple shape for a standard icon button. |
Cmn
|
Public functions
extraLargeContainerSize
@ExperimentalMaterial3ExpressiveApi
fun extraLargeContainerSize(
widthOption: IconButtonDefaults.IconButtonWidthOption = IconButtonWidthOption.Uniform
): DpSize
Default container size for any extra large icon button.
| Parameters | |
|---|---|
widthOption: IconButtonDefaults.IconButtonWidthOption = IconButtonWidthOption.Uniform |
the width of the container |
extraSmallContainerSize
@ExperimentalMaterial3ExpressiveApi
fun extraSmallContainerSize(
widthOption: IconButtonDefaults.IconButtonWidthOption = IconButtonWidthOption.Uniform
): DpSize
Default container size for any extra small icon button.
| Parameters | |
|---|---|
widthOption: IconButtonDefaults.IconButtonWidthOption = IconButtonWidthOption.Uniform |
the width of the container |
filledIconButtonColors
@Composable
fun filledIconButtonColors(): IconButtonColors
Creates a IconButtonColors that represents the default colors used in a FilledIconButton.
filledIconButtonColors
@Composable
fun filledIconButtonColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = contentColorFor(containerColor),
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = Color.Unspecified
): IconButtonColors
Creates a IconButtonColors that represents the default colors used in a FilledIconButton.
| Parameters | |
|---|---|
containerColor: Color = Color.Unspecified |
the container color of this icon button when enabled. |
contentColor: Color = contentColorFor(containerColor) |
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 = Color.Unspecified |
the content color of this icon button when not enabled. |
filledIconToggleButtonColors
@Composable
fun filledIconToggleButtonColors(): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the default colors used in a FilledIconToggleButton.
filledIconToggleButtonColors
@Composable
fun filledIconToggleButtonColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = Color.Unspecified,
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = Color.Unspecified,
checkedContainerColor: Color = Color.Unspecified,
checkedContentColor: Color = contentColorFor(checkedContainerColor)
): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the default colors used in a FilledIconToggleButton.
| Parameters | |
|---|---|
containerColor: Color = Color.Unspecified |
the container color of this icon button when enabled. |
contentColor: Color = Color.Unspecified |
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 = Color.Unspecified |
the content color of this icon button when not enabled. |
checkedContainerColor: Color = Color.Unspecified |
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(): IconButtonColors
Creates a IconButtonColors that represents the default colors used in a FilledTonalIconButton.
filledTonalIconButtonColors
@Composable
fun filledTonalIconButtonColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = contentColorFor(containerColor),
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = Color.Unspecified
): IconButtonColors
Creates a IconButtonColors that represents the default colors used in a FilledTonalIconButton.
| Parameters | |
|---|---|
containerColor: Color = Color.Unspecified |
the container color of this icon button when enabled. |
contentColor: Color = contentColorFor(containerColor) |
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 = Color.Unspecified |
the content color of this icon button when not enabled. |
filledTonalIconToggleButtonColors
@Composable
fun filledTonalIconToggleButtonColors(): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the default colors used in a FilledTonalIconToggleButton.
filledTonalIconToggleButtonColors
@Composable
fun filledTonalIconToggleButtonColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = contentColorFor(containerColor),
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = Color.Unspecified,
checkedContainerColor: Color = Color.Unspecified,
checkedContentColor: Color = contentColorFor(checkedContainerColor)
): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the default colors used in a FilledTonalIconToggleButton.
| Parameters | |
|---|---|
containerColor: Color = Color.Unspecified |
the container color of this icon button when enabled. |
contentColor: Color = contentColorFor(containerColor) |
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 = Color.Unspecified |
the content color of this icon button when not enabled. |
checkedContainerColor: Color = Color.Unspecified |
the container color of this icon button when checked. |
checkedContentColor: Color = contentColorFor(checkedContainerColor) |
the content color of this icon button when checked. |
iconButtonColors
@Composable
fun iconButtonColors(): IconButtonColors
Contains the default values used by IconButton. LocalContentColor will be applied to the icon and down the UI tree.
See iconButtonVibrantColors for default values that applies the recommended high contrast colors.
iconButtonColors
@Composable
fun iconButtonColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = LocalContentColor.current,
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = contentColor.copy(alpha = StandardIconButtonTokens.DisabledOpacity)
): IconButtonColors
Creates a IconButtonColors that represents the default colors used in a IconButton. LocalContentColor will be applied to the icon and down the UI tree unless a custom contentColor is provided.
See iconButtonVibrantColors for default values that applies the recommended high contrast colors.
| 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. By default, this will use the current LocalContentColor value. |
disabledContainerColor: Color = Color.Unspecified |
the container color of this icon button when not enabled. |
disabledContentColor: Color = contentColor.copy(alpha = StandardIconButtonTokens.DisabledOpacity) |
the content color of this icon button when not enabled. |
iconButtonVibrantColors
@Composable
fun iconButtonVibrantColors(): IconButtonColors
Creates a IconButtonColors that represents the recommended high contrast colors used in an IconButton.
See iconButtonColors for default values that applies LocalContentColor to the icon and down the UI tree.
iconButtonVibrantColors
@Composable
fun iconButtonVibrantColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = Color.Unspecified,
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = contentColor.copy(alpha = StandardIconButtonTokens.DisabledOpacity)
): IconButtonColors
Creates a IconButtonColors that represents the recommended high contrast colors used in an IconButton.
See iconButtonColors for default values that applies LocalContentColor to the icon and down the UI tree.
| Parameters | |
|---|---|
containerColor: Color = Color.Unspecified |
the container color of this icon button when enabled. |
contentColor: Color = Color.Unspecified |
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 = StandardIconButtonTokens.DisabledOpacity) |
the content color of this icon button when not enabled. |
iconToggleButtonColors
@Composable
fun iconToggleButtonColors(): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the default colors used in a IconToggleButton. LocalContentColor will be applied to the icon and down the UI tree.
See iconToggleButtonVibrantColors for default values that applies the recommended high contrast colors.
iconToggleButtonColors
@Composable
fun iconToggleButtonColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = LocalContentColor.current,
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = contentColor.copy(alpha = StandardIconButtonTokens.DisabledOpacity),
checkedContainerColor: Color = Color.Unspecified,
checkedContentColor: Color = Color.Unspecified
): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the default colors used in a IconToggleButton. LocalContentColor will be applied to the icon and down the UI tree unless a custom contentColor is provided.
See iconToggleButtonVibrantColors for default values that applies the recommended high contrast colors.
| 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 = StandardIconButtonTokens.DisabledOpacity) |
the content color of this icon button when not enabled. |
checkedContainerColor: Color = Color.Unspecified |
the container color of this icon button when checked. |
checkedContentColor: Color = Color.Unspecified |
the content color of this icon button when checked. |
iconToggleButtonVibrantColors
@Composable
fun iconToggleButtonVibrantColors(): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the recommended high contrast colors used in a IconToggleButton. See iconToggleButtonColors for default values that applies LocalContentColor to the icon and down the UI tree.
iconToggleButtonVibrantColors
@Composable
fun iconToggleButtonVibrantColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = Color.Unspecified,
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = contentColor.copy(alpha = StandardIconButtonTokens.DisabledOpacity),
checkedContainerColor: Color = Color.Unspecified,
checkedContentColor: Color = Color.Unspecified
): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the recommended high contrast colors used in a IconToggleButton.
See iconToggleButtonColors for default values that applies LocalContentColor to the icon and down the UI tree.
| Parameters | |
|---|---|
containerColor: Color = Color.Unspecified |
the container color of this icon button when enabled. |
contentColor: Color = Color.Unspecified |
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 = StandardIconButtonTokens.DisabledOpacity) |
the content color of this icon button when not enabled. |
checkedContainerColor: Color = Color.Unspecified |
the container color of this icon button when checked. |
checkedContentColor: Color = Color.Unspecified |
the content color of this icon button when checked. |
largeContainerSize
@ExperimentalMaterial3ExpressiveApi
fun largeContainerSize(
widthOption: IconButtonDefaults.IconButtonWidthOption = IconButtonWidthOption.Uniform
): DpSize
Default container size for any large icon button.
| Parameters | |
|---|---|
widthOption: IconButtonDefaults.IconButtonWidthOption = IconButtonWidthOption.Uniform |
the width of the container |
mediumContainerSize
@ExperimentalMaterial3ExpressiveApi
fun mediumContainerSize(
widthOption: IconButtonDefaults.IconButtonWidthOption = IconButtonWidthOption.Uniform
): DpSize
Default container size for any medium icon button.
| Parameters | |
|---|---|
widthOption: IconButtonDefaults.IconButtonWidthOption = IconButtonWidthOption.Uniform |
the width of the container |
outlinedIconButtonBorder
@Composable
fun outlinedIconButtonBorder(enabled: Boolean): BorderStroke
Represents the BorderStroke for an OutlinedIconButton, depending on its enabled state. LocalContentColor will be used as the border color.
See outlinedIconToggleButtonVibrantBorder for a BorderStroke that uses the spec recommended color as the border color.
| Parameters | |
|---|---|
enabled: Boolean |
whether the icon button is enabled |
outlinedIconButtonColors
@Composable
fun outlinedIconButtonColors(): IconButtonColors
Creates a IconButtonColors that represents the default colors used in a OutlinedIconButton. LocalContentColor will be applied to the icon and down the UI tree.
See outlinedIconButtonVibrantColors for default values that applies the recommended high contrast colors.
outlinedIconButtonColors
@Composable
fun outlinedIconButtonColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = LocalContentColor.current,
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = contentColor.copy(alpha = OutlinedIconButtonTokens.DisabledOpacity)
): IconButtonColors
Creates a IconButtonColors that represents the default colors used in a OutlinedIconButton.
See outlinedIconButtonVibrantColors for default values that applies the recommended high contrast colors.
| 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 = OutlinedIconButtonTokens.DisabledOpacity) |
the content color of this icon button when not enabled. |
outlinedIconButtonVibrantBorder
@Composable
fun outlinedIconButtonVibrantBorder(enabled: Boolean): BorderStroke
Represents the BorderStroke for an OutlinedIconButton, depending on its enabled state. The spec recommended color will be used as the border color.
| Parameters | |
|---|---|
enabled: Boolean |
whether the icon button is enabled |
outlinedIconButtonVibrantColors
@Composable
fun outlinedIconButtonVibrantColors(): IconButtonColors
Creates a IconButtonColors that represents the default colors used in a OutlinedIconButton.
See outlinedIconButtonColors for default values that applies LocalContentColor to the icon and down the UI tree.
outlinedIconButtonVibrantColors
@Composable
fun outlinedIconButtonVibrantColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = Color.Unspecified,
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = contentColor.copy(alpha = OutlinedIconButtonTokens.DisabledOpacity)
): IconButtonColors
Creates a IconButtonColors that represents the default colors used in a OutlinedIconButton.
See outlinedIconButtonColors for default values that applies LocalContentColor to the icon and down the UI tree.
| Parameters | |
|---|---|
containerColor: Color = Color.Unspecified |
the container color of this icon button when enabled. |
contentColor: Color = Color.Unspecified |
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 = 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. LocalContentColor will be used as the border color.
See outlinedIconToggleButtonVibrantBorder for a BorderStroke that uses the spec recommended color as the border color.
outlinedIconToggleButtonColors
@Composable
fun outlinedIconToggleButtonColors(): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the default colors used in a OutlinedIconToggleButton. LocalContentColor will be applied to the icon and down the UI tree.
See outlinedIconButtonVibrantColors for default values that applies the recommended high contrast colors.
outlinedIconToggleButtonColors
@Composable
fun outlinedIconToggleButtonColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = LocalContentColor.current,
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = contentColor.copy(alpha = OutlinedIconButtonTokens.DisabledOpacity),
checkedContainerColor: Color = Color.Unspecified,
checkedContentColor: Color = contentColorFor(checkedContainerColor)
): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the default colors used in a OutlinedIconToggleButton. LocalContentColor will be applied to the icon and down the UI tree.
See outlinedIconButtonVibrantColors for default values that applies the recommended high contrast colors.
| 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 = OutlinedIconButtonTokens.DisabledOpacity) |
the content color of this icon button when not enabled. |
checkedContainerColor: Color = Color.Unspecified |
the container color of this icon button when checked. |
checkedContentColor: Color = contentColorFor(checkedContainerColor) |
the content color of this icon button when checked. |
outlinedIconToggleButtonVibrantBorder
@Composable
fun outlinedIconToggleButtonVibrantBorder(enabled: Boolean, checked: Boolean): BorderStroke?
Represents the BorderStroke for an OutlinedIconButton, depending on its enabled and checked state. The spec recommended color will be used as the border color.
outlinedIconToggleButtonVibrantColors
@Composable
fun outlinedIconToggleButtonVibrantColors(): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the default colors used in a OutlinedIconToggleButton.
See outlinedIconToggleButtonColors for default values that applies LocalContentColor to the icon and down the UI tree.
outlinedIconToggleButtonVibrantColors
@Composable
fun outlinedIconToggleButtonVibrantColors(
containerColor: Color = Color.Unspecified,
contentColor: Color = Color.Unspecified,
disabledContainerColor: Color = Color.Unspecified,
disabledContentColor: Color = contentColor.copy(alpha = OutlinedIconButtonTokens.DisabledOpacity),
checkedContainerColor: Color = Color.Unspecified,
checkedContentColor: Color = contentColorFor(checkedContainerColor)
): IconToggleButtonColors
Creates a IconToggleButtonColors that represents the default colors used in a OutlinedIconToggleButton.
See outlinedIconToggleButtonColors for default values that applies LocalContentColor to the icon and down the UI tree.
| Parameters | |
|---|---|
containerColor: Color = Color.Unspecified |
the container color of this icon button when enabled. |
contentColor: Color = Color.Unspecified |
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 = OutlinedIconButtonTokens.DisabledOpacity) |
the content color of this icon button when not enabled. |
checkedContainerColor: Color = Color.Unspecified |
the container color of this icon button when checked. |
checkedContentColor: Color = contentColorFor(checkedContainerColor) |
the content color of this icon button when checked. |
shapes
@ExperimentalMaterial3ExpressiveApi
@Composable
fun shapes(): IconButtonShapes
Creates a IconButtonShapes that correspond to a default IconButton in the active and pressed states. IconButton will morph between these shapes as long as the shapes are all CornerBasedShapes.
shapes
@ExperimentalMaterial3ExpressiveApi
@Composable
fun shapes(shape: Shape? = null, pressedShape: Shape? = null): IconButtonShapes
Creates a IconButtonShapes that correspond to the shapes in the default or pressed states. Icon button will morph between these shapes as long as the shapes are all CornerBasedShapes.
| Parameters | |
|---|---|
shape: Shape? = null |
the unchecked shape for |
pressedShape: Shape? = null |
the unchecked shape for |
smallContainerSize
@ExperimentalMaterial3ExpressiveApi
fun smallContainerSize(
widthOption: IconButtonDefaults.IconButtonWidthOption = IconButtonWidthOption.Uniform
): DpSize
Default container size for any small icon button.
| Parameters | |
|---|---|
widthOption: IconButtonDefaults.IconButtonWidthOption = IconButtonWidthOption.Uniform |
the width of the container |
toggleableShapes
@ExperimentalMaterial3ExpressiveApi
@Composable
fun toggleableShapes(): IconToggleButtonShapes
Creates a ButtonShapes that correspond to a default IconToggleButton in the active, pressed and selected states. IconToggleButton will morph between these shapes as long as the shapes are all CornerBasedShapes.
toggleableShapes
@ExperimentalMaterial3ExpressiveApi
@Composable
fun toggleableShapes(
shape: Shape? = null,
pressedShape: Shape? = null,
checkedShape: Shape? = null
): IconToggleButtonShapes
Creates a IconToggleButtonShapes that correspond to the shapes in the default, pressed, and checked states. Icon button will morph between these shapes as long as the shapes are all CornerBasedShapes.
| Parameters | |
|---|---|
shape: Shape? = null |
the active shape for |
pressedShape: Shape? = null |
the pressed shape for |
checkedShape: Shape? = null |
the checked shape for |
Public properties
SmallSelectedSquareShape
@ExperimentalMaterial3ExpressiveApi
val SmallSelectedSquareShape: Shape
Default selected shape for any small, square icon button.
extraLargeIconSize
@ExperimentalMaterial3ExpressiveApi
val extraLargeIconSize: Dp
Default size for any xlarge icon button.
extraLargePressedShape
@ExperimentalMaterial3ExpressiveApi
val extraLargePressedShape: Shape
Default pressed shape for any extra large icon button.
extraLargeRoundShape
@ExperimentalMaterial3ExpressiveApi
val extraLargeRoundShape: Shape
Default shape for any extra large icon button.
extraLargeSelectedRoundShape
@ExperimentalMaterial3ExpressiveApi
val extraLargeSelectedRoundShape: Shape
Default selected shape for any extra large icon button.
extraLargeSelectedSquareShape
@ExperimentalMaterial3ExpressiveApi
val extraLargeSelectedSquareShape: Shape
Default selected shape for any extra large, square icon button.
extraLargeSquareShape
@ExperimentalMaterial3ExpressiveApi
val extraLargeSquareShape: Shape
Default shape for any extra large icon button.
extraSmallIconSize
@ExperimentalMaterial3ExpressiveApi
val extraSmallIconSize: Dp
Default container for any extra small icon button.
extraSmallPressedShape
@ExperimentalMaterial3ExpressiveApi
val extraSmallPressedShape: Shape
Default pressed shape for any extra small icon button.
extraSmallRoundShape
@ExperimentalMaterial3ExpressiveApi
val extraSmallRoundShape: Shape
Default round shape for any extra small icon button.
extraSmallSelectedRoundShape
@ExperimentalMaterial3ExpressiveApi
val extraSmallSelectedRoundShape: Shape
Default selected shape for any extra small icon button.
extraSmallSelectedSquareShape
@ExperimentalMaterial3ExpressiveApi
val extraSmallSelectedSquareShape: Shape
Default selected shape for any extra small, square icon button.
extraSmallSquareShape
@ExperimentalMaterial3ExpressiveApi
val extraSmallSquareShape: Shape
Default square shape for any extra small icon button.
largeIconSize
@ExperimentalMaterial3ExpressiveApi
val largeIconSize: Dp
Default size for any large icon button.
largePressedShape
@ExperimentalMaterial3ExpressiveApi
val largePressedShape: Shape
Default pressed shape for any large icon button.
largeRoundShape
@ExperimentalMaterial3ExpressiveApi
val largeRoundShape: Shape
Default shape for any large icon button.
largeSelectedRoundShape
@ExperimentalMaterial3ExpressiveApi
val largeSelectedRoundShape: Shape
Default selected shape for any large icon button.
largeSelectedSquareShape
@ExperimentalMaterial3ExpressiveApi
val largeSelectedSquareShape: Shape
Default selected shape for any large, square icon button.
largeSquareShape
@ExperimentalMaterial3ExpressiveApi
val largeSquareShape: Shape
Default shape for any large icon button.
mediumIconSize
@ExperimentalMaterial3ExpressiveApi
val mediumIconSize: Dp
Default container size for any medium icon button.
mediumPressedShape
@ExperimentalMaterial3ExpressiveApi
val mediumPressedShape: Shape
Default pressed shape for any medium icon button.
mediumRoundShape
@ExperimentalMaterial3ExpressiveApi
val mediumRoundShape: Shape
Default shape for any medium icon button.
mediumSelectedRoundShape
@ExperimentalMaterial3ExpressiveApi
val mediumSelectedRoundShape: Shape
Default selected shape for any medium icon button.
mediumSelectedSquareShape
@ExperimentalMaterial3ExpressiveApi
val mediumSelectedSquareShape: Shape
Default selected shape for any medium, square icon button.
mediumSquareShape
@ExperimentalMaterial3ExpressiveApi
val mediumSquareShape: Shape
Default shape for any medium icon button.
smallIconSize
@ExperimentalMaterial3ExpressiveApi
val smallIconSize: Dp
Default size for any small icon button.
smallPressedShape
@ExperimentalMaterial3ExpressiveApi
val smallPressedShape: Shape
Default pressed shape for any small icon button.
smallRoundShape
@ExperimentalMaterial3ExpressiveApi
val smallRoundShape: Shape
Default shape for any small icon button.
smallSelectedRoundShape
@ExperimentalMaterial3ExpressiveApi
val smallSelectedRoundShape: Shape
Default selected shape for any small icon button.
smallSquareShape
@ExperimentalMaterial3ExpressiveApi
val smallSquareShape: Shape
Default square shape for any small icon button.