ButtonDefaults

object ButtonDefaults

Contains the default values used by Button

Properties

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

The default content padding used by Button

val MinWidth = 64.dp

The default min width applied for the Button. Note that you can override it by applying Modifier.widthIn directly on Button.

val MinHeight = 36.dp

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

val IconSize = 18.dp

The default size of the icon when used inside a Button.

val IconSpacing = 8.dp

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

const val OutlinedBorderOpacity = 0.12f

The default color opacity used for an OutlinedButton's border color

val OutlinedBorderSize = 1.dp

The default OutlinedButton's border size

val outlinedBorder: BorderStroke

The default disabled content color used by all types of Buttons

val TextButtonContentPadding =
    PaddingValues(
        start = TextButtonHorizontalPadding,
        top = ContentPadding.calculateTopPadding(),
        end = TextButtonHorizontalPadding,
        bottom = ContentPadding.calculateBottomPadding(),
    )

The default content padding used by TextButton

Functions

elevation

@Composable
    fun elevation(
        defaultElevation: Dp = 2.dp,
        pressedElevation: Dp = 8.dp,
        disabledElevation: Dp = 0.dp,
    ): ButtonElevation

Creates a ButtonElevation that will animate between the provided values according to the Material specification for a Button.

Parameters

elevation

@Composable
    fun elevation(
        defaultElevation: Dp = 2.dp,
        pressedElevation: Dp = 8.dp,
        disabledElevation: Dp = 0.dp,
        hoveredElevation: Dp = 4.dp,
        focusedElevation: Dp = 4.dp,
    ): ButtonElevation

Creates a ButtonElevation that will animate between the provided values according to the Material specification for a Button.

Parameters

buttonColors

@Composable
    fun buttonColors(
        backgroundColor: Color = MaterialTheme.colors.primary,
        contentColor: Color = contentColorFor(backgroundColor),
        disabledBackgroundColor: Color =
            MaterialTheme.colors.onSurface
                .copy(alpha = 0.12f)
                .compositeOver(MaterialTheme.colors.surface),
        disabledContentColor: Color =
            MaterialTheme.colors.onSurface.copy(alpha = ContentAlpha.disabled),
    ): ButtonColors

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

Parameters

outlinedButtonColors

@Composable
    fun outlinedButtonColors(
        backgroundColor: Color = MaterialTheme.colors.surface,
        contentColor: Color = MaterialTheme.colors.primary,
        disabledContentColor: Color =
            MaterialTheme.colors.onSurface.copy(alpha = ContentAlpha.disabled),
    ): ButtonColors

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

Parameters

textButtonColors

@Composable
    fun textButtonColors(
        backgroundColor: Color = Color.Transparent,
        contentColor: Color = MaterialTheme.colors.primary,
        disabledContentColor: Color =
            MaterialTheme.colors.onSurface.copy(alpha = ContentAlpha.disabled),
    ): ButtonColors

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

Parameters