Slider

A control for selecting a value from a bounded linear range of values.

ComponentiOS 13.0+macOS 10.15+watchOS 6.0+Slider in SwiftUI

Declaration

React
import { Slider } from 'swiftui-react-native';
Swift
nonisolated struct Slider<Label, ValueLabel> where Label : View, ValueLabel : View

Initializers

6 SwiftUI initializers back <Slider>. The props you pass pick one.

React
<Slider
  value: Binding<number>
  in?: SwiftRange<number>
  onEditingChanged?: (arg0: boolean) => void
/>
Swift
nonisolated init<V>(
    value: Binding<V>,
    in bounds: ClosedRange<V> = 0...1,
    onEditingChanged: @escaping (Bool) -> Void = { _ in }
)
where V : BinaryFloatingPoint, V.Stride : BinaryFloatingPoint
  • value*Binding<number>

    The selected value within bounds.

  • inSwiftRange<number>

    The range of the valid values. Defaults to 0...1.

    Default `0...1`Swift in bounds: ClosedRange<V>

  • onEditingChanged(arg0: boolean) => void

    A callback for when editing begins and ends.

    Default `{ _ in }`

Also takes the common view props: modifiers, style and testID.

Overview

A slider consists of a "thumb" image that the user moves between two extremes of a linear "track". The ends of the track represent the minimum and maximum possible values. As the user moves the thumb, the slider updates its bound value.

The following example shows a slider bound to the value speed. As the slider updates this value, a bound Text view shows the value updating. The onEditingChanged closure passed to the slider receives callbacks when the user drags the slider. The example uses this to change the color of the value text.

@State private var speed = 50.0
@State private var isEditing = false

var body: some View {
    VStack {
        Slider(
            value: $speed,
            in: 0...100,
            onEditingChanged: { editing in
                isEditing = editing
            }
        )
        Text("\(speed)")
            .foregroundColor(isEditing ? .red : .blue)
    }
}

You can also use a step parameter to provide incremental steps along the path of the slider. For example, if you have a slider with a range of 0 to 100, and you set the step value to 5, the slider's increments would be 0, 5, 10, and so on. The following example shows this approach, and also adds optional minimum and maximum value labels.

@State private var speed = 50.0
@State private var isEditing = false

var body: some View {
    Slider(
        value: $speed,
        in: 0...100,
        step: 5
    ) {
        Text("Speed")
    } minimumValueLabel: {
        Text("0")
    } maximumValueLabel: {
        Text("100")
    } onEditingChanged: { editing in
        isEditing = editing
    }
    Text("\(speed)")
        .foregroundColor(isEditing ? .red : .blue)
}

The slider also uses the step to increase or decrease the value when a VoiceOver user adjusts the slider with voice commands.

From Apple’s SwiftUI documentation. Code samples there are Swift.

Relationships

Conforms to

  • View

See also

More in Controls.