How to format a TextField for numbers

About 3 min

How to format a TextField for numbers 관련

SwiftUI by Example

Back to Home

How to format a TextField for numbers | SwiftUI by Example

How to format a TextField for numbers

Updated for Xcode 15

You can attach a formatter to SwiftUI's TextField in order to restrict what kind of data it can contain, but honestly it's a bit limited in what it can do.

To demonstrate the functionality – and also its limitations – we could write some code to let the user enter a score in a game, and show what they entered. Here's the code:

struct ContentView: View {
    @State private var score = 0

    var body: some View {
        VStack {
            TextField("Enter your score", value: $score, format: .number)
                .textFieldStyle(.roundedBorder)
                .padding()

            Text("Your score was \(score).")
        }
    }
}

Download this as an Xcode project

A text field showing 123, with a label below saying “Your score was 123.”

Important

If you're using Xcode 12 you need to use RoundedBorderTextFieldStyle() rather than .roundedBorder, and also create a custom number formatter, like this:

struct ContentView: View {
    @State private var score = 0

    let formatter: NumberFormatter = {
        let formatter = NumberFormatter()
        formatter.numberStyle = .decimal
        return formatter
    }()

    var body: some View {
        VStack {
            TextField("Enter your score", value: $score, formatter: formatter)
                .textFieldStyle(RoundedBorderTextFieldStyle())
                .padding()

            Text("Your score was \(score).")
        }
    }
}

Download this as an Xcode project

Regardless of which code option you choose, if you try using it you'll notice a few things:

The “Your score was” text view updates only when the user presses Return.
The user is free to enter any kind of text that they want, and it only jumps back to being a number when they press Return.
Before validation, they can even enter invalid numbers, such as 12.34.56.

If you're happy with that – if you're happy that the text field allows any input, and only validates its numbers and updates its state when the user presses Return – then you're good to go.

However, if you want to try to fix some those you'll soon hit more problems. For example, you might try to attach the .keyboardType(.decimalPad) modifier to your text field in order to restrict it to numbers and decimal point only. However, now:

The user can still enter multiple decimal points before validation happens.
By default, the decimal pad keyboard has no Return key to hide the keyboard; you'll need to add one yourself.

I wish there were a nice workaround for this, but I'm afraid there is not – not without rolling your own wrapper around UITextField, that is. In the meantime, you either accept the shortcomings of the existing functionality, or use an alternative input mechanism such as Stepper.