RangeSliderState

Class

Common
@ExperimentalMaterial3Api
class RangeSliderState(
    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

activeRangeStartFloat that indicates the initial start of the active range of the slider. If outside of valueRange provided, value will be coerced to this range.
activeRangeEndFloat that indicates the initial end of the active range of the slider. If outside of valueRange provided, value will be coerced to this range.
stepsif 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.
onValueChangeFinishedlambda 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.
valueRangerange of values that Range Slider values can take. activeRangeStart and activeRangeEnd will be coerced to this range.

Properties

Common
var activeRangeStart: Float

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

Common
var activeRangeEnd: Float

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

Companion Object

Methods

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

The default Saver implementation for RangeSliderState.

Parameters

onValueChangeFinishedlambda 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.
valueRangerange of values that Range Slider values can take. activeRangeStart and activeRangeEnd will be coerced to this range.