I have been looking all over for this but I can't seem to find it. I know how to dismiss the keyboard using Objective-C
but I have no idea how to do that using Swift
? Does anyone know?
-
9How are you doing it in Objective-C? It's normally a conversion from one syntax to the other, and rarely a matter of different methods/conventions.– Craig OtisCommented Jun 9, 2014 at 18:39
-
You might want to check this answer.– Ahmad FCommented Dec 7, 2016 at 1:34
44 Answers
override func viewDidLoad() {
super.viewDidLoad()
//Looks for single or multiple taps.
let tap = UITapGestureRecognizer(target: self, action: #selector(UIInputViewController.dismissKeyboard))
//Uncomment the line below if you want the tap not not interfere and cancel other interactions.
//tap.cancelsTouchesInView = false
view.addGestureRecognizer(tap)
}
//Calls this function when the tap is recognized.
@objc func dismissKeyboard() {
//Causes the view (or one of its embedded text fields) to resign the first responder status.
view.endEditing(true)
}
Here is another way to do this task if you are going to use this functionality in multiple UIViewControllers
:
// Put this piece of code anywhere you like
extension UIViewController {
func hideKeyboardWhenTappedAround() {
let tap = UITapGestureRecognizer(target: self, action: #selector(UIViewController.dismissKeyboard))
tap.cancelsTouchesInView = false
view.addGestureRecognizer(tap)
}
@objc func dismissKeyboard() {
view.endEditing(true)
}
}
Now in every UIViewController
, all you have to do is call this function:
override func viewDidLoad() {
super.viewDidLoad()
self.hideKeyboardWhenTappedAround()
}
This function is included as a standard function in my repo which contains a lot of useful Swift Extensions like this one, check it out: https://github.com/goktugyil/EZSwiftExtensions
-
20Since Swift 2 in the first answer, replace this line-> let tap: UITapGestureRecognizer = UITapGestureRecognizer(target: self, action: #selector(MyViewController.dismissKeyboard)) Commented Mar 29, 2016 at 3:56
-
6it breaks tableviewcell's segue on a tableviewcontroller Commented Apr 1, 2016 at 10:39
-
13This is one of the most helpful extensions I have ever come across! Thank you! The only caution I would extend is that this can interfere with
didSelectRowAtIndexPath
. Commented Apr 5, 2016 at 6:46 -
58Just discovered this question and implemented that method. That thing with "didSelectRow" of tableView/UICollectionView not calling literally drove me crazy. The solution is: Simply add this to your extension:
tap.cancelsTouchesInView = false
. That solved it for me at least. Hope this helps somebody Commented Jul 28, 2016 at 10:27 -
4there's a problem with this answer, I have a button in the view I wanna perform this action in, when the keyboard is up and I click on the button, the keyboard will disappear but I won't get the complete button action, some weird behavior Commented Apr 28, 2019 at 12:40
An answer to your question on how to dismiss the keyboard in Xcode 6.1 using Swift below:
import UIKit
class ItemViewController: UIViewController, UITextFieldDelegate {
@IBOutlet var textFieldItemName: UITextField!
@IBOutlet var textFieldQt: UITextField!
@IBOutlet var textFieldMoreInfo: UITextField!
override func viewDidLoad() {
super.viewDidLoad()
textFieldItemName.delegate = self
textFieldQt.delegate = self
textFieldMoreInfo.delegate = self
}
...
/**
* Called when 'return' key pressed. return NO to ignore.
*/
func textFieldShouldReturn(textField: UITextField) -> Bool {
textField.resignFirstResponder()
return true
}
/**
* Called when the user click on the view (outside the UITextField).
*/
override func touchesBegan(touches: Set<UITouch>, withEvent event: UIEvent?) {
self.view.endEditing(true)
}
}
-
7Great piece of code, thanks! touchesBegan was exactly what I was looking for :) Commented Jul 1, 2015 at 22:42
-
4This didn't quite work for me. If I tap on the view controller's view it works. If I tap on a control item in the view, the keyboard doesn't dismiss. Commented Apr 9, 2016 at 18:58
-
This is the best solution I have seen so far. Small note: in newer Swift the override signature changed a bit. You need to add _ before touches: override func touchesBegan(_ touches: Set<UITouch>, withEvent event: UIEvent?) Commented Dec 12, 2018 at 19:57
-
1This one should probably be marked as correct one. The current accepted answer makes every button in the view not responsive when keyboard is showing. Commented Mar 7, 2019 at 13:37
-
This doesn't work when tapping inside a tableview or any scrollable. Commented Jun 10, 2019 at 15:40
Swift 4 working
Create extension as below & call hideKeyboardWhenTappedAround()
in your Base view controller.
//
// UIViewController+Extension.swift
// Project Name
//
// Created by ABC on 2/3/18.
// Copyright © 2018 ABC. All rights reserved.
//
import UIKit
extension UIViewController {
func hideKeyboardWhenTappedAround() {
let tapGesture = UITapGestureRecognizer(target: self,
action: #selector(hideKeyboard))
view.addGestureRecognizer(tapGesture)
}
@objc func hideKeyboard() {
view.endEditing(true)
}
}
Most important thing to call in your Base View Controller so that no need to call all time in all view controllers.
You can call
resignFirstResponder()
on any instance of a UIResponder, such as a UITextField. If you call it on the view that is currently causing the keyboard to be displayed then the keyboard will dismiss.
-
6In a situation where you don't exactly know the first responder, resignFirstResponder() can lead to a heap of trouble. Esq's answer below (using view.doneEditing()) is a lot more appropriate– shiserCommented Jun 1, 2015 at 0:16
-
1Whenever I use resignFirstResponder on my textField the app crashes. I tried everything I could think of, and looked around the web for a fix. Nothing helps me. Would you happen to know why that happens?– AugustoQCommented Sep 23, 2015 at 23:57
-
1As shiser said this is not the best solution. plus it doesn't work in all situations.– Alok CCommented Dec 11, 2018 at 19:35
swift 5 just two lines is enough. Add into your viewDidLoad
should work.
let tapGesture = UITapGestureRecognizer(target: view, action: #selector(UIView.endEditing))
view.addGestureRecognizer(tapGesture)
If your tap gesture blocked some other touches, then add this line:
tapGesture.cancelsTouchesInView = false
for Swift 3 it is very simple
override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
self.view.endEditing(true)
}
if you want to hide keyboard on pressing RETURN key
func textFieldShouldReturn(_ textField: UITextField) -> Bool {
textField.resignFirstResponder()
return true
}
but in second case you will also need to pass delegate from all textFields to the ViewController in the Main.Storyboard
-
I get
unrecognized selector sent to instance
with this code.– Haring10Commented Dec 29, 2016 at 6:45
//Simple exercise to demonstrate, assuming the view controller has a //Textfield, Button and a Label. And that the label should display the //userinputs when button clicked. And if you want the keyboard to disappear //when clicken anywhere on the screen + upon clicking Return key in the //keyboard. Dont forget to add "UITextFieldDelegate" and
//"self.userInput.delegate = self" as below
import UIKit
class ViewController: UIViewController,UITextFieldDelegate {
@IBOutlet weak var userInput: UITextField!
@IBAction func transferBtn(sender: AnyObject) {
display.text = userInput.text
}
@IBOutlet weak var display: UILabel!
override func viewDidLoad() {
super.viewDidLoad()
//This is important for the textFieldShouldReturn function, conforming to textfieldDelegate and setting it to self
self.userInput.delegate = self
}
override func didReceiveMemoryWarning() {
super.didReceiveMemoryWarning()
// Dispose of any resources that can be recreated.
}
//This is for the keyboard to GO AWAYY !! when user clicks anywhere on the view
override func touchesBegan(touches: Set<UITouch>, withEvent event: UIEvent?) {
self.view.endEditing(true)
}
//This is for the keyboard to GO AWAYY !! when user clicks "Return" key on the keyboard
func textFieldShouldReturn(textField: UITextField) -> Bool {
textField.resignFirstResponder()
return true
}
}
To expand on Esqarrouth's answer, I always use the following to dismiss the keyboard, especially if the class from which I am dismissing the keyboard does not have a view
property and/or is not a subclass of UIView
.
UIApplication.shared.keyWindow?.endEditing(true)
Or, for convenience,
UIApplication.endEditing(true)
with the following extension to the UIApplication
class:
extension UIApplication {
/// Dismisses the keyboard from the key window of the
/// shared application instance.
///
/// - Parameters:
/// - force: specify `true` to force first responder to resign.
open class func endEditing(_ force: Bool = false) {
shared.endEditing(force)
}
/// Dismisses the keyboard from the key window of this
/// application instance.
///
/// - Parameters:
/// - force: specify `true` to force first responder to resign.
open func endEditing(_ force: Bool = false) {
keyWindow?.endEditing(force)
}
}
Swift 3: Easiest way to dismiss keyboard:
//Dismiss keyboard method
func keyboardDismiss() {
textField.resignFirstResponder()
}
//ADD Gesture Recignizer to Dismiss keyboard then view tapped
@IBAction func viewTapped(_ sender: AnyObject) {
keyboardDismiss()
}
//Dismiss keyboard using Return Key (Done) Button
//Do not forgot to add protocol UITextFieldDelegate
func textFieldShouldReturn(_ textField: UITextField) -> Bool {
keyboardDismiss()
return true
}
-
1I'm fairly sure that the view.endEditing(true) call is simpler in that it doesn't require you to store a variable or assume you only have one text field. Commented Nov 22, 2016 at 16:19
In swift you can use
override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
super.touchesBegan(touches, with: event)
view.endEditing(true)
}
Just one line of code in viewDidLoad()
method:
view.addGestureRecognizer(UITapGestureRecognizer(target: view, action: #selector(UIView.endEditing(_:))))
-
Thanks, that does the trick. But as someone who started app development on Android and then also started developing apps for iOS I'm always astounded that this is not the default behaviour, because unlike on Android, there is no way for the user to dismiss the keyboard otherwise and app is effectively locked up!– Anthony.Commented May 6, 2022 at 7:19
Dash's answer is correct and preferred. A more "scorched earth" approach is to call view.endEditing(true)
. This causes view
and all its subviews to resignFirstResponder
. If you don't have a reference to the view you'd like to dismiss, this is a hacky but effective solution.
Note that personally I think you should have a reference to the view you'd like to have resign first responder.
.endEditing(force: Bool)
is a barbaric approach; please don't use it.
I found the best solution included the accepted answer from @Esqarrouth, with some adjustments:
extension UIViewController {
func hideKeyboardWhenTappedAround() {
let tap: UITapGestureRecognizer = UITapGestureRecognizer(target: self, action: "dismissKeyboardView")
tap.cancelsTouchesInView = false
view.addGestureRecognizer(tap)
}
func dismissKeyboardView() {
view.endEditing(true)
}
}
The line tap.cancelsTouchesInView = false
was critical: it ensures that the UITapGestureRecognizer
does not prevent other elements on the view from receiving user interaction.
The method dismissKeyboard()
was changed to the slightly less elegant dismissKeyboardView()
. This is because in my project's fairly old codebase, there were numerous times where dismissKeyboard()
was already used (I imagine this is not uncommon), causing compiler issues.
Then, as above, this behaviour can be enabled in individual View Controllers:
override func viewDidLoad() {
super.viewDidLoad()
self.hideKeyboardWhenTappedAround()
}
I have use IQKeyBoardManagerSwift for keyboard. it is easy to use. just Add pod 'IQKeyboardManagerSwift'
Import IQKeyboardManagerSwift and write code on didFinishLaunchingWithOptions
in AppDelegate
.
///add this line
IQKeyboardManager.shared.shouldResignOnTouchOutside = true
IQKeyboardManager.shared.enable = true
In storyboard:
- select the TableView
- from the the right-hand-side, select the attribute inspector
- in the keyboard section - select the dismiss mode you want
-
can't find that item, where is it and what does it look like? I'm in the attribute inspector of a textField Commented Aug 11, 2016 at 17:33
-
Swift 3:
Extension with Selector
as parameter to be able to do additional stuff in the dismiss function and cancelsTouchesInView
to prevent distortion with touches on other elements of the view.
extension UIViewController {
func hideKeyboardOnTap(_ selector: Selector) {
let tap: UITapGestureRecognizer = UITapGestureRecognizer(target: self, action: selector)
tap.cancelsTouchesInView = false
view.addGestureRecognizer(tap)
}
}
Usage:
override func viewDidLoad() {
super.viewDidLoad()
self.hideKeyboardOnTap(#selector(self.dismissKeyboard))
}
func dismissKeyboard() {
view.endEditing(true)
// do aditional stuff
}
Add this extension to your ViewController :
extension UIViewController {
// Ends editing view when touches to view
open override func touchesBegan(_ touches: Set<UITouch>, with event: UIEvent?) {
super.touchesBegan(touches, with: event)
self.view.endEditing(true)
}
}
Use IQKeyboardmanager that will help you solve easy.....
/////////////////////////////////////////
![ how to disable the keyboard..][1]
import UIKit
class ViewController: UIViewController,UITextFieldDelegate {
@IBOutlet weak var username: UITextField!
@IBOutlet weak var password: UITextField!
override func viewDidLoad() {
super.viewDidLoad()
username.delegate = self
password.delegate = self
// Do any additional setup after loading the view, typically from a nib.
}
override func didReceiveMemoryWarning() {
super.didReceiveMemoryWarning()
// Dispose of any resources that can be recreated.
}
func textFieldShouldReturn(textField: UITextField!) -> Bool // called when 'return' key pressed. return NO to ignore.
{
textField.resignFirstResponder()
return true;
}
override func touchesBegan(_: Set<UITouch>, with: UIEvent?) {
username.resignFirstResponder()
password.resignFirstResponder()
self.view.endEditing(true)
}
}
If you use a scroll view, It could be much simpler.
Just select Dismiss interactively
in storyboard.
In Swift 4, add @objc:
In the viewDidLoad:
let tap: UITapGestureRecognizer = UITapGestureRecognizer(target: self, action: #selector(self.dismissKeyboard))
view.addGestureRecognizer(tap)
Function:
@objc func dismissKeyboard() {
view.endEditing(true)
}
import UIKit
class ItemViewController: UIViewController, UITextFieldDelegate {
@IBOutlet weak var nameTextField: UITextField!
override func viewDidLoad() {
super.viewDidLoad()
self.nameTextField.delegate = self
}
// Called when 'return' key pressed. return NO to ignore.
func textFieldShouldReturn(textField: UITextField) -> Bool {
textField.resignFirstResponder()
return true
}
// Called when the user click on the view (outside the UITextField).
override func touchesBegan(touches: Set<UITouch>, withEvent event: UIEvent?) {
self.view.endEditing(true)
}
}
As a novice programmer it can be confusing when people produce more skilled and unnecessary responses...You do not have to do any of the complicated stuff shown above!...
Here is the simplest option...In the case your keyboard appears in response to the textfield - Inside your touch screen function just add the resignFirstResponder function. As shown below - the keyboard will close because the First Responder is released (exiting the Responder chain)...
override func touchesBegan(_: Set<UITouch>, with: UIEvent?){
MyTextField.resignFirstResponder()
}
This one liner resigns Keyboard from all(any) the UITextField in a UIView
self.view.endEditing(true)
Posting as a new answer since my edit of @King-Wizard's answer was rejected.
Make your class a delegate of the UITextField and override touchesBegan.
Swift 4
import UIKit
class ViewController: UIViewController, UITextFieldDelegate {
@IBOutlet var textField: UITextField!
override func viewDidLoad() {
super.viewDidLoad()
textField.delegate = self
}
//Called when 'return' key is pressed. Return false to keep the keyboard visible.
func textFieldShouldReturn(textField: UITextField) -> Bool {
return true
}
// Called when the user clicks on the view (outside of UITextField).
override func touchesBegan(touches: Set<UITouch>, with event: UIEvent?) {
self.view.endEditing(true)
}
}
how to dismiss keyboard when you click anywhere to close it
//Setup dismiss keyboard gesture
let tap = UITapGestureRecognizer(target: self, action: #selector(UIInputViewController.dismissKeyboard))
view.addGestureRecognizer(tap)
}
//Calling this function when the tapped
@objc func dismissKeyboard() {
view.endEditing(true)
}
For Swift3
Register an event recogniser in viewDidLoad
let tap = UITapGestureRecognizer(target: self, action: #selector(hideKeyBoard))
then we need to add the gesture into the view in same viewDidLoad.
self.view.addGestureRecognizer(tap)
Then we need to initialise the registered method
func hideKeyBoard(sender: UITapGestureRecognizer? = nil){
view.endEditing(true)
}
Here is how to dismiss the keyboard by tapping anywhere else, in 2 lines using Swift 5.
(I hate to add another answer, but since this is the top result on Google I will to help rookies like me.)
In your ViewController.swift, find the viewDidLoad()
function.
Add these 2 lines:
let tap: UIGestureRecognizer = UITapGestureRecognizer(target: self.view, action: #selector(UIView.endEditing))
view.addGestureRecognizer(tap)
You can also add a tap gesture recognizer to resign the keyboard. :D
override func viewDidLoad() {
super.viewDidLoad()
// Do any additional setup after loading the view, typically from a nib.
let recognizer = UITapGestureRecognizer(target: self, action: Selector("handleTap:"))
backgroundView.addGestureRecognizer(recognizer)
}
func handleTap(recognizer: UITapGestureRecognizer) {
textField.resignFirstResponder()
textFieldtwo.resignFirstResponder()
textFieldthree.resignFirstResponder()
println("tappped")
}
Another possibility is to simply add a big button with no content that lies underneath all views you might need to touch. Give it an action named:
@IBAction func dismissKeyboardButton(sender: AnyObject) {
view.endEditing(true)
}
The problem with a gesture recognizer was for me, that it also caught all touches I wanted to receive by the tableViewCells.
If you have other views that should receive the touch as well you have to set
cancelsTouchesInView = false
Like this:
let elsewhereTap = UITapGestureRecognizer(target: self, action: #selector(dismissKeyboard))
elsewhereTap.cancelsTouchesInView = false
self.view.addGestureRecognizer(elsewhereTap)