ButtonDefaults

public object ButtonDefaults

Contains the default values used by Button

Properties

shape

public val shape: RoundedCornerShape

Recommended RoundedCornerShape for Button.

compactButtonShape

public val compactButtonShape: RoundedCornerShape

Recommended RoundedCornerShape for CompactButton.

ButtonHorizontalPadding

public val ButtonHorizontalPadding: Dp

The recommended horizontal content padding used by Button by default

ButtonLargeIconStartPadding

public val ButtonLargeIconStartPadding: Dp

The recommended start padding to be used with Button with a large icon

ButtonExtraLargeIconStartPadding

public val ButtonExtraLargeIconStartPadding: Dp

The recommended start padding to be used with Button with an extra large icon

ButtonVerticalPadding

public val ButtonVerticalPadding: Dp

The recommended vertical content padding used by Button by default

ContentPadding

public val ContentPadding: PaddingValues

The default content padding used by Button

ButtonWithLargeIconContentPadding

public val ButtonWithLargeIconContentPadding: PaddingValues

The default content padding used by Button with a large icon

ButtonWithExtraLargeIconContentPadding

public val ButtonWithExtraLargeIconContentPadding: PaddingValues

The default content padding used by Button with an extra large icon

minimumVerticalListContentPadding

public val minimumVerticalListContentPadding: Dp

The minimum vertical content padding for the list when a Button is placed at the top or bottom edge. Recommended for use with androidx.wear.compose.foundation.lazy.TransformingLazyColumnItemScope's androidx.wear.compose.foundation.lazy.TransformingLazyColumnItemScope.minimumVerticalContentPadding, which allows items to choose a preferred content padding for the list. TransformingLazyColumn takes its contentPadding as the maximum of the preferred content padding values and its own contentPadding parameter.

ExtraSmallIconSize

public val ExtraSmallIconSize: Dp

The recommended icon size when used in CompactButtons containing both icon and text.

SmallIconSize

public val SmallIconSize: Dp

The recommended icon size when used in CompactButtons containing icon-only content.

IconSize

public val IconSize: Dp

The recommended default size for icons when used inside a Button.

LargeIconSize

public val LargeIconSize: Dp

The recommended icon size when used in Buttons for icons such as an app icon

ExtraLargeIconSize

public val ExtraLargeIconSize: Dp

The recommended icon size when used in Buttons for icons such as an avatar icon

Height

public val Height: Dp

The default height applied for the Button. Note that you can override it by applying Modifier.heightIn directly on Button.

CompactButtonHorizontalPadding

public val CompactButtonHorizontalPadding: Dp

CompactButtonVerticalPadding

public val CompactButtonVerticalPadding: Dp

CompactButtonContentPadding

public val CompactButtonContentPadding: PaddingValues

The default content padding used by CompactButton

CompactButtonHeight

public val CompactButtonHeight: Dp

The height applied for the CompactButton. This includes a visible button height of 32.dp and 8.dp of padding above and below the button in order to meet accessibility guidelines that request a minimum of 48.dp height and width of tappable area.

Note that you can override it by adjusting Modifier.height and Modifier.padding directly on CompactButton.

CompactButtonTapTargetPadding

public val CompactButtonTapTargetPadding: PaddingValues

The default padding to be provided around a CompactButton in order to ensure that its tappable area meets minimum UX guidance.

IconSpacing

public val IconSpacing: Dp

The default size of the spacing between an icon and a text when they are used inside a Button or CompactButton.

DisabledContainerAlpha

public val DisabledContainerAlpha: Float

The default alpha applied to the container when the button is disabled.

scrimGradientStartColor

public val scrimGradientStartColor: Color

The default gradient start color when drawing a scrim over an image to ensure that the text text drawn over the image is legible.

scrimGradientEndColor

public val scrimGradientEndColor: Color

The default gradient end color when drawing a scrim over an image to ensure that the text text drawn over the image is legible.

Functions

filledTonalButtonColors

@Composable
public fun filledTonalButtonColors(): ButtonColors

Creates a ButtonColors with a muted background and contrasting content color, the defaults for medium emphasis buttons like FilledTonalButton. Use filledTonalButtonColors for important actions that don't distract from other onscreen elements, such as final or unblocking actions in a flow with less emphasis than buttonColors.

If a button is disabled then the content will have an alpha(DisabledContentAlpha) value applied and container will have alpha (DisabledContainerAlpha) value applied.

filledTonalButtonColors

@Composable
public fun filledTonalButtonColors(
    containerColor: Color = Color.Unspecified,
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContainerColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors

Creates a ButtonColors with a muted background and contrasting content color, the defaults for medium emphasis buttons like FilledTonalButton. Use filledTonalButtonColors for important actions that don't distract from other onscreen elements, such as final or unblocking actions in a flow with less emphasis than buttonColors.

If a button is disabled then the content will have an alpha(DisabledContentAlpha) value applied and container will have alpha (DisabledContainerAlpha) value applied.

Parameters

filledVariantButtonColors

@Composable
public fun filledVariantButtonColors(): ButtonColors

Creates a ButtonColors as an alternative to the filledTonalButtonColors, giving a surface with more chroma to indicate selected or highlighted states that are not primary calls-to-action. If the icon button is disabled then the colors will default to the MaterialTheme onSurface color with suitable alpha values applied.

If a button is disabled then the content will have an alpha(DisabledContentAlpha) value applied and container will have alpha (DisabledContainerAlpha) value applied.

Example of a Button with filledVariantButtonColors:

filledVariantButtonColors

@Composable
public fun filledVariantButtonColors(
    containerColor: Color = Color.Unspecified,
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContainerColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors

Creates a ButtonColors as an alternative to the filledTonalButtonColors, giving a surface with more chroma to indicate selected or highlighted states that are not primary calls-to-action. If the icon button is disabled then the colors will default to the MaterialTheme onSurface color with suitable alpha values applied.

If a button is disabled then the content will have an alpha(DisabledContentAlpha) value applied and container will have alpha (DisabledContainerAlpha) value applied.

Example of a Button with filledVariantButtonColors:

Parameters

outlinedButtonColors

@Composable
public fun outlinedButtonColors(): ButtonColors

Creates a ButtonColors with a transparent background (typically paired with ButtonDefaults.outlinedButtonBorder), the defaults for medium emphasis buttons like OutlinedButton, for important, non-primary actions that need attention.

If a button is disabled then the content will have an alpha(DisabledContentAlpha) value applied and container will have an alpha(DisabledContainerAlpha) applied.

outlinedButtonColors

@Composable
public fun outlinedButtonColors(
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors

Creates a ButtonColors with a transparent background (typically paired with ButtonDefaults.outlinedButtonBorder), the defaults for medium emphasis buttons like OutlinedButton, for important, non-primary actions that need attention.

If a button is disabled then the content will have an alpha(DisabledContentAlpha) value applied and container will have an alpha(DisabledContainerAlpha) applied.

Parameters

childButtonColors

@Composable
public fun childButtonColors(): ButtonColors

Creates a ButtonColors with transparent background, the defaults for low emphasis buttons like ChildButton. Use childButtonColors for optional or supplementary actions with the least amount of prominence.

If a button is disabled then the content will have an alpha(DisabledContentAlpha) value applied and container will have an alpha(DisabledContainerAlpha) value applied.

childButtonColors

@Composable
public fun childButtonColors(
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors

Creates a ButtonColors with transparent background, the defaults for low emphasis buttons like ChildButton. Use childButtonColors for optional or supplementary actions with the least amount of prominence.

If a button is disabled then the content will have an alpha(DisabledContentAlpha) value applied and container will have an alpha(DisabledContainerAlpha) value applied.

Parameters

buttonWithContainerPainterColors

@Composable
public fun buttonWithContainerPainterColors(): ButtonColors

Creates a ButtonColors for the content in a Button with an image container painter.

buttonWithContainerPainterColors

@Composable
public fun buttonWithContainerPainterColors(
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors

Creates a ButtonColors for the content in a Button with an image container painter.

Example of a Button with an image background:

Parameters

containerPainter

@Composable
public fun containerPainter(
    image: Painter,
    scrim: Brush? = scrimBrush(),
    sizeToIntrinsics: Boolean = false,
    alignment: Alignment = Alignment.Center,
    contentScale: ContentScale = ContentScale.Fit,
    alpha: Float = DefaultAlpha,
): Painter

Creates a Painter for the background of a Button with container painter, that displays an image with a scrim on top to make sure that any content above the background will be legible.

An Image background is a means to reinforce the meaning of information in a Button. Buttons should have a content color that contrasts with the background image and scrim.

Example of a Button with an image background:

Parameters

disabledContainerPainter

public fun disabledContainerPainter(containerPainter: Painter): Painter

Creates a Painter for the disabled background of a Button with container painter - draws the containerPainter with an alpha applied to achieve a disabled effect.

An Image background is a means to reinforce the meaning of information in a Button. Buttons should have a content color that contrasts with the background image and scrim.

Parameters

scrimBrush

@Composable
public fun scrimBrush(): Brush

Creates a Brush for the recommended scrim drawn on top of image container backgrounds.

outlinedButtonBorder

@Composable
public fun outlinedButtonBorder(
    enabled: Boolean,
    borderColor: Color = OutlinedButtonTokens.ContainerBorderColor.value,
    disabledBorderColor: Color =
        OutlinedButtonTokens.DisabledContainerBorderColor.value.toDisabledColor(
            disabledAlpha = OutlinedButtonTokens.DisabledContainerBorderOpacity
        ),
    borderWidth: Dp = OutlinedButtonTokens.ContainerBorderWidth,
): BorderStroke

Creates a BorderStroke, such as for an OutlinedButton

Parameters

buttonColors

@Composable
public fun buttonColors(): ButtonColors

Creates a ButtonColors that represents the default background and content colors used in a Button.

buttonColors

@Composable
public fun buttonColors(
    containerColor: Color = Color.Unspecified,
    contentColor: Color = Color.Unspecified,
    secondaryContentColor: Color = Color.Unspecified,
    iconColor: Color = Color.Unspecified,
    disabledContainerColor: Color = Color.Unspecified,
    disabledContentColor: Color = Color.Unspecified,
    disabledSecondaryContentColor: Color = Color.Unspecified,
    disabledIconColor: Color = Color.Unspecified,
): ButtonColors

Creates a ButtonColors that represents the default background and content colors used in a Button.

Parameters