Source set: Common
public class RangeSliderState public constructor(
startValue: Float = 0f,
endValue: Float = 1f,
@IntRange(from = 0) public val steps: Int = 0,
public val trackRange: ClosedFloatingPointRange<Float> = 0f..1f,
)
Class that holds information about RangeSlider's active range.
Parameters
| startValue | Float that indicates the initial start value of the selected range (for the start thumb). This represents a specific position on the track and is coerced to the bounds of trackRange. |
| endValue | Float that indicates the initial end value of the selected range (for the end thumb). This represents a specific position on the track and is coerced to the bounds of trackRange. |
| steps | if positive, specifies the amount of discrete allowable values between the endpoints of trackRange. 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. |
| trackRange | 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 (startValue and endValue) are coerced to this range. |
Properties
startValue
Source set: Common
public var startValue: Float
Float that indicates the start of the selected range for the RangeSlider.
endValue
Source set: Common
public var endValue: Float
Float that indicates the end of the selected range for the RangeSlider.
Members
Companion
Source set: Common
public companion object
Functions
Saver
Source set: Common
public fun Saver(
steps: Int,
trackRange: ClosedFloatingPointRange<Float>,
): Saver<RangeSliderState, *>
The default Saver implementation for RangeSliderState.
Parameters
| steps | if positive, specifies the amount of discrete allowable values between the endpoints of trackRange. |
| trackRange | range of values that Range Slider values can take. startValue and endValue will be coerced to this range. |