Build apps faster with our new App builder! Check it out →

Slider

Android

Component in Wear Material 3 Compose

[Slider] allows users to make a selection from a range of values. The range of selections is shown as a bar between the minimum and maximum values of the range, from which users may select a single value. Slider is ideal for adjusting settings such as volume or brightness.

Value can be increased and decreased by clicking on the increase and decrease buttons, located accordingly to the start and end of the control. Buttons can have custom icons - [decreaseIcon] and [increaseIcon].

The bar in the middle of control can have separators if [segmented] flag is set to true. A single step value is calculated as the difference between min and max values of [valueRange] divided by [steps] + 1 value.

Last updated:

Installation

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

Overloads

@Composable
fun Slider(
    value: Float,
    onValueChange: (Float) -> Unit,
    steps: Int,
    modifier: Modifier = Modifier,
    decreaseIcon: @Composable () -> Unit = { SliderDefaults.DecreaseIcon() },
    increaseIcon: @Composable () -> Unit = { SliderDefaults.IncreaseIcon() },
    enabled: Boolean = true,
    valueRange: ClosedFloatingPointRange<Float> = 0f..(steps + 1).toFloat(),
    segmented: Boolean = steps {'<='} MaxSegmentSteps,
    shape: Shape = SliderDefaults.shape,
    colors: SliderColors = SliderDefaults.sliderColors(),
)

Parameters

namedescription
valueCurrent value of the Slider. If outside of [valueRange] provided, value will be coerced to this range.
onValueChangeLambda in which value should be updated.
stepsSpecifies the number of discrete values, excluding min and max values, evenly distributed across the whole value range. Must not be negative. If 0, slider will have only min and max values and no steps in between.
decreaseIconA slot for an icon which is placed on the decrease (start) button such as [SliderDefaults.DecreaseIcon].
increaseIconA slot for an icon which is placed on the increase (end) button such as [SliderDefaults.IncreaseIcon].
modifierModifiers for the Slider layout.
enabledControls the enabled state of the slider. When false, this slider will not be clickable.
valueRangeRange of values that Slider value can take. Passed [value] will be coerced to this range.
segmentedA boolean value which specifies whether a bar will be split into segments or not. Recommendation is while using this flag do not have more than [MaxSegmentSteps] steps as it might affect user experience. By default true if number of [steps] is {'<='} [MaxSegmentSteps].
shapeDefines slider's shape. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material3 Theme.
colors[SliderColors] that will be used to resolve the background and content color for this slider in different states.
@Composable
fun Slider(
    value: Int,
    onValueChange: (Int) -> Unit,
    valueProgression: IntProgression,
    modifier: Modifier = Modifier,
    decreaseIcon: @Composable () -> Unit = { SliderDefaults.DecreaseIcon() },
    increaseIcon: @Composable () -> Unit = { SliderDefaults.IncreaseIcon() },
    enabled: Boolean = true,
    segmented: Boolean = valueProgression.stepsNumber() {'<='} MaxSegmentSteps,
    shape: Shape = SliderDefaults.shape,
    colors: SliderColors = SliderDefaults.sliderColors(),
)

Parameters

namedescription
valueCurrent value of the Slider. If outside of [valueProgression] provided, value will be coerced to this range.
onValueChangeLambda in which value should be updated.
valueProgressionProgression of values that Slider value can take. Consists of rangeStart, rangeEnd and step. Range will be equally divided by step size.
decreaseIconA slot for an icon which is placed on the decrease (start) button such as [SliderDefaults.DecreaseIcon].
increaseIconA slot for an icon which is placed on the increase (end) button such as [SliderDefaults.IncreaseIcon].
modifierModifiers for the Slider layout.
enabledControls the enabled state of the slider. When false, this slider will not be clickable.
segmentedA boolean value which specifies whether a bar will be split into segments or not. Recommendation is while using this flag do not have more than [MaxSegmentSteps] steps as it might affect user experience. By default true if number of steps is {'<='} [MaxSegmentSteps].
shapeDefines slider's shape. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material3 Theme.
colors[SliderColors] that will be used to resolve the background and content color for this slider in different states.

Code Examples

SliderSample

@Composable
fun SliderSample() {
    var value by remember { mutableStateOf(4.5f) }
    Slider(
        value = value,
        onValueChange = { value = it },
        valueRange = 3f..6f,
        steps = 5,
        segmented = false
    )
}

SliderSegmentedSample

@Composable
fun SliderSegmentedSample() {
    var value by remember { mutableStateOf(2f) }
    Slider(
        value = value,
        onValueChange = { value = it },
        valueRange = 1f..4f,
        steps = 7,
        segmented = true
    )
}

SliderWithIntegerSample

@Composable
fun SliderWithIntegerSample() {
    var value by remember { mutableStateOf(4) }
    Slider(
        value = value,
        onValueChange = { value = it },
        valueProgression = 0..10,
        segmented = false
    )
}
by @alexstyl