Как я могу использовать Combine для отслеживания изменений UITextField в классе UIViewRepresentable? - PullRequest
1 голос
/ 18 октября 2019

Я создал собственное текстовое поле и хотел бы воспользоваться Combine. Чтобы получать уведомления при каждом изменении текста в моем текстовом поле, я в настоящее время использую пользовательский модификатор. Это работает хорошо, но я хочу, чтобы этот код мог внутри моей структуры CustomTextField.

Моя структура CustomTextField соответствует UIViewRepresentable. Внутри этой структуры есть класс NSObject с именем Coordinator, и он соответствует UITextFieldDelegate.

Я уже использую другие методы делегата UITextField, но не могу найти тот, который делает именно то, что я уже делаю с моим пользовательским модификатором. Некоторые методы близки, но не совсем так, как я хочу. В любом случае, я считаю, что было бы лучше поместить этот новый пользовательский метод textFieldDidChange в класс Coordinator.

Вот мой пользовательский модификатор

private let textFieldDidChange = NotificationCenter.default
    .publisher(for: UITextField.textDidChangeNotification)
    .map { $0.object as! UITextField}


struct CustomModifer: ViewModifier {

     func body(content: Content) -> some View {
         content
             .tag(1)
             .onReceive(textFieldDidChange) { data in

                //do something

             }
    }
}

Мой CustomTextField используется в представлении SwiftUI, к которому прикреплен мой пользовательский модификатор. Я могу делать вещи, когда есть изменения в текстовом поле. Модификатор также использует Combine. Это прекрасно работает, но я не хочу, чтобы эта функциональность была в форме модификатора. Я хочу использовать его в своем классе Coordinator вместе с моими методами UITextFieldDelegate.

Это мой CustomTextField

struct CustomTextField: UIViewRepresentable {

    var isFirstResponder: Bool = false
    @EnvironmentObject var authenticationViewModel: AuthenticationViewModel

    func makeCoordinator() -> Coordinator {
        return Coordinator(authenticationViewModel: self._authenticationViewModel)
    }

    class Coordinator: NSObject, UITextFieldDelegate {

        var didBecomeFirstResponder = false
        @EnvironmentObject var authenticationViewModel: AuthenticationViewModel

        init(authenticationViewModel: EnvironmentObject<AuthenticationViewModel>)
        {
            self._authenticationViewModel = authenticationViewModel
        }

        // Limit the amount of characters that can be typed in the field
        func textField(_ textField: UITextField, shouldChangeCharactersIn range: NSRange, replacementString string: String) -> Bool {

            let currentText = textField.text ?? ""
            guard let stringRange = Range(range, in: currentText) else { return false }
            let updatedText = currentText.replacingCharacters(in: stringRange, with: string)
            return updatedText.count <= 14
        }

        /* I want to put my textFieldDidChange method right here */

        /* * * * * * * * * * * * * * * * * * * * * * * * * * * * */


        func textFieldDidEndEditing(_ textField: UITextField) {

            textField.resignFirstResponder()
            textField.endEditing(true)
        }

    }

    func makeUIView(context: Context) -> UITextField {

        let textField = UITextField()
        textField.delegate = context.coordinator
        textField.placeholder = context.coordinator.authenticationViewModel.placeholder
        textField.font = .systemFont(ofSize: 33, weight: .bold)
        textField.keyboardType = .numberPad

        return textField
    }

    func updateUIView(_ uiView: UITextField, context: Context) {

        let textField = uiView
        textField.text = self.authenticationViewModel.text
    }
}

struct CustomTextField_Previews: PreviewProvider {

    static var previews: some View {
        CustomTextField()
            .previewLayout(.fixed(width: 270, height: 55))
            .previewDisplayName("Custom Textfield")
            .previewDevice(.none)
    }
}

Я смотрел видео о Combine иЯ хотел бы начать использовать его в новом приложении, которое я создаю. Я действительно думаю, что это правильно использовать в этой ситуации, но все еще не совсем уверен, как это осуществить. Я был бы очень признателен за пример.

Подводя итог:

Я хочу добавить функцию с именем textFieldDidChange в мой класс Coordinator, и она должна запускаться каждый раз, когда тамэто изменение моего текстового поля. Он должен использовать Combine.

Заранее спасибо

Ответы [ 2 ]

1 голос
/ 18 октября 2019

Обновленный ответ

Просмотрев ваш обновленный вопрос, я понял, что мой оригинальный ответ может использовать некоторую очистку. Я свел модель и координатора в один класс, который, хотя и работал для моего примера, не всегда выполним или желателен. Если модель и координатор не могут быть одинаковыми, вы не можете полагаться на метод didSet свойства модели для обновления textField. Поэтому вместо этого я использую издателя Combine, который мы бесплатно получаем, используя переменную @Published внутри нашей модели.

Ключевые вещи, которые нам нужно сделать:

  1. Создайте единый источник правды, поддерживая синхронизацию model.text и textField.text

    1. Используйте издателя, предоставляемого оболочкой свойства @Published, для обновления textField.text приmodel.text изменения

    2. Используйте метод .addTarget(:action:for) для textField, чтобы обновить model.text, когда textfield.text изменится

  2. Выполнить замыкание под названием textDidChange, когда наша модель изменится.

(я предпочитаю использовать .addTarget для # 1.2, а не проходить через NotificationCenter, так как он меньше кода, сработал сразу, и это хорошо известно пользователям UIKit).

Вот обновленный пример, демонстрирующий эту работу:

Демо

import SwiftUI
import Combine

// Example view showing that `model.text` and `textField.text`
//     stay in sync with one another
struct CustomTextFieldDemo: View {
    @ObservedObject var model = Model()

    var body: some View {
        VStack {
            // The model's text can be used as a property
            Text("The text is \"\(model.text)\"")
            // or as a binding,
            TextField(model.placeholder, text: $model.text)
                .disableAutocorrection(true)
                .padding()
                .border(Color.black)
            // or the model itself can be passed to a CustomTextField
            CustomTextField().environmentObject(model)
                .padding()
                .border(Color.black)
        }
        .frame(height: 100)
        .padding()
    }
}

Модель

class Model: ObservableObject {
    @Published var text = ""
    var placeholder = "Placeholder"
}

Просмотр

struct CustomTextField: UIViewRepresentable {
    @EnvironmentObject var model: Model

    func makeCoordinator() -> CustomTextField.Coordinator {
        Coordinator(model: model)
    }

    func makeUIView(context: UIViewRepresentableContext<CustomTextField>) -> UITextField {
        let textField = UITextField()

        // Set the coordinator as the textField's delegate
        textField.delegate = context.coordinator

        // Set up textField's properties
        textField.text = context.coordinator.model.text
        textField.placeholder = context.coordinator.model.placeholder
        textField.autocorrectionType = .no

        // Update model.text when textField.text is changed
        textField.addTarget(context.coordinator,
                            action: #selector(context.coordinator.textFieldDidChange),
                            for: .editingChanged)

        // Update textField.text when model.text is changed
        // The map step is there because .assign(to:on:) complains
        //     if you try to assign a String to textField.text, which is a String?
        // Note that assigning textField.text with .assign(to:on:)
        //     does NOT trigger a UITextField.Event.editingChanged
        let sub = context.coordinator.model.$text.receive(on: RunLoop.main)
                         .map { Optional($0) }
                         .assign(to: \UITextField.text, on: textField)
        context.coordinator.subscribers.append(sub)

        // Become first responder
        textField.becomeFirstResponder()

        return textField
    }

    func updateUIView(_ textField: UITextField, context: UIViewRepresentableContext<CustomTextField>) {
        // If something needs to happen when the view updates
    }
}

Просмотр. Координатор

extension CustomTextField {
    class Coordinator: NSObject, UITextFieldDelegate, ObservableObject {
        @ObservedObject var model: Model
        var subscribers: [AnyCancellable] = []

        // Make subscriber which runs textDidChange closure whenever model.text changes
        init(model: Model) {
            self.model = model
            let sub = model.$text.receive(on: RunLoop.main).sink(receiveValue: textDidChange)
            subscribers.append(sub)
        }

        // Cancel subscribers when Coordinator is deinitialized
        deinit {
            for sub in subscribers {
                sub.cancel()
            }
        }

        // Any code that needs to be run when model.text changes
        var textDidChange: (String) -> Void = { text in
            print("Text changed to \"\(text)\"")
            // * * * * * * * * * * //
            // Put your code here  //
            // * * * * * * * * * * //
        }

        // Update model.text when textField.text is changed
        @objc func textFieldDidChange(_ textField: UITextField) {
            model.text = textField.text ?? ""
        }

        // Example UITextFieldDelegate method
        func textFieldShouldReturn(_ textField: UITextField) -> Bool {
            textField.resignFirstResponder()
            return true
        }
    }
}

Оригинальный ответ

Похоже, у вас есть несколько целей:

  1. Использованиеa UITextField, чтобы вы могли использовать такие функции, как .becomeFirstResponder()
  2. Выполнить действие при изменении текста
  3. Уведомить другие представления SwiftUI об изменении текста

Я думаю, что вы можете удовлетворить все эти требования, используя один класс модели и структуру UIViewRepresentable. Причина, по которой я структурировал код таким образом, заключается в том, что у вас есть один источник правды (model.text), который можно использовать взаимозаменяемо с другими представлениями SwiftUI, которые принимают String или Binding<String>.

Модель

class MyTextFieldModel: NSObject, UITextFieldDelegate, ObservableObject {
    // Must be weak, so that we don't have a strong reference cycle
    weak var textField: UITextField?

    // The @Published property wrapper just makes a Combine Publisher for the text
    @Published var text: String = "" {
        // If the model's text property changes, update the UITextField
        didSet {
            textField?.text = text
        }
    }

    // If the UITextField's text property changes, update the model
    @objc func textFieldDidChange() {
        text = textField?.text ?? ""

        // Put your code that needs to run on text change here
        print("Text changed to \"\(text)\"")
    }

    // Example UITextFieldDelegate method
    func textFieldShouldReturn(_ textField: UITextField) -> Bool {
        textField.resignFirstResponder()
        return true
    }
}

Вид

struct MyTextField: UIViewRepresentable {
    @ObservedObject var model: MyTextFieldModel

    func makeUIView(context: UIViewRepresentableContext<MyTextField>) -> UITextField {
        let textField = UITextField()

        // Give the model a reference to textField
        model.textField = textField

        // Set the model as the textField's delegate
        textField.delegate = model

        // TextField setup
        textField.text = model.text
        textField.placeholder = "Type in this UITextField"

        // Call the model's textFieldDidChange() method on change
        textField.addTarget(model, action: #selector(model.textFieldDidChange), for: .editingChanged)

        // Become first responder
        textField.becomeFirstResponder()

        return textField
    }

    func updateUIView(_ textField: UITextField, context: UIViewRepresentableContext<MyTextField>) {
        // If something needs to happen when the view updates
    }
}

Если вам не нужен № 3 выше, вы можете заменить

@ObservedObject var model: MyTextFieldModel

на

@ObservedObject private var model = MyTextFieldModel()

Demo

Вот демонстрационный вид, показывающий всю эту работу

struct MyTextFieldDemo: View {
    @ObservedObject var model = MyTextFieldModel()

    var body: some View {
        VStack {
            // The model's text can be used as a property
            Text("The text is \"\(model.text)\"")
            // or as a binding,
            TextField("Type in this TextField", text: $model.text)
                .padding()
                .border(Color.black)
            // but the model itself should only be used for one wrapped UITextField
            MyTextField(model: model)
                .padding()
                .border(Color.black)
        }
        .frame(height: 100)
        // Any view can subscribe to the model's text publisher
        .onReceive(model.$text) { text in
                print("I received the text \"\(text)\"")
        }

    }
}
0 голосов
/ 18 октября 2019

Я немного запутался в том, что вы спрашиваете, потому что вы говорите о UITextField и SwiftUI.

Как насчет чего-то подобного? Вместо этого он не использует UITextField, вместо этого он использует TextField объект SwiftUI.

Этот класс будет уведомлять вас о любых изменениях TextField в вашем ContentView.

class CustomModifier: ObservableObject {
    var observedValue: String = "" {
        willSet(observedValue) {
            print(observedValue)
        }
    }
}

Убедитесь, что вы используете @ObservedObject в своем классе модификатора, и вы сможете увидеть изменения.

struct ContentView: View {
    @ObservedObject var modifier = CustomModifier()

    var body: some View {
        TextField("Input:", text: $modifier.observedValue)
    }
}

Если это не соответствует вашим запросам, то могу предложитьСледующая статья, которая может помочь?

https://medium.com/@valv0/textfield-and-uiviewrepresentable-46a8d3ec48e2

...