SingleChoiceSegmentedButtonRowScope

Artifact: androidx.compose.material3:material3

Added in 1.2.0

Cmn

interface SingleChoiceSegmentedButtonRowScope : RowScope

Scope for the children of a SingleChoiceSegmentedButtonRow

Summary

Extension functions
`Unit`	`@Composable SingleChoiceSegmentedButtonRowScope.SegmentedButton( selected: Boolean, onClick: () -> Unit, shape: Shape, modifier: Modifier, enabled: Boolean, colors: SegmentedButtonColors, border: BorderStroke, contentPadding: PaddingValues, interactionSource: MutableInteractionSource?, icon: @Composable () -> Unit, label: @Composable () -> Unit )` Material Segmented Button.	Cmn

Inherited functions

From androidx.compose.foundation.layout.RowScope

`Modifier`	`Modifier.align(alignment: Alignment.Vertical)` Align the element vertically within the `Row`.	Cmn
`Modifier`	`Modifier.alignBy(alignmentLineBlock: (Measured) -> Int)` Position the element vertically such that the alignment line for the content as determined by `alignmentLineBlock` aligns with sibling elements also configured to `alignBy`.	Cmn
`Modifier`	`Modifier.alignBy(alignmentLine: HorizontalAlignmentLine)` Position the element vertically such that its `alignmentLine` aligns with sibling elements also configured to `alignBy`.	Cmn
`Modifier`	`Modifier.alignByBaseline()` Position the element vertically such that its first baseline aligns with sibling elements also configured to `alignByBaseline` or `alignBy`.	Cmn
`Modifier`	`Modifier.weight( weight: @FloatRange(from = 0.0, fromInclusive = false) Float, fill: Boolean )` Size the element's width proportional to its `weight` relative to other weighted sibling elements in the `Row`.	Cmn

Extension functions

SegmentedButton

Cmn

Artifact: androidx.compose.material3:material3

View Source

@Composable
fun SingleChoiceSegmentedButtonRowScope.SegmentedButton(
    selected: Boolean,
    onClick: () -> Unit,
    shape: Shape,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    colors: SegmentedButtonColors = SegmentedButtonDefaults.colors(),
    border: BorderStroke = SegmentedButtonDefaults.borderStroke(colors.borderColor(enabled, selected)),
    contentPadding: PaddingValues = SegmentedButtonDefaults.ContentPadding,
    interactionSource: MutableInteractionSource? = null,
    icon: @Composable () -> Unit = { SegmentedButtonDefaults.Icon(selected) },
    label: @Composable () -> Unit
): Unit

Material Segmented Button. Segmented buttons help people select options, switch views, or sort elements.

A default Toggleable Segmented Button. Also known as Outlined Segmented Button. See Modifier.selectable.

Selectable segmented buttons should be used for cases where the selection is mutually exclusive, when only one button can be selected at a time.

This should typically be used inside of a SingleChoiceSegmentedButtonRow

For a sample showing Segmented button with only checked icons see:

import androidx.compose.foundation.layout.size
import androidx.compose.material3.SegmentedButton
import androidx.compose.material3.SegmentedButtonDefaults
import androidx.compose.material3.SingleChoiceSegmentedButtonRow
import androidx.compose.material3.Text
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember

var selectedIndex by remember { mutableStateOf(0) }
val options = listOf("Day", "Month", "Week")
SingleChoiceSegmentedButtonRow {
    options.forEachIndexed { index, label ->
        SegmentedButton(
            shape = SegmentedButtonDefaults.itemShape(index = index, count = options.size),
            onClick = { selectedIndex = index },
            selected = index == selectedIndex
        ) {
            Text(label)
        }
    }
}

Parameters
`selected: Boolean`	whether this button is selected or not
`onClick: () -> Unit`	callback to be invoked when the button is clicked. therefore the change of checked state in requested.
`shape: Shape`	the shape for this button
`modifier: Modifier = Modifier`	the `Modifier` to be applied to this button
`enabled: Boolean = true`	controls the enabled state of this button. When `false`, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.
`colors: SegmentedButtonColors = SegmentedButtonDefaults.colors()`	`SegmentedButtonColors` that will be used to resolve the colors used for this
`border: BorderStroke = SegmentedButtonDefaults.borderStroke(colors.borderColor(enabled, selected))`	the border for this button, see `SegmentedButtonColors` Button in different states
`contentPadding: PaddingValues = SegmentedButtonDefaults.ContentPadding`	the spacing values to apply internally between the container and the content
`interactionSource: MutableInteractionSource? = null`	an optional hoisted `MutableInteractionSource` for observing and emitting `Interaction`s for this button. 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.
`icon: @Composable () -> Unit = { SegmentedButtonDefaults.Icon(selected) }`	the icon slot for this button, you can pass null in unchecked, in which case the content will displace to show the checked icon, or pass different icon lambdas for unchecked and checked in which case the icons will crossfade.
`label: @Composable () -> Unit`	content to be rendered inside this button