SplitButtonDefaults

@ExperimentalMaterial3ExpressiveApi
object SplitButtonDefaults

Contains default values used by SplitButtonLayout and its style variants.

Properties

val LeadingIconSize = ButtonSmallTokens.IconSize

Default icon size for the leading button

val TrailingIconSize = SplitButtonSmallTokens.TrailingIconSize

Default icon size for the trailing button

val Spacing = SplitButtonSmallTokens.BetweenSpace

Default spacing between the leading and trailing button

Deprecated Use SmallInnerCornerSize instead

val InnerCornerSize = SplitButtonSmallTokens.InnerCornerCornerSize

Default size for the leading button end corners and trailing button start corners

val ExtraSmallInnerCornerSize = SplitButtonXSmallTokens.InnerCornerCornerSize

Default extra small size for the leading button end corners and trailing button start corners

val SmallInnerCornerSize = SplitButtonSmallTokens.InnerCornerCornerSize

Default small size for the leading button end corners and trailing button start corners

val MediumInnerCornerSize = SplitButtonMediumTokens.InnerCornerCornerSize

Default medium size for the leading button end corners and trailing button start corners

val LargeInnerCornerSize = SplitButtonLargeTokens.InnerCornerCornerSize

Default large size for the leading button end corners and trailing button start corners

val ExtraLargeInnerCornerSize = SplitButtonXLargeTokens.InnerCornerCornerSize

Default extra large size for the leading button end corners and trailing button start corners

val ExtraSmallInnerCornerSizePressed = SplitButtonXSmallTokens.InnerPressedCornerCornerSize

Default extra small size for the leading button end corners and trailing button start corners when pressed

val SmallInnerCornerSizePressed = SplitButtonSmallTokens.InnerPressedCornerCornerSize

Default small size for the leading button end corners and trailing button start corners when pressed

val MediumInnerCornerSizePressed = SplitButtonMediumTokens.InnerPressedCornerCornerSize

Default medium size for the leading button end corners and trailing button start corners when pressed

val LargeInnerCornerSizePressed = SplitButtonLargeTokens.InnerPressedCornerCornerSize

Default large size for the leading button end corners and trailing button start corners when pressed

val ExtraLargeInnerCornerSizePressed = SplitButtonXLargeTokens.InnerPressedCornerCornerSize

Default extra large size for the leading button end corners and trailing button start corners when pressed

val OuterCornerSize = ShapeDefaults.CornerFull

Default percentage size for the leading button start corners and trailing button end corners

Deprecated Use leadingButtonContentPaddingFor(buttonHeight) instead

val LeadingButtonContentPadding =
    PaddingValues(
        start = SplitButtonSmallTokens.LeadingButtonLeadingSpace,
        end = SplitButtonSmallTokens.LeadingButtonTrailingSpace,
    )

Default content padding of the leading button

@ExperimentalMaterial3ExpressiveApi
val ExtraSmallLeadingButtonContentPadding =
    PaddingValues(
        start = SplitButtonXSmallTokens.LeadingButtonLeadingSpace,
        end = SplitButtonXSmallTokens.LeadingButtonTrailingSpace,
    )

Default content padding of the extra small leading button

@ExperimentalMaterial3ExpressiveApi
val SmallLeadingButtonContentPadding =
    PaddingValues(
        start = SplitButtonSmallTokens.LeadingButtonLeadingSpace,
        end = SplitButtonSmallTokens.LeadingButtonTrailingSpace,
    )

Default content padding of the small leading button

@ExperimentalMaterial3ExpressiveApi
val MediumLeadingButtonContentPadding =
    PaddingValues(
        start = SplitButtonMediumTokens.LeadingButtonLeadingSpace,
        end = SplitButtonMediumTokens.LeadingButtonTrailingSpace,
    )

Default content padding of the medium leading button

@ExperimentalMaterial3ExpressiveApi
val LargeLeadingButtonContentPadding =
    PaddingValues(
        start = SplitButtonLargeTokens.LeadingButtonLeadingSpace,
        end = SplitButtonLargeTokens.LeadingButtonTrailingSpace,
    )

Default content padding of the large leading button

@ExperimentalMaterial3ExpressiveApi
val ExtraLargeLeadingButtonContentPadding =
    PaddingValues(
        start = SplitButtonXLargeTokens.LeadingButtonLeadingSpace,
        end = SplitButtonXLargeTokens.LeadingButtonTrailingSpace,
    )

Default content padding of the extra large leading button

@ExperimentalMaterial3ExpressiveApi
val ExtraSmallTrailingButtonContentPadding =
    PaddingValues(
        start = SplitButtonXSmallTokens.TrailingButtonLeadingSpace,
        end = SplitButtonXSmallTokens.TrailingButtonTrailingSpace,
    )

Default content padding of the extra small trailing button

@ExperimentalMaterial3ExpressiveApi
val SmallTrailingButtonContentPadding =
    PaddingValues(
        start = SplitButtonSmallTokens.TrailingButtonLeadingSpace,
        end = SplitButtonSmallTokens.TrailingButtonTrailingSpace,
    )

Default content padding of the small trailing button

@ExperimentalMaterial3ExpressiveApi
val MediumTrailingButtonContentPadding =
    PaddingValues(
        start = SplitButtonMediumTokens.TrailingButtonLeadingSpace,
        end = SplitButtonMediumTokens.TrailingButtonTrailingSpace,
    )

Default content padding of the medium trailing button

@ExperimentalMaterial3ExpressiveApi
val LargeTrailingButtonContentPadding =
    PaddingValues(
        start = SplitButtonLargeTokens.TrailingButtonLeadingSpace,
        end = SplitButtonLargeTokens.TrailingButtonTrailingSpace,
    )

Default content padding of the large trailing button

@ExperimentalMaterial3ExpressiveApi
val ExtraLargeTrailingButtonContentPadding =
    PaddingValues(
        start = SplitButtonXLargeTokens.TrailingButtonLeadingSpace,
        end = SplitButtonXLargeTokens.TrailingButtonTrailingSpace,
    )

Default content padding of the extra large trailing button

val ExtraSmallTrailingButtonIconSize = SplitButtonXSmallTokens.TrailingIconSize

The default size of the icon used inside of an extra small trailing button of a split button.

val SmallTrailingButtonIconSize = SplitButtonSmallTokens.TrailingIconSize

The default size of the icon used inside of an small trailing button of a split button.

val MediumTrailingButtonIconSize = SplitButtonMediumTokens.TrailingIconSize

The default size of the icon used inside of an medium trailing button of a split button.

val LargeTrailingButtonIconSize = SplitButtonLargeTokens.TrailingIconSize

The default size of the icon used inside of an large trailing button of a split button.

val ExtraLargeTrailingButtonIconSize = SplitButtonXLargeTokens.TrailingIconSize

The default size of the icon used inside of an extra large trailing button of a split button.

Deprecated Use SmallTrailingButtonContentPadding instead

val TrailingButtonContentPadding =
    PaddingValues(
        start = SplitButtonSmallTokens.TrailingButtonLeadingSpace,
        end = SplitButtonSmallTokens.TrailingButtonTrailingSpace,
    )

Default content padding of the small trailing button

val SmallContainerHeight = SplitButtonSmallTokens.ContainerHeight

Default minimum height of the split button. This applies to both LeadingButton and TrailingButton. Applies to all 4 variants of the split button

@ExperimentalMaterial3ExpressiveApi
val ExtraSmallContainerHeight = SplitButtonXSmallTokens.ContainerHeight

The default height for an extra small button container.

@ExperimentalMaterial3ExpressiveApi
val MediumContainerHeight = SplitButtonMediumTokens.ContainerHeight

The default height for a medium button container.

@ExperimentalMaterial3ExpressiveApi
val LargeContainerHeight = SplitButtonLargeTokens.ContainerHeight

The default height for a large button container.

@ExperimentalMaterial3ExpressiveApi
val ExtraLargeContainerHeight = SplitButtonXLargeTokens.ContainerHeight

The default height for an extra large button container.

Functions

leadingButtonShapes

fun leadingButtonShapes(endCornerSize: CornerSize = SmallInnerCornerSize) =
        SplitButtonShapes(
            shape = leadingButtonShape(endCornerSize),
            pressedShape =
                RoundedCornerShape(
                    topStart = OuterCornerSize,
                    bottomStart = OuterCornerSize,
                    topEnd = SmallInnerCornerSizePressed,
                    bottomEnd = SmallInnerCornerSizePressed,
                ),
            checkedShape = null,
        )

Default shapes for the leading button. This defines the shapes the leading button should morph to when enabled, pressed etc.

Parameters

trailingButtonShapes

fun trailingButtonShapes(startCornerSize: CornerSize = SmallInnerCornerSize) =
        SplitButtonShapes(
            shape = trailingButtonShape(startCornerSize),
            pressedShape =
                RoundedCornerShape(
                    topStart = SmallInnerCornerSizePressed,
                    bottomStart = SmallInnerCornerSizePressed,
                    topEnd = OuterCornerSize,
                    bottomEnd = OuterCornerSize,
                ),
            checkedShape = TrailingCheckedShape,
        )

Default shapes for the trailing button

Parameters

leadingButtonShapesFor

@Composable
    @ExperimentalMaterial3ExpressiveApi
    fun leadingButtonShapesFor(buttonHeight: Dp): SplitButtonShapes

Recommended leading button SplitButtonShapes for a provided leading button height.

Parameters

trailingButtonShapesFor

@Composable
    @ExperimentalMaterial3ExpressiveApi
    fun trailingButtonShapesFor(buttonHeight: Dp): SplitButtonShapes

Recommended trailing button SplitButtonShapes for a provided trailing button height.

Parameters

leadingButtonContentPaddingFor

fun leadingButtonContentPaddingFor(buttonHeight: Dp): PaddingValues

Recommended PaddingValues for a provided leading button height.

Parameters

trailingButtonContentPaddingFor

fun trailingButtonContentPaddingFor(buttonHeight: Dp): PaddingValues

Recommended PaddingValues for a provided trailing button height.

Parameters

leadingButtonIconSizeFor

fun leadingButtonIconSizeFor(buttonHeight: Dp): Dp

Recommended leading button Icon size for a provided button height.

Parameters

trailingButtonIconSizeFor

fun trailingButtonIconSizeFor(buttonHeight: Dp): Dp

Recommended trailing button Icon size for a provided button height.

Parameters

LeadingButton

@ExperimentalMaterial3ExpressiveApi
    @Composable
    fun LeadingButton(
        onClick: () -> Unit,
        modifier: Modifier = Modifier,
        enabled: Boolean = true,
        shapes: SplitButtonShapes = leadingButtonShapesFor(SmallContainerHeight),
        colors: ButtonColors = ButtonDefaults.buttonColors(),
        elevation: ButtonElevation? = ButtonDefaults.buttonElevation(),
        border: BorderStroke? = null,
        contentPadding: PaddingValues = leadingButtonContentPaddingFor(SmallContainerHeight),
        interactionSource: MutableInteractionSource? = null,
        content: @Composable RowScope.() -> Unit,
    )

Create a default leading button that has the same visual as a FilledButton. To create a tonal, outlined, or elevated version, the default value of Button params can be passed in. For example, ElevatedButton.

The default text style for internal Text components will be set to Typography.labelLarge.

Parameters

TrailingButton

@Composable
    @ExperimentalMaterial3ExpressiveApi
    fun TrailingButton(
        onClick: () -> Unit,
        modifier: Modifier = Modifier,
        enabled: Boolean = true,
        shapes: SplitButtonShapes = trailingButtonShapesFor(SmallContainerHeight),
        colors: ButtonColors = ButtonDefaults.buttonColors(),
        elevation: ButtonElevation? = ButtonDefaults.buttonElevation(),
        border: BorderStroke? = null,
        contentPadding: PaddingValues = trailingButtonContentPaddingFor(SmallContainerHeight),
        interactionSource: MutableInteractionSource? = null,
        content: @Composable RowScope.() -> Unit,
    )

Creates a trailing button that has the same visual as a Button.

To create a tonal, outlined, or elevated version, the default value of Button params can be passed in. For example, ElevatedButton.

The default text style for internal Text components will be set to Typography.labelLarge.

Parameters

TrailingButton

@Composable
    @ExperimentalMaterial3ExpressiveApi
    fun TrailingButton(
        checked: Boolean,
        onCheckedChange: (Boolean) -> Unit,
        modifier: Modifier = Modifier,
        enabled: Boolean = true,
        shapes: SplitButtonShapes = trailingButtonShapesFor(SmallContainerHeight),
        colors: ButtonColors = ButtonDefaults.buttonColors(),
        elevation: ButtonElevation? = ButtonDefaults.buttonElevation(),
        border: BorderStroke? = null,
        contentPadding: PaddingValues = trailingButtonContentPaddingFor(SmallContainerHeight),
        interactionSource: MutableInteractionSource? = null,
        content: @Composable RowScope.() -> Unit,
    )

Creates a trailing button that has the same visual as a Button. When checked is updated from false to true, the buttons corners will morph to full by default. Pressed shape and checked shape can be customized via shapes param.

To create a tonal, outlined, or elevated version, the default value of Button params can be passed in. For example, ElevatedButton.

The default text style for internal Text components will be set to Typography.labelLarge.

Parameters

TonalLeadingButton

@ExperimentalMaterial3ExpressiveApi
    @Composable
    fun TonalLeadingButton(
        onClick: () -> Unit,
        modifier: Modifier = Modifier,
        enabled: Boolean = true,
        shapes: SplitButtonShapes = leadingButtonShapesFor(SmallContainerHeight),
        colors: ButtonColors = ButtonDefaults.filledTonalButtonColors(),
        elevation: ButtonElevation? = ButtonDefaults.filledTonalButtonElevation(),
        border: BorderStroke? = null,
        contentPadding: PaddingValues = leadingButtonContentPaddingFor(SmallContainerHeight),
        interactionSource: MutableInteractionSource? = null,
        content: @Composable RowScope.() -> Unit,
    )

Create a tonal leading button that has the same visual as a TonalButton. To create a filled, outlined, or elevated version, the default value of Button params can be passed in. For example, ElevatedButton.

The default text style for internal Text components will be set to Typography.labelLarge.

Parameters

TonalTrailingButton

@ExperimentalMaterial3ExpressiveApi
    @Composable
    fun TonalTrailingButton(
        checked: Boolean,
        onCheckedChange: (Boolean) -> Unit,
        modifier: Modifier = Modifier,
        enabled: Boolean = true,
        shapes: SplitButtonShapes = trailingButtonShapesFor(SmallContainerHeight),
        colors: ButtonColors = ButtonDefaults.filledTonalButtonColors(),
        elevation: ButtonElevation? = ButtonDefaults.filledTonalButtonElevation(),
        border: BorderStroke? = null,
        contentPadding: PaddingValues = trailingButtonContentPaddingFor(SmallContainerHeight),
        interactionSource: MutableInteractionSource? = null,
        content: @Composable RowScope.() -> Unit,
    )

Creates a tonal trailing button that has the same visual as a FilledTonalButton. When checked is updated from false to true, the buttons corners will morph to full by default. Pressed shape and checked shape can be customized via shapes param.

To create a tonal, outlined, or elevated version, the default value of Button params can be passed in. For example, ElevatedButton.

The default text style for internal Text components will be set to Typography.labelLarge.

Parameters

OutlinedLeadingButton

@ExperimentalMaterial3ExpressiveApi
    @Composable
    fun OutlinedLeadingButton(
        onClick: () -> Unit,
        modifier: Modifier = Modifier,
        enabled: Boolean = true,
        shapes: SplitButtonShapes = leadingButtonShapesFor(SmallContainerHeight),
        colors: ButtonColors = ButtonDefaults.outlinedButtonColors(),
        elevation: ButtonElevation? = null,
        border: BorderStroke? = ButtonDefaults.outlinedButtonBorder(enabled),
        contentPadding: PaddingValues = leadingButtonContentPaddingFor(SmallContainerHeight),
        interactionSource: MutableInteractionSource? = null,
        content: @Composable RowScope.() -> Unit,
    )

Create a elevated leading button that has the same visual as a ElevatedButton. To create a filled, outlined, or elevated version, the default value of Button params can be passed in. For example, ElevatedButton.

The default text style for internal Text components will be set to Typography.labelLarge.

Parameters

OutlinedTrailingButton

@ExperimentalMaterial3ExpressiveApi
    @Composable
    fun OutlinedTrailingButton(
        checked: Boolean,
        onCheckedChange: (Boolean) -> Unit,
        modifier: Modifier = Modifier,
        enabled: Boolean = true,
        shapes: SplitButtonShapes = trailingButtonShapesFor(SmallContainerHeight),
        colors: ButtonColors = ButtonDefaults.outlinedButtonColors(),
        elevation: ButtonElevation? = null,
        border: BorderStroke? = ButtonDefaults.outlinedButtonBorder(enabled),
        contentPadding: PaddingValues = trailingButtonContentPaddingFor(SmallContainerHeight),
        interactionSource: MutableInteractionSource? = null,
        content: @Composable RowScope.() -> Unit,
    )

Creates a outlined trailing button that has the same visual as a OutlinedButton. When checked is updated from false to true, the buttons corners will morph to full by default. Pressed shape and checked shape can be customized via shapes param.

To create a tonal, outlined, or elevated version, the default value of Button params can be passed in. For example, ElevatedButton.

The default text style for internal Text components will be set to Typography.labelLarge.

Parameters

ElevatedLeadingButton

@ExperimentalMaterial3ExpressiveApi
    @Composable
    fun ElevatedLeadingButton(
        onClick: () -> Unit,
        modifier: Modifier = Modifier,
        enabled: Boolean = true,
        shapes: SplitButtonShapes = leadingButtonShapesFor(SmallContainerHeight),
        colors: ButtonColors = ButtonDefaults.elevatedButtonColors(),
        elevation: ButtonElevation? = ButtonDefaults.elevatedButtonElevation(),
        border: BorderStroke? = null,
        contentPadding: PaddingValues = leadingButtonContentPaddingFor(SmallContainerHeight),
        interactionSource: MutableInteractionSource? = null,
        content: @Composable RowScope.() -> Unit,
    )

Create a elevated leading button that has the same visual as a ElevatedButton. To create a filled, outlined, or elevated version, the default value of Button params can be passed in. For example, ElevatedButton.

The default text style for internal Text components will be set to Typography.labelLarge.

Parameters

ElevatedTrailingButton

@ExperimentalMaterial3ExpressiveApi
    @Composable
    fun ElevatedTrailingButton(
        checked: Boolean,
        onCheckedChange: (Boolean) -> Unit,
        modifier: Modifier = Modifier,
        enabled: Boolean = true,
        shapes: SplitButtonShapes = trailingButtonShapesFor(SmallContainerHeight),
        colors: ButtonColors = ButtonDefaults.elevatedButtonColors(),
        elevation: ButtonElevation? = ButtonDefaults.elevatedButtonElevation(),
        border: BorderStroke? = null,
        contentPadding: PaddingValues = trailingButtonContentPaddingFor(SmallContainerHeight),
        interactionSource: MutableInteractionSource? = null,
        content: @Composable RowScope.() -> Unit,
    )

Creates a elevated trailing button that has the same visual as a ElevatedButton. When checked is updated from false to true, the buttons corners will morph to full by default. Pressed shape and checked shape can be customized via shapes param.

To create a tonal, outlined, or elevated version, the default value of Button params can be passed in. For example, ElevatedButton.

The default text style for internal Text components will be set to Typography.labelLarge.

Parameters