How to handle "Done" return key press event in rxSwift?

Question

While exploring RxSwift

I found just textField.rx_text.asObservable() property, that fires event every keyboard button is hit.

But how do we handle "search" or "done" button press events? I'd like to fire search only after these actions, not "search as you type".

score 46 · Accepted Answer · answered Oct 25 '15 at 02:40

46

You can subscribe to UIControlEvents like this:

textField.rx_controlEvents(.EditingDidEndOnExit).subscribeNext { print("return pressed") }

answered Oct 25 '15 at 02:40

louoso

Is it possible to wrap it as an observable? – alex Oct 25 '15 at 08:46
Yes, try this: `textField.rx_controlEvents(.EditingDidEndOnExit).asObservable()` – louoso Oct 26 '15 at 02:19
2

most important question is how to NOT dismiss keyboard on subscribing to this controlEvent – Adam Smaka Apr 30 '17 at 16:22
This actually creates contradiction when you want to resign keyboard if tap outside of textfield. Both the scenario ends up observed and creates unexpected behaviour. – Dinesh Raja Oct 30 '17 at 11:58

d.felber · Answer 2 · 2020-09-10T18:45:06.037

23

In RxSwift 4 and 5:

textField.rx.controlEvent([.editingDidEndOnExit]).subscribe { _ in
    print("editingDidEndOnExit")
}.disposed(by: disposeBag)

edited Sep 10 '20 at 18:45

answered Feb 09 '18 at 11:03

d.felber

1

No need to add brackets around `.editingDidEndOnExit` – Borzh Oct 25 '19 at 22:07
What `print(text)` suppose to print, initially I thought it would be the text from the text field but when I tried it prints out empty bracket () – koira Sep 10 '20 at 12:57
@koira good point. "text" should have been named "event". but it does not contain valuable information so I removed it to prohibit confusion. – d.felber Sep 10 '20 at 18:48

score 6 · Answer 3 · answered May 18 '17 at 12:41

6

In Rxswift 3.0

textField.rx.controlEvent([.editingDidEndOnExit])
         .subscribe(onNext:{text in
            print(text)
         }).addDisposableTo(disposeBag)

answered May 18 '17 at 12:41

Chirag Desai

4

`.disposed(by: disposeBag)` ** `addDisposableTo` is on the way to deprecation. – Shai Mishali May 18 '17 at 21:29

3 Answers3