spark/com.adevinta.spark.components.segmentedcontrol/SegmentedControlScope

SegmentedControlScope

DSL scope for declaring segments inside a SegmentedControl content block.

Each function adds one segment in declaration order. The return type SegmentedButtonItem is a marker; callers discard it. All variants animate label weight and colour between the selected and unselected states; icons additionally animate between com.adevinta.spark.tokens.SparkColors.support (unselected) and com.adevinta.spark.tokens.SparkColors.supportVariant (selected).

Enabled state and indicator shape are inherited from the enclosing SegmentedControl and cannot be overridden per segment.

Functions

custom

@Composable

abstract fun custom(selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier, rippleColor: Color = SparkTheme.colors.outlineHigh, content: @Composable () -> Unit): SegmentedButtonItem

Segment with fully custom content. Use this when no other scope variant fits — for example, when segment appearance must vary with the selected value (e.g. a colour-coded energy-rating scale).

icon

@Composable

abstract fun icon(icon: SparkIcon, contentDescription: String, selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier): SegmentedButtonItem

Segment showing a single medium-sized SparkIcon.

iconText

@Composable

abstract fun iconText(icon: SparkIcon, text: String, selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier): SegmentedButtonItem

Segment showing a medium-sized SparkIcon above a single line of text.

number

@Composable

abstract fun number(number: Int, selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier): SegmentedButtonItem

Segment showing an integer label. Equivalent to singleLine with number converted to a string. Useful for compact numeric scales (e.g. ratings 1–5).

singleLine

@Composable

abstract fun singleLine(text: String, selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier): SegmentedButtonItem

Segment showing a single line of text, truncated with ellipsis when the segment is too narrow.

twoLine

@Composable

abstract fun twoLine(title: String, subtitle: String, selected: Boolean, onClick: () -> Unit, modifier: Modifier = Modifier): SegmentedButtonItem

Segment showing a bold primary line and a smaller caption below it. Both lines are single-line, truncated with ellipsis.