NEW: My new book Pro SwiftUI is out now – level up your SwiftUI skills today! >>

How to allow row selection in a list

Paul Hudson    @twostraws   

Updated for Xcode 14.2

SwiftUI’s lists support both single and multiple selection of its items, but only when your list is in editing mode.

To support single selection, first add an optional property of the same type you’re using inside your list. For example, if you were using a list of integers you would have an optional Int. Once you have that, pass it to your list using its selection parameter, then make sure your list is in editing mode.

As an example, this code shows an array of strings in a list, and stores the selected item as an optional string:

struct ContentView: View {
    @State private var selection: String?

    let names = [
        "Cyril",
        "Lana",
        "Mallory",
        "Sterling"
    ]

    var body: some View {
        NavigationStack {
            List(names, id: \.self, selection: $selection) { name in
                Text(name)
            }
            .navigationTitle("List Selection")
            .toolbar {
                EditButton()
            }
        }
    }
}

Download this as an Xcode project

Notice that edit button in the toolbar – remember, your list must be in editing mode to support selection.

If you want multiple selection, all you need to do is change your selection property into a Set of the same type as your list array. So, if we wanted multiple selection in the previous example we’d use this:

@State private var selection = Set<String>()

Tip: Both the single and multiple selection options can be changed by you programmatically, allowing you to change which rows were selected by modifying the state yourself.

Hacking with Swift is sponsored by Essential Developer

SPONSORED From March 20th to 26th, you can join a FREE crash course for mid/senior iOS devs who want to achieve an expert level of technical and practical skills – it’s the fast track to being a complete senior developer!

Click to save your free spot now

Sponsor Hacking with Swift and reach the world's largest Swift community!

Similar solutions…

BUY OUR BOOKS
Buy Pro Swift Buy Pro SwiftUI Buy Swift Design Patterns Buy Testing Swift Buy Hacking with iOS Buy Swift Coding Challenges Buy Swift on Sundays Volume One Buy Server-Side Swift Buy Advanced iOS Volume One Buy Advanced iOS Volume Two Buy Advanced iOS Volume Three Buy Hacking with watchOS Buy Hacking with tvOS Buy Hacking with macOS Buy Dive Into SpriteKit Buy Swift in Sixty Seconds Buy Objective-C for Swift Developers Buy Beyond Code

Was this page useful? Let us know!

Average rating: 3.9/5

 
Unknown user

You are not logged in

Log in or create account
 

Link copied to your pasteboard.