SplitSwitchButton

Component in Wear Material 3 Compose

The Wear Material [SplitSwitchButton] offers slots and a specific layout for a label and secondary label. The secondaryLabel is optional. The items are laid out with a column containing the two label slots and a Switch at the end.

The [SplitSwitchButton] is Stadium shaped. The label should take no more than 3 lines of text. The secondary label should take no more than 2 lines of text. With localisation and/or large font sizes, the [SplitSwitchButton] height adjusts to accommodate the contents. The label and secondary label are start aligned by default.

A [SplitSwitchButton] has two tappable areas, one tap area for the labels and another for the switch. The [onContainerClick] listener will be associated with the main body of the [SplitSwitchButton] with the [onCheckedChange] listener associated with the switch area only.

Last updated: 2024-10-22 13:47

Installation

dependencies {
   implementation("androidx.wear.compose:compose-material3:1.0.0-alpha27")
}

Overloads

@Composable
fun SplitSwitchButton(
    checked: Boolean,
    onCheckedChange: (Boolean) -> Unit,
    toggleContentDescription: String?,
    onContainerClick: () -> Unit,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    shape: Shape = SwitchButtonDefaults.splitSwitchButtonShape,
    colors: SplitSwitchButtonColors = SwitchButtonDefaults.splitSwitchButtonColors(),
    toggleInteractionSource: MutableInteractionSource? = null,
    containerInteractionSource: MutableInteractionSource? = null,
    containerClickLabel: String? = null,
    contentPadding: PaddingValues = SwitchButtonDefaults.ContentPadding,
    secondaryLabel: @Composable (RowScope.() -> Unit)? = null,
    label: @Composable RowScope.() -> Unit
)

Parameters

name	description
checked	Boolean flag indicating whether this button is currently checked.
onCheckedChange	Callback to be invoked when this buttons checked status is changed.
toggleContentDescription	The content description for the switch control part of the component.
onContainerClick	Click listener called when the user clicks the main body of the button, the area behind the labels.
modifier	Modifier to be applied to the button.
enabled	Controls the enabled state of the button. When false, this button will not be clickable.
shape	Defines the button's shape. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material Theme.
colors	[SplitSwitchButtonColors] that will be used to resolve the background and content color for this button in different states.
toggleInteractionSource	an optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s for this button's "toggleable" tap area. You can use this to change the button's appearance or preview the button in different states. Note that if null is provided, interactions will still happen internally.
containerInteractionSource	an optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s for this button's main body "clickable" tap area. You can use this to change the button's appearance or preview the button in different states. Note that if null is provided, interactions will still happen internally.
containerClickLabel	Optional click label on the main body of the button for accessibility.
contentPadding	The spacing values to apply internally between the container and the content.
secondaryLabel	A slot for providing the button's secondary label. The contents are expected to be "start" aligned.
label	A slot for providing the button's main label. The contents are expected to be text which is "start" aligned.

Code Example

SplitSwitchButtonSample

@Composable
fun SplitSwitchButtonSample() {
    var checked by remember { mutableStateOf(true) }
    SplitSwitchButton(
        label = { Text("Split Switch Button", maxLines = 3, overflow = TextOverflow.Ellipsis) },
        checked = checked,
        onCheckedChange = { checked = it },
        toggleContentDescription = "Split Switch Button Sample",
        onContainerClick = {
            /* Do something */
        },
        enabled = true,
    )
}