How to take action when the user submits a TextField

Paul Hudson @twostraws June 8th 2021

Updated for Xcode 13.0

New in iOS 15

SwiftUI has an onSubmit() modifier that can be attached to any view in your hierarchy, and will run a function of your choose when the user has finished entering text into a TextField or SecureField.

For example, we could ask the user to enter their password, then run some code when they press return:

struct ContentView: View {
    @State private var password = ""

    var body: some View {
        SecureField("Password", text: $password)
            .onSubmit {
                print("Authenticating…")
            }
    }
}

Download this as an Xcode project

For simple examples like that, both TextField and SecureField accept a dedicated onCommit parameter where we can attach our function directly to them. However, the advantage to using onSubmit() is that it captures all text values submitted in its context, which makes completing forms easier:

struct ContentView: View {
    @State private var username = ""
    @State private var password = ""

    var body: some View {
        Form {
            TextField("Username", text: $username)
            SecureField("Password", text: $password)
        }
        .onSubmit {
            guard username.isEmpty == false && password.isEmpty == false else { return }
            print("Authenticating…")
        }
    }
}

Download this as an Xcode project

How to take action when the user submits a TextField

Similar solutions…