Start native apps faster with the Composables CLI ->
Class

RangeSliderState

Class that holds information about RangeSlider's active range.

Source set: Common
class RangeSliderState
@RememberInComposition
constructor(
    activeRangeStart: Float = 0f,
    activeRangeEnd: Float = 1f,
    @IntRange(from = 0) val steps: Int = 0,
    var onValueChangeFinished: (() -> Unit)? = null,
    val valueRange: ClosedFloatingPointRange<Float> = 0f..1f,
)

Class that holds information about RangeSlider's active range.

Parameters
activeRangeStart Float that indicates the initial start value of the selected active range (for the start thumb). This represents a specific position on the track and is coerced to the bounds of valueRange.
activeRangeEnd Float that indicates the initial end value of the selected active range (for the end thumb). This represents a specific position on the track and is coerced to the bounds of valueRange.
steps if positive, specifies the amount of discrete allowable values between the endpoints of valueRange. For example, a range from 0 to 10 with 4 steps allows 4 values evenly distributed between 0 and 10 (i.e., 2, 4, 6, 8). If steps is 0, the slider will behave continuously and allow any value from the range. Must not be negative.
onValueChangeFinished lambda to be invoked when value change has ended. This callback shouldn't be used to update the range slider values (use onValueChange for that), but rather to know when the user has completed selecting a new value by ending a drag or a click. For keyboard movements, this is called on every step.
valueRange the full range of values that the entire Range Slider track represents. This defines the absolute boundaries/constraints of the slider (from minimum to maximum), and the individual thumb values (activeRangeStart and activeRangeEnd) are coerced to this range.

Properties

activeRangeStart

Source set: Common
var activeRangeStart: Float

Float that indicates the start of the current active range for the RangeSlider.

activeRangeEnd

Source set: Common
var activeRangeEnd: Float

Float that indicates the end of the current active range for the RangeSlider.

Companion Object

Methods

Source set: Common
fun Saver(
            steps: Int,
            valueRange: ClosedFloatingPointRange<Float>,
            onValueChangeFinished: (() -> Unit)?,
        ): Saver<RangeSliderState, *>

The default Saver implementation for RangeSliderState.

Parameters
steps if positive, specifies the amount of discrete allowable values between the endpoints of valueRange.
valueRange range of values that Range Slider values can take. activeRangeStart and activeRangeEnd will be coerced to this range.
onValueChangeFinished lambda to be invoked when value change has ended.

Deprecated

Maintained for binary compatibility.

Source set: Common
fun Saver(
            onValueChangeFinished: (() -> Unit)?,
            valueRange: ClosedFloatingPointRange<Float>,
        ): Saver<RangeSliderState, *>

Last updated: