RangeSliderState

Artifact: androidx.compose.material3:material3

View Source

Added in 1.2.0

---

Kotlin |Java

Common/AllAndroid/JVM

• Cmn

  @ExperimentalMaterial3Api
  class RangeSliderState

---

Class that holds information about RangeSlider's active range.

Summary

Public constructors
RangeSliderState(     activeRangeStart: Float,     activeRangeEnd: Float,     steps: @IntRange(from = 0) Int,     onValueChangeFinished: (() -> Unit)?,     valueRange: ClosedFloatingPointRange<Float> )	Cmn

Public properties
Float	activeRangeEnd Float that indicates the end of the current active range for the RangeSlider.	Cmn
Float	activeRangeStart Float that indicates the start of the current active range for the RangeSlider.	Cmn
(() -> Unit)?	onValueChangeFinished lambda to be invoked when value change has ended.	Cmn
Int	steps if greater than 0, specifies the amounts of discrete values, evenly distributed between across the whole value range.	Cmn
ClosedFloatingPointRange<Float>	valueRange range of values that Range Slider values can take.	Cmn

Public constructors

RangeSliderState

Cmn

Added in 1.2.0

RangeSliderState(
    activeRangeStart: Float = 0.0f,
    activeRangeEnd: Float = 1.0f,
    steps: @IntRange(from = 0) Int = 0,
    onValueChangeFinished: (() -> Unit)? = null,
    valueRange: ClosedFloatingPointRange<Float> = 0f..1f
)

Parameters
activeRangeStart: Float = 0.0f	Float that indicates the initial start of the active range of the slider. If outside of valueRange provided, value will be coerced to this range.
activeRangeEnd: Float = 1.0f	Float that indicates the initial end of the active range of the slider. If outside of valueRange provided, value will be coerced to this range.
steps: @IntRange(from = 0) Int = 0	if greater than 0, specifies the amounts of discrete values, evenly distributed between across the whole value range. If 0, range slider will behave as a continuous slider and allow to choose any value from the range specified. Must not be negative.
onValueChangeFinished: (() -> Unit)? = null	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.
valueRange: ClosedFloatingPointRange<Float> = 0f..1f	range of values that Range Slider values can take. activeRangeStart and activeRangeEnd will be coerced to this range.

Public properties

activeRangeEnd

Cmn

Added in 1.2.0

var activeRangeEnd: Float

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

activeRangeStart

Cmn

Added in 1.2.0

var activeRangeStart: Float

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

onValueChangeFinished

Cmn

Added in 1.2.0

var onValueChangeFinished: (() -> Unit)?

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.

steps

Cmn

Added in 1.2.0

val steps: Int

if greater than 0, specifies the amounts of discrete values, evenly distributed between across the whole value range. If 0, range slider will behave as a continuous slider and allow to choose any value from the range specified. Must not be negative.

valueRange

Cmn

Added in 1.2.0

val valueRange: ClosedFloatingPointRange<Float>

range of values that Range Slider values can take. activeRangeStart and activeRangeEnd will be coerced to this range.