Loading...

How to add a character limit to a TextField in SwiftUI?

question swiftui swift
Ram Patra Published on September 13, 2024

To add a character length limit to a TextField in SwiftUI, you can use a combination of Swift’s .onChange, .onPasteCommand modifier, and string manipulation to limit the number of characters the user can enter.

The .onPasteCommand modifier in SwiftUI allows you to handle content pasted into a TextField directly. You can use this modifier to intercept and manage the pasted content before it actually gets added to the TextField. This way, you can enforce the character limit when the user pastes text.

Here’s how to use .onChange and .onPasteCommand to limit the pasted text:

import SwiftUI

struct ContentView: View {
    @State private var text: String = ""
    let characterLimit = 20 // Set your desired character limit
    
    var body: some View {
        VStack {
            TextField("Insert text here...", text: $text)
                .padding()
                .background(Color.white)
                .cornerRadius(10)
                .shadow(radius: 3)
                .padding(.horizontal)
                .onChange(of: text) { newValue in
                    // Enforce character limit while typing
                    if newValue.count > characterLimit {
                        text = String(newValue.prefix(characterLimit))
                    }
                }
                .onPasteCommand(of: [.plainText]) { items in
                    // Handle paste event and enforce character limit
                    if let pastedText = items.first?.string {
                        let newText = text + pastedText
                        if newText.count > characterLimit {
                            // Limit the pasted content to fit within the character limit
                            text = String(newText.prefix(characterLimit))
                        } else {
                            text = newText
                        }
                    }
                }
            
            Text("\(text.count)/\(characterLimit) characters") // Optional: Shows character count
                .font(.footnote)
                .foregroundColor(text.count > characterLimit ? .red : .gray)
                .padding(.top, 5)
        }
        .padding()
    }
}

struct ContentView_Previews: PreviewProvider {
    static var previews: some View {
        ContentView()
    }
}

Explanation:

  1. .onPasteCommand(of: [.plainText]):
    • This modifier intercepts the paste command. It ensures that only plain text is handled when pasting into the TextField.
    • Inside this block, you can access the pasted content and modify it before it’s added to the TextField.
  2. Handle the pasted content:
    • When the user pastes text, it gets appended to the current value of text.
    • The pasted content is checked against the character limit, and if the combined length (existing + pasted) exceeds the limit, the text is truncated to fit within the limit.
  3. Fallback to onChange for typing:
    • The onChange modifier still ensures the limit is enforced while typing.

This approach ensures that you can handle pasting specifically while still enforcing the character limit. The user won’t be able to exceed the specified character limit when pasting long text nor when typing.

Presentify

Take your presentation to the next level.

FaceScreen

Put your face and name on your screen.

ToDoBar

Your to-dos on your menu bar.

Ram Patra Published on September 13, 2024
Image placeholder

Keep reading

If this article was helpful, others might be too

question swiftui macos September 3, 2024 How to open and close windows programmatically in SwiftUI?

To open or close a window programmatically from outside that window using environment variables, you need to leverage the new openWindow (macOS 13+) and dismissWindow (macOS 14+) environment variables. This environment variables allow you to programmatically open and close a window by its identifier.

question swiftui swift August 31, 2024 @StateObject vs @ObservedObject in SwiftUI

In SwiftUI, both @StateObject and @ObservedObject are property wrappers used to manage state in your views, specifically when working with objects that conform to the ObservableObject protocol. However, they serve slightly different purposes and have different use cases. Here’s a breakdown:

question swiftui swift October 30, 2023 How to convert Color type to hex and vice-versa while retaining alpha information?

The below should work both on macOS and iOS with one minor change. That is, use UIColor instead of NSColor if you’re planning to use it for iOS.