iOS - Dismiss keyboard when touching outside of UITextField

Question

I m wondering how to make the keyboard disappear when the user touches outside of a UITextField

User · Accepted Answer

You ll need to add an UITapGestureRecogniser and assign it to the view  and then call resign first responder on the UITextField on it s selector   The code   In viewDidLoad  UITapGestureRecognizer  tap     UITapGestureRecognizer alloc  initWithTarget self action  selector dismissKeyboard      self view addGestureRecognizer tap     In dismissKeyboard   - void dismissKeyboard         aTextField resignFirstResponder        Where aTextField is the textfield that is responsible for the keyboard   Swift 3 version looks like that  let tapGesture   UITapGestureRecognizer target  self  action   selector self dismissKeyboard        self view addGestureRecognizer tapGesture    For dismissKeyboard   objc func dismissKeyboard    sender  UITapGestureRecognizer        aTextField resignFirstResponder

User · Answer

There is one thing to important    adding gesture recognize to view can subview override it   So only one action is performed   If you want to perform recognize multiple action through superview and subview    You have to  use  tap cancelsTouchesInView   false  Full code is below   let tap   UITapGestureRecognizer target  self  action   selector self superViewClicked           tap numberOfTapsRequired   1         tap delegate   self         tap cancelsTouchesInView   false         self view addGestureRecognizer tap         objc func superViewClicked                     self searchTF resignFirstResponder           What is best solution for dissmis soft keyboard on outside click   I will  explain for one condition  Think about it   You have UISearchBar on the top  then tableview with header added  Solution is simple   track soft keyboard is open or dismiss Add gesture recognize to header view implement delegate of table view didSelectRowAt  Full code     var isSoftKeyboardActive   false      override func viewDidLoad                       var tap   UITapGestureRecognizer target  self  action   selector self tableHeaderClick               tap numberOfTapsRequired   1             tap delegate   self             tap cancelsTouchesInView   false             self headerOfTableView addGestureRecognizer tap                            override func viewWillAppear   animated  Bool                      super viewWillAppear animated                   NotificationCenter default addObserver self  selector   selector keyboardWillDisappear   name  UIResponder keyboardWillHideNotification  object  nil                    NotificationCenter default addObserver self  selector   selector keyboardWillAppear   name  UIResponder keyboardWillShowNotification  object  nil                                               override func viewWillDisappear   animated  Bool                      super viewWillDisappear animated                    NotificationCenter default removeObserver self                                 func tableView   tableView  UITableView  didSelectRowAt indexPath  IndexPath              if isSoftKeyboardActive    true                                 self searchTF resignFirstResponder               else                             selectedRow   indexPath row                performSegue withIdentifier   quot segueWebview quot   sender  self                                                   objc func tableHeaderClick                      self searchTF resignFirstResponder                                 objc func keyboardWillAppear                       isSoftKeyboardActive   true             objc func keyboardWillDisappear                      isSoftKeyboardActive   false                   How is it work   If soft keyboard is open and user click header soft keyboard close If soft keyboard is open and user click cell  keyboard close and no perform cell click

User · Answer

How about this  I know this is an old post  It might help someone     -  void touchesEnded  NSSet   touches withEvent  UIEvent   event         NSArray  subviews    self view subviews       for  id objects in subviews            if   objects isKindOfClass  UITextField class                  UITextField  theTextField   objects              if   objects isFirstResponder                      theTextField resignFirstResponder

User · Answer

I think the easiest  and best  way to do this is to subclass your global view and use hitTest withEvent method to listen to any touch  Touches on keyboard aren t registered  so hitTest withEvent is only called when you touch scroll swipe pinch    somewhere else  then call  self endEditing YES    This is better than using touchesBegan because touchesBegan are not called if you click on a button on top of the view  It is better than UITapGestureRecognizer which can t recognize a scrolling gesture for example  It is also better than using a dim screen because in a complexe and dynamic user interface  you can t put dim screen everywhere  Moreover  it doesn t block other actions  you don t need to tap twice to select a button outside  like in the case of a UIPopover    Also  it s better than calling  textField resignFirstResponder   because you may have many text fields on screen  so this works for all of them

User · Answer

-  void viewDidLoad        super viewDidLoad     UITapGestureRecognizer  singleTapGestureRecognizer     UITapGestureRecognizer alloc                                                            initWithTarget self                                                           action  selector handleSingleTap          singleTapGestureRecognizer setNumberOfTapsRequired 1        singleTapGestureRecognizer requireGestureRecognizerToFail singleTapGestureRecognizer         self view addGestureRecognizer singleTapGestureRecognizer      -  void handleSingleTap  UITapGestureRecognizer   recognizer        self view endEditing YES        textField resignFirstResponder        scrollView setContentOffset CGPointMake 0  -40  animated YES

User · Answer

override func touchesBegan touches  Set lt NSObject gt   withEvent event  UIEvent        super view endEditing true      super touchesBegan touches  withEvent  event

User · Answer

In viewDidLoad swift 4 2 The code like this  let viewTap  UITapGestureRecognizer   UITapGestureRecognizer target  self  action  selector dismissKeyboard           view addGestureRecognizer viewTap   objc func dismissKeyboard             view endEditing true

User · Answer

I tried many of the responses here and had no luck   My tap gesture recognizer was always causing my UIButtons to not respond when tapped  even when I set the cancelsTouchesInView property of the gesture recognizer to NO   This is what eventually solved the issue   Have an ivar   UITapGestureRecognizer   keyboardDismissGestureRecognizer    When a text field begins editing  set the gesture recognizer   -  void  textFieldDidBeginEditing  UITextField   textField       if  keyboardDismissGestureRecognizer    nil                 keyboardDismissGestureRecognizer      UITapGestureRecognizer alloc                                         initWithTarget self                                        action  selector dismissKeyboard   autorelease            keyboardDismissGestureRecognizer cancelsTouchesInView   NO            self view addGestureRecognizer  keyboardDismissGestureRecognizer             Then the trick is in how you set up the dismissKeyboard method   -  void  dismissKeyboard        self performSelector  selector dismissKeyboardSelector  withObject nil afterDelay 0 01      -  void  dismissKeyboardSelector        self view endEditing YES         self view removeGestureRecognizer  keyboardDismissGestureRecognizer        keyboardDismissGestureRecognizer   nil      I guess there s just something about getting the dismissKeyboardSelector execution out of the touch handling execution stack

User · Answer

Swift 4  Setup your UIViewController with this extension method once e g in viewDidLoad   override func viewDidLoad         super viewDidLoad       self setupHideKeyboardOnTap       and the keyboard will be dismissed even by tapping on the NavigationBar   import UIKit extension UIViewController           Call this once to dismiss open keyboards by tapping anywhere in the view controller     func setupHideKeyboardOnTap             self view addGestureRecognizer self endEditingRecognizer            self navigationController  navigationBar addGestureRecognizer self endEditingRecognizer                   Dismisses the keyboard from self view     private func endEditingRecognizer   - gt  UIGestureRecognizer           let tap   UITapGestureRecognizer target  self view  action   selector self view endEditing               tap cancelsTouchesInView   false         return tap

User · Answer

This works  In this example  aTextField is the only UITextField     If there are others or UITextViews  there s a tiny bit more to do      YourViewController h         interface YourViewController   UIViewController    some subclass of UIViewController     lt UITextFieldDelegate gt      lt -- add this protocol         end     YourViewController m   interface YourViewController     property  nonatomic  strong  readonly  UITapGestureRecognizer  singleTapRecognizer   end          implementation  synthesize singleTapRecognizer    singleTapRecognizer          -  void viewDidLoad        super viewDidLoad          your other init code here      self view addGestureRecognizer self singleTapRecognizer       -  UITapGestureRecognizer   singleTapRecognizer       if  nil     singleTapRecognizer             singleTapRecognizer     UITapGestureRecognizer alloc  initWithTarget self action  selector singleTapToDismissKeyboard              singleTapRecognizer cancelsTouchesInView   NO     absolutely required  otherwise  tap  eats events            return  singleTapRecognizer        Something inside this VC s view was tapped  except the navbar toolbar  -  void singleTapToDismissKeyboard  UITapGestureRecognizer   sender       NSLog   singleTap         self hideKeyboard sender         When the  Return  key is pressed on the on-screen keyboard  hide the keyboard     for protocol UITextFieldDelegate -  BOOL textFieldShouldReturn  UITextField  textField       NSLog   Return pressed         self hideKeyboard textField       return YES     -  IBAction hideKeyboard  id sender          Just call resignFirstResponder on all UITextFields and UITextViews in this VC        Why  Because it works and checking which one was last active gets messy       aTextField resignFirstResponder       NSLog   keyboard hidden

User · Answer

One of the most easiest and shortest way is to add this code to your viewDidLoad   self view addGestureRecognizer   UITapGestureRecognizer alloc                                       initWithTarget self view                                      action  selector endEditing

User · Answer

In swift 5 You can use following code to dismiss keyboard  outside textfield  override func viewDidLoad                code      let tapGesture   UITapGestureRecognizer target  self  action   selector self dismissKeyboard           self view addGestureRecognizer tapGesture        objc func dismissKeyboard   sender  UITapGestureRecognizer        self view endEditing true

User · Answer

Add this code in your ViewController m file    - void touchesBegan  NSSet   touches withEvent  UIEvent   event        self view endEditing YES

User · Answer

This is a good generic solution   Objective-C   -  void touchesBegan  NSSet   touches withEvent  UIEvent   event        self view endEditing YES           Swift   override func touchesBegan touches  NSSet  withEvent event  UIEvent        self view endEditing true      Based on  icodebuster solution  https   stackoverflow com a 18756253 417652

User · Answer

For those struggling with this in Swift  This is the accepted answer by Jensen2k but in Swift   Swift 2 3      override func viewDidLoad                              let viewTapGestureRec   UITapGestureRecognizer target  self  action   selector handleViewTap                 this line is important         viewTapGestureRec cancelsTouchesInView   false         self view addGestureRecognizer viewTapGestureRec                               func handleViewTap recognizer  UIGestureRecognizer            myTextField resignFirstResponder

User · Answer

Just to add to the list here my version of how to dismiss a keyboard on outside touch   viewDidLoad   UITapGestureRecognizer  singleTap     UITapGestureRecognizer alloc  initWithTarget self action  selector handleSingleTap      self view addGestureRecognizer singleTap     Anywhere   - void handleSingleTap  UITapGestureRecognizer   sender       textFieldName resignFirstResponder       puts  Dismissed the keyboard

User · Answer

You can do this using the Storyboard in XCode 6 and above     Create the action to hide the keyboard  Add this to the header file of the class used by your ViewController    interface TimeDelayViewController   UIViewController  lt UITextFieldDelegate gt   -  IBAction dissmissKeyboardOnTap  id sender    end   Then add this to the implementation file of the same ViewController   -  IBAction dissmissKeyboardOnTap  id sender        self view endEditing YES       This will now be one of the  Received Actions  for your storyboard scene  i e  ViewController        Hook up the action to the user event  Now you need to hook up this action to the user gesture of touching off the keyboard   Important - You need to convert the  UIView  that s contained in your storyboard to a UIControl  so it can receive events  Select the view from your View Controller Scene hierarchy        and change its class     Now drag from the small circle next to the  received action  for your scene  onto an  empty  part of your scene  actually you re dragging the  Received Action  to the UIControl   You ll be shown a selection of events that you can hook up your action to     Select the  touch up inside  option  You ve now hooked the IBAction you created to a user action of touching off the keyboard  When the user taps off the keyboard  it will now be hidden    NOTE  To hook the action to the event  you can also drag from the received action directly onto the UIControl in your View Controllers hierarchy  It s displayed as  Control  in the hierarchy

User · Answer

Set text fields delegate in view did load   override func viewDidLoad        super viewDidLoad     self userText delegate   self    Add this Function   func textFieldShouldReturn userText  UITextField   - gt  Bool     userText resignFirstResponder    return true

User · Answer

Check this  this would be the easiest way to do that   - void touchesBegan  NSSet   touches withEvent  UIEvent   event         self view endEditing YES     this will do the trick     Or  This library will handle including scrollbar auto scrolling  tap space to hide the keyboard  etc     https   github com michaeltyson TPKeyboardAvoiding

User · Answer

So I just had to solve this very problem  and none of the previous answers worked for me out of the box  My situation  a UISearchBar  plus a number of other controls on the screen  I want for a tap outside of the search bar to dismiss the keyboard  but not propagate to any of the other controls  When the keyboard is hidden  I want all the controls to work   What I did   1  Implement a custom touch handler in my view controller   override func touchesBegan touches  Set lt UITouch gt   withEvent event  UIEvent         if searchBar isFirstResponder                    This causes the first responder  whoever it is  to resign first responder  and hide the keyboard             We also  eat  the touch here and not allow it to propagate further          view endEditing true            else                  OK to propagate the touch         super touchesBegan touches  withEvent  event            2  Added a couple of delegate methods  mine are for the UISearchBar  but there are similar ones for UITextField   controlContainerView in the code below is a UIView that has a bunch of buttons in it  Remember that setting userInteractionEnabled on a superview disables all its subviews    func searchBarTextDidBeginEditing searchBar  UISearchBar          controlContainerView userInteractionEnabled   false      someButton userInteractionEnabled   false      func searchBarTextDidEndEditing searchBar  UISearchBar          searchBar resignFirstResponder           Done editing  enable the other controls again       controlContainerView userInteractionEnabled   false     someButton userInteractionEnabled   false

User · Answer

override func touchesBegan touches  Set lt UITouch gt   withEvent event  UIEvent          if let touch   touches first       view endEditing true

User · Answer

Swift version  this works in combination with other elements  like a UIButton or another UITextField    override func viewDidLoad         super viewDidLoad        let tapper   UITapGestureRecognizer target  self  action  selector endEditing       tapper cancelsTouchesInView   false     view addGestureRecognizer tapper

User · Answer

Plenty of great answers here about using UITapGestureRecognizer--all of which break UITextField s clear  X  button  The solution is to suppress the gesture recognizer via its delegate   -  BOOL gestureRecognizer  UIGestureRecognizer   gestureRecognizer shouldReceiveTouch  UITouch   touch       BOOL touchViewIsButton    touch view isKindOfClass  UIButton class        BOOL touchSuperviewIsTextField     touch view superview  isKindOfClass  UITextField class        return   touchViewIsButton  amp  amp  touchSuperviewIsTextField       It s not the most robust solution but it works for me

User · Answer

This must be the easiest way to hide your keyboard by touching outside    -  void touchesBegan  NSSet   touches withEvent  UIEvent   event        self view endEditing YES            from How to dismiss keyboard when user tap other area outside textfield

User · Answer

Swift 4 oneliner  view addGestureRecognizer UITapGestureRecognizer target  view  action   selector UIView endEditing

User · Answer

In this case  there can be use ScrollView and added to TextField in ScrollView and I want Tap the ScrollView and View then Dismiss the Keyboard  I tried to create sample code just in case  Like this   import UIKit  class ViewController  UIViewController         IBOutlet weak var scrollView  UIScrollView       IBOutlet weak var textField  UITextField       override func viewDidLoad             super viewDidLoad            let tapGesture   UITapGestureRecognizer target  self  action   selector ViewController tap               view addGestureRecognizer tapGesture             Do any additional setup after loading the view  typically from a nib            func tap gesture  UITapGestureRecognizer            textField resignFirstResponder             override func didReceiveMemoryWarning             super didReceiveMemoryWarning              Dispose of any resources that can be recreated            Your Storyboard Look at that Just Like

User · Answer

For collection view     the keyboard follows the dragging touch off screen  and may be pulled upward again to cancel the dismiss collectionView keyboardDismissMode    interactive    dismisses the keyboard when a drag begins collectionView keyboardDismissMode    onDrag

User · Answer

I mashed up a few answers   Use an ivar that gets initialized during viewDidLoad   UIGestureRecognizer  tapper   -  void viewDidLoad        super viewDidLoad       tapper     UITapGestureRecognizer alloc                  initWithTarget self action  selector handleSingleTap         tapper cancelsTouchesInView   NO       self view addGestureRecognizer tapper       Dismiss what ever is currently editing   -  void handleSingleTap  UITapGestureRecognizer    sender        self view endEditing YES

User · Answer

You can use UITapGestureRecongnizer method for dismissing keyboard  by clicking outside of UITextField  By using this method whenever user will click outside of UITextField then keyboard will get dismiss  Below is the code snippet for using it    UITapGestureRecognizer  tap     UITapGestureRecognizer alloc                                     initWithTarget self                                    action  selector dismissk          self view addGestureRecognizer tap       Method -  void  dismissk        abctextfield resignFirstResponder        deftextfield resignFirstResponder

User · Answer

I see that some people are having issues using the UITapGestureRecognizer method  The easiest way that I ve accomplished this functionality while still leaving my existing button s tap behavior intact is adding only one line to  Jensen2k  s answer    tap setCancelsTouchesInView NO     This allowed my existing buttons to still work without using  Dmitry Sitnikov  s method    Read about that property here  search for CancelsTouchesInView   UIGestureRecognizer Class Reference  I m not sure how it would work with scrollbars  as I see some had issues with  but hopefully someone else might run into the same scenario I had

User · Answer

If the view is embedded at all in a UIScrollView then you can use the following   tableView keyboardDismissMode   UIScrollViewKeyboardDismissModeOnDrag  tableView keyboardDismissMode   UIScrollViewKeyboardDismissModeInteractive    The former will animate the keyboard off screen when the table view is scrolled and the later will hide the keyboard like the stock Messages app      Note that these are are available on iOS 7 0 or above

User · Answer

Swift version of  Jensen2k s answer   let gestureRecognizer   UITapGestureRecognizer   UITapGestureRecognizer init target  self  action   dismissKeyboard   self view addGestureRecognizer gestureRecognizer   func dismissKeyboard         aTextField resignFirstResponder       One liner  self view addTapGesture UITapGestureRecognizer init target  self  action   endEditing

User · Answer

just use this code in your  m file it will resign the textfield when user tap outside of the textfield     - void touchesBegan  NSSet   touches withEvent  UIEvent   event     textfield resignFirstResponder

User · Answer

I used Barry example for my new development  It worked great  but i had to include a slightly change  required to dismiss the keyboard only for the textfield being edited   So  I added to Barry example the following   -  void  textFieldDidBeginEditing  UITextField   textField        textBeingEdited   textField    - void  textFieldDidEndEditing  UITextField   textField        textBeingEdited   nil      Also  I changed hideKeyboard method as follows   -  IBAction hideKeyboard  id sender          Just call resignFirstResponder on all UITextFields and UITextViews in this VC        Why  Because it works and checking which one was last active gets messy        UITextField   tf    UITextField    sender        textBeingEdited resignFirstResponder

User · Answer

Send message resignFirstResponder to the textfiled that put it there  Please see this post for more information

User · Answer

You can create category for the UiView and override the touchesBegan meathod as follows   It is working fine for me And it is centralize solution for this problem    import  UIView Keyboard h   implementation UIView Keyboard   -  void touchesBegan  NSSet   touches withEvent  UIEvent   event        self window endEditing true        super touchesBegan touches withEvent event      end

User · Answer

It is better to make your UIView an instance of UIControl  in interface builder  and then connect their TouchUpInside event to dismissKeyboard method  This IBAction method will look like   -  IBAction dismissKeyboard  id sender        aTextBox resignFirstResponder

User · Answer

If I got you right you want to resign keyboard wile tapping on outSide of textfield but you don t have reference of your textfield   Try this    Take global textField  lets call it reftextField Now in textFieldDidBeginEditing set referenced text field to   -  void  textFieldDidBeginEditing  UITextField   textField      reftextField   textField     Now you can happily use on any button clock   adding a transparent button on begin editing recomended   -  void dismissKeyboard          reftextField resignFirstResponder      Or for resigning done button try this     for resigning on done button     -  BOOL  textFieldShouldReturn  UITextField   textField       textField resignFirstResponder       return YES

[ios] iOS - Dismiss keyboard when touching outside of UITextField

Examples related to ios

Examples related to cocoa-touch

Examples related to uitextfield

Examples related to uikit