benjaminsage/itextfield

Fully-wrapped UITextField made to work entirely in SwiftUI

iTextField ⌨️

A fully-wrapped `UITextField` that works entirely in SwiftUI. 🦅

Get Started | Examples | Customize | Install |

Get Started

1. Install iTextField
2. Add iTextField to your project

import SwiftUI
import iTextField

struct ContentView: View {
    @State var text: String = ""

    var body: some View {
        iTextField("Placeholder", text: $text)
    }
}

3. Customize your iTextfield

Examples

Starter

Customize your text field with built-in modifiers.

import SwiftUI
import iTextField

struct ContentView: View {
    @State var text: String = ""

    var body: some View {
        iTextField("Placeholder", text: $text)
            .accentColor(.purple)
            .fontFromUIFont(UIFont(name: "Avenir", size: 40))
            .keyboardType(.URL)
            .returnKeyType(.done)
            .disableAutocorrection(true)
            .autocapitalization(.none)
            .padding()
    }
}

Jump text fields

Use the optional isEditing binding parameter to programmatically jump between text fields.

import SwiftUI
import iTextField

struct ContentView: View {
    @State var text1: String = ""
    @State var text2: String = ""
    @State var isSecondEditing: String = ""

    var body: some View {
        iTextField("First", text: $text1)
            .onReturn { isSecondEditing = true }
        iTextField("Second", text: $text2,
                   isEditing: $isSecondEditing)
    }
}

Customize

iTextField has two required parameters: 1️⃣ a placeholder and 2️⃣ a text state. You can optionally pass in a 3️⃣rd an isEditing binding if you would like to programmatically focus or unfocus the text field.

iTextField also supports a variety of modifiers.

Example: Change the foreground color, accent color, and text alignment with the following code block:

iTextField("Placeholder", text: $text, isEditing: $isEditing)
    .foregroundColor(.purple)
    .accentColor(.green)
    .multilineTextAlignment(.leading)

Use this exhaustive input list to customize your text field.

Modifier	Description
.fontFromUIFont(_ font: UIFont?)	Modifies the text field’s font from a UIFont object. 🔠
.foregroundColor(_ color: Color?)	Modifies the text color 🎨 of the text field.
.accentColor(_ accentColor: Color?)	Modifies the cursor color 🌈 of the text field
.multilineTextAlignment(_ alignment: TextAlignment)	Modifies the text alignment of a text field. ↔️
.textContentType(_ textContentType: UITextContentType?)	Modifies the content type of a text field. 📧 ☎️
.disableAutocorrection(_ disable: Bool?)	Modifies the text field’s autocorrection settings.
.keyboardType(_ type: UIKeyboardType)	Modifies the text field’s keyboard type. 📩
.autocapitalization(_ style: UITextAutocapitalizationType)	Modifies the text field’s autocapitalization style. 🔡
.returnKeyType(_ type: UIReturnKeyType)	Modifies the text field’s return key type. ✅
.characterLimit(_ limit: Int?)	Sets the maximum amount of characters allowed in this text field.
.isSecure(_ isSecure: Bool)	Modifies the text field’s secure entry settings. 🔒
.clearsOnBeginEditing(_ shouldClear: Bool)	Modifies the clear-on-begin-editing setting of a text field. ❌
clearsOnInsertion(_ shouldClear: Bool)	Modifies the clear-on-insertion setting of a text field. 👆
.showsClearButton(_ showsButton: Bool)	Modifies whether and when the text field clear button appears on the view. ⭕️ ❌
.passwordRules(_ rules: UITextInputPasswordRules)	Modifies the text field's password rules 🔒. Sets secure entry to true.
.spellChecking(_ spellChecking: Bool? = nil)	Modifies whether the text field should check the user's spelling.
.smartDashes(_ smartDashes: Bool? = nil)	Modifies whether the text field includes smart dashes.
.smartInsertDelete(_ smartInsertDelete: Bool? = nil)	Modifies whether the text field uses smart insert-delete.
.smartQuotes(_ smartQuotes: Bool? = nil)	Modifies whether the text field uses smart quotes.
.disabled(disabled: Bool)	Modifies whether the text field is disabled. ✋
.onEditingBegan(perform action: { code })	Modifies the function called when text editing begins. ▶️
.onEdit(perform action: { code })	Modifies the function called when the user makes any changes to the text in the text field. 💬
.onEditingEnded(perform action: { code })	Modifies the function called when text editing ends. 🔚
.onReturn(perform action: { code })	Modifies the function called when the user presses the return key. ⬇️ ➡️
.onClear(perform action: { code })	Modifies the function called when the user clears the text field. ❌

Install

Use the Swift package manager to install. Find instructions here😀

Help

As always, if you have any questions about iPhoneNumberField, we are available 24/7 to help.

	Reach us at
📞	[phone]	Call
📧	[email protected]	Email
📲	[phone]	Text

itextfield's Issues

Change license to MIT?

Hi,

first of all, thank you very much for this great library. It is very useful for everyone who is using SwiftUI but need more customisation for TextField

But the GPL license is very quite restricted. People would need to open source the whole app when they use this library inside their app.

Is it a possibility to change the license to a more commercial friendly one, such as MIT?

Thank you in any case.

Changing the value of isSecure doesn't update UI

I believe this is because all the modifier values aren't being set in the updateView method of the UIViewRepresentable

AttributeGraph: cycle detected through attribute 234608

When I have an iTextField that's first responder it creates attribute warnings. I added a Symbolic breakpoint with symbol print_cycle. It seems that Xcode doesn't like changing first responder they way its done below.

public struct iTextField: UIViewRepresentable {
...
public func updateView {
...
if isEditing.wrappedValue {
    textField.becomeFirstResponder() // <- Causes the warning
} else {
    textField.resignFirstResponder()
}

}}

Force unwrapping issue on Xcode 12.5

In Xcode Version 12.5 (12E262) force unwrapping after nil check is considered as an error.

In iTextField+ViewModifiers.swift

iTextField Review

Again overall things are strong. It's like I'm reviewing a Ferrari. Sure I might want to change the paint job a bit, maybe swap the wheels, but the engine – the most important part – fucking roars.

1. Unsure of the placeholder needs to be required. Had difficulty removing it for that use case. Probably want to toss that guy as an optional.

2. clearsOnBeginEditing is a little unclear. I thought this meant that if I add a default value it will clear that value when I start to edit the text field. That wasn't what happened. Actually still unclear what this does. Whatever it is let's just rename it. Another quick fix.

3. Same border & font comment as on iPhoneNumberTextField

4. Click out to remove keyboard. I know this isn't trivial but I think that'd be an awesome feature to include. Click off the screen to remove the keyboard. Unsure how else to remove keyboard now. Not sure what to click.

Placeholder color

Would be useful to be able to change color of placeholder text

Couldn't type after jumping to next textfield

Hi,

I just tried the tutorial code, but I found after I jump to the second textField, I couldn't type. Could anyone fix this? Thank you!