Icon

IQKeyboardManager

Code Health

Often while developing an app, We ran into an issues where the iPhone keyboard slide up and cover the UITextField/UITextView. IQKeyboardManager allows you to prevent issues of the keyboard sliding up and cover UITextField/UITextView without needing you to enter any code and no additional setup required. To use IQKeyboardManager you simply need to add source files to your project.

Key Features

Issue Stats Issue Stats

1) **CODELESS**, Zero Line Of Code

2) Works Automatically

3) No More UIScrollView

4) No More Subclasses

5) No More Manual Work

6) No More #imports

IQKeyboardManager works on all orientations, and with the toolbar. There are also nice optional features allowing you to customize the distance from the text field, add the next/previous done button as a keyboard UIToolbar, play sounds when the user navigations through the form and more.

Screenshot

IQKeyboardManager Settings

GIF animation

IQKeyboardManager

Video

IQKeyboardManager Demo Video

Warning

  • If you’re planning to build SDK/library/framework and wants to handle UITextField/UITextView with IQKeyboardManager then you’re totally going on wrong way. I would never suggest to add IQKeyboardManager as dependency/adding/shipping with any third-party library, instead of adding IQKeyboardManager you should implement your custom solution to achieve same result. IQKeyboardManager is totally designed for projects to help developers for their convenience, it’s not designed for adding/dependency/shipping with any third-party library, because doing this could block adoption by other developers for their projects as well(who are not using IQKeyboardManager and implemented their custom solution to handle UITextField/UITextView throught the project).
  • If IQKeybaordManager conflicts with other third-party library, then it’s developer responsibility to enable/disable IQKeyboardManager when presenting/dismissing third-party library UI. Third-party libraries are not responsible to handle IQKeyboardManager.

Requirements

IQKeyboardManager:-

Minimum iOS Target: iOS 8.0

Minimum Xcode Version: Xcode 6.0.1

IQKeyboardManagerSwift:-

Minimum iOS Target: iOS 8.0

Minimum Xcode Version: Xcode 7.3

Demo Project:-

Minimum Xcode Version: Xcode 7.3

Installation

Cocoapod Method:-

Note:- 3.3.7 is the last iOS 7 supported version.

IQKeyboardManager (Objective-C):- IQKeyboardManager is available through CocoaPods, to install it simply add the following line to your Podfile: (#9)

pod 'IQKeyboardManager'

IQKeyboardManager (Swift):- IQKeyboardManagerSwift is available through CocoaPods, to install it simply add the following line to your Podfile: (#236)

Swift 2.2 (Xcode 7.3)

pod 'IQKeyboardManagerSwift'

Or

pod 'IQKeyboardManagerSwift', '4.0.2'

Swift 2.1.1 (Xcode 7.2) pod 'IQKeyboardManagerSwift', '4.0.0'

Swift 2.0 (Xcode 7.0) pod 'IQKeyboardManagerSwift', '3.3.3.1'

In AppDelegate.swift, just import IQKeyboardManagerSwift framework and enable IQKeyboardManager.

import IQKeyboardManagerSwift

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?

    func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {

    IQKeyboardManager.sharedManager().enable = true

    return true
    }
}

Source Code Method:-

IQKeyboardManager (Objective-C):- Just drag and drop IQKeyboardManager directory from demo project to your project. That’s it.

IQKeyboardManager (Swift):- Drag and drop IQKeyboardManagerSwift directory from demo project to your project

In AppDelegate.swift, just enable IQKeyboardManager.

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?

    func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {

    IQKeyboardManager.sharedManager().enable = true

    return true
    }
}

Known Issues:-

Known Issue 1

1) Keyboard does not appear in iOS Simulator (#62, #72, #75, #90, #100)

If keyboard does not appear in iOS Simulator and only toolbar is appearing over it (if enableAutoToolbar = YES), then check this setting

Xcode 6:- Goto iOS Simulator->Menu->Hardware->Keyboard->Connect Hardware Keyboard, and deselect that.

Xcode 5 and earlier:- Goto iOS Simulator->Menu->Hardware->Simulate Hardware Keyboard, and deselect that.

2) setEnable = NO doesn’t disable automatic UIToolbar (#117, #136, #147)

If you set [[IQKeyboardManager sharedManager] setEnable:NO] and still automatic toolbar appears on textFields? Probably you haven’t heard about @property enableAutoToolbar.

@property enable : It enable/disable managing distance between keyboard and textField, and doesn’t affect autoToolbar feature.

@property enableAutoToolbar : It enable/disable automatic creation of toolbar, please set enableAutoToolbar to NO if you don’t want to add automatic toolbar.

3) Not working when pinning textfield from TopLayoutguide (#124, #137, #160, #206)

Now IQKeyboardManager can work with topLayoutConstraint and bottomLayoutConstraint with a bit of manual management. Please check below Manual Management->Working with TopLayoutGuide and BottomLayoutGuide section.

4) Toolbar becomes black while popping from a view controller (#374)

This issue happens when there is a textField active on a view controller and you navigate to another view controller without resigning currently active textField. This is an iOS issue and happens even if you don’t integrate library.

image

For a workaround, you can resign currently active textField in viewWillDisappear method.

  -(void)viewWillDisappear:(BOOL)animated
  {
    [super viewWillDisappear:animated];
    [self.view endEditing:YES];
  }

Known Issues (Swift):-

1) Manually enable IQKeyboardManager Swift Version.

From Swift 1.2, compiler no longer allows to override class func load() method, so you need to manually enable IQKeyboardManager using below line of code in AppDelegate.

    IQKeyboardManager.sharedManager().enable = true

Manual Management:-

UINavigationBar:-

If you don’t want to hide the default UINavigationBar of UINavigationController when keyboardManager slides up the view, then just change the UIView class to UIScrollView from the storyboard or xib.(#21, #24)

image

If you are not using storyboard or xib and creating your view programmatically. Then you need to override ’-(void)loadView’ method of UIViewController, and need to set an UIScrollView instance to self.view.

    -(void)loadView
    {
        UIScrollView *scrollView = [[UIScrollView alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
        self.view = scrollView;
    }

Working with TopLayoutGuide and BottomLayoutGuide:-

Technically IQKeyboardManager moves upwards/downwards of currently presentedViewController’s view. So if you’re pinning your UITextfield/UITextView with TopLayoutGuide/BottomLayoutGuide then you’re saying Keep x distance from screen top(I don’t care about where is self.view)’. In this case your view is moved upwards but textField remains at same position and keeping x distance from screen top.

To fix it, just let IQKeyboardManager know the constraint which is pinned with TopLayoutGuide/BottomLayoutGuide, just map TopLayoutGuide/BottomLayoutGuide constraint with IQLayoutGuideConstraint. Here is the screenshot:- image

If your textFields are inside any UIView and your UIView is pinned with TopLayoutGuide/BotomLayoutGuide then also you can map TopLayoutGuide/BottomLayoutGuide constraint with IQLayoutGuideConstraint. here are the screenshots:- image image

Working with Full Screen UITextView:-

Often we have a situation where a full screen UITextView need to show in full screen mode with keyboard handling. To deal with this kind of situation, here is an easy workaround.

Assuming that UITextView needs to be displayed in full screen within a ViewController View and default UINavigationBar of UINavigationController is displaying at at the top of ViewController. Assuming that Adjust Sroll View Insets checkmark is ticked. Add these constraint to UITextView:-

image

  • Top Space to SuperView
  • Leading Space to SuperView
  • Trailing Space to SuperView
  • Bottom Space to Bottom Layout Guide (Important)

    Connect bottom layout guide constraint with IQLayoutGuideConstraint and that’s all. You have a full working UITextViewController.

image

Working with Chat Screen UITableView:-

Often we have another situation where we have to implement our own Chat Style Screen with keyboard handling. To deal with this kind of situation, here is an easy workaround.

Assuming that ChatViewController is subclass of UIViewController not UITableViewController. Assuming that ChatViewController has UITableView at top and UIView at bottom. Bottom UIView contains a UITextField/UITextView with a Send button. Assuming that default UINavigationBar of UINavigationController is displaying at at the top of ChatViewController. Assuming that Adjust Sroll View Insets checkmark is ticked. Add these constraint to UITableView:-

image

  • Top Space to SuperView
  • Leading Space to SuperView
  • Trailing Space to SuperView
  • Bottom Space to bottom UIView

Add thse constraint to bottom UIView

  • Leading Space to SuperView
  • Trailing Space to SuperView
  • Bottom Space to Bottom Layout Guide (Important)

    Connect bottom layout guide constraint with IQLayoutGuideConstraint.

    Map UITextField/UITextView Outlet with a textField object in ChatViewController.

    Add this two line in viewDidLoad

    self.textField.inputAccessoryView = [[UIView alloc] init];  //This will remove toolbar which have done button.
    self.textField.keyboardDistanceFromTextField = 8; //This will modify default distance between textField and keyboard. For exact value, please manually check how far your textField from the bottom of the page. Mine was 8pt.

That’s all. You have a working keyboard handling with ChatViewController.

image

Disable for a ViewController:-

If you would like to disable IQKeyboardManager for a particular ViewController then register ViewController with -(void)disableDistanceHandlingInViewControllerClass:(Class)disabledClass method in AppDelegate.(#117,#139)

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [[IQKeyboardManager sharedManager] disableDistanceHandlingInViewControllerClass:[ViewController class]];
    return YES;
}

Disable toolbar for a ViewController:-

If you would like to disable Auto Toolbar for a particular ViewController then register ViewController with -(void)disableToolbarInViewControllerClass:(Class)disabledClass method in AppDelegate.

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [[IQKeyboardManager sharedManager] disableToolbarInViewControllerClass:[ViewController class]];
    return YES;
}

Considering Previous/Next buttons for textField inside customViews:-

If your textFields are on different customView and do not show previous/next to navigate between textField. Then you should create a SpecialView subclass of UIView, then put all customView inside SpecialView, then register SpecialView class using -(void)considerToolbarPreviousNextInViewClass:(Class)toolbarPreviousNextConsideredClass method in AppDelegate.(#154, #179)

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
    [[IQKeyboardManager sharedManager] considerToolbarPreviousNextInViewClass:[SpecialView class]];
    return YES;
}

Keyboard Return Key Handling:-

If you would like to implement keyboard Return Key as Next/Done button, then you can use IQKeyboardReturnKeyHandler.(#38, #63)

1) Create an instance variable of IQKeyboardReturnKeyHandler and instantiate it in viewDidLoad with ViewController object like this:-

@implementation ViewController
{
    IQKeyboardReturnKeyHandler *returnKeyHandler;
}

- (void)viewDidLoad
{
    [super viewDidLoad];

    returnKeyHandler = [[IQKeyboardReturnKeyHandler alloc] initWithViewController:self];
}

It assign all the responderView delegates to self, and change keybord Return Key to Next key.

2) set instance variable to nil in dealloc method.

-(void)dealloc
{
    returnKeyHandler = nil;
}

UIToolbar(IQToolbar):-

1) If you don’t want to add automatic toolbar over keyboard for a specific textField then you should add a UIView as it’s toolbar like this:-(#89)

textField.inputAccessoryView = [[UIView alloc] init];

2) If you need your own control over the previous/next/done button then you should use the UIView category methods to add toolbar over your textField. The UIView category methods are defined in IQUIView+IQKeyboardToolbar.h file. You can use them like this:-(#40)

-(void)viewDidLoad
{
    [super viewDidLoad];

    //Adding done button for textField1
    [textField1 addDoneOnKeyboardWithTarget:self action:@selector(doneAction:)];

    //Adding previous/next/done button for textField2
    [textField2 addPreviousNextDoneOnKeyboardWithTarget:self previousAction:@selector(previousAction:) nextAction:@selector(nextAction:) doneAction:@selector(doneAction:)];

    //Adding cancel/done button for textField3
    [textField3 addCancelDoneOnKeyboardWithTarget:self cancelAction:@selector(cancelAction:) doneAction:@selector(doneAction:)];
}

/*! previousAction. */
-(void)previousAction:(id)button
{
    //previousAction
}

/*! nextAction. */
-(void)nextAction:(id)button
{
    //nextAction
}

/*! doneAction. */
-(void)doneAction:(UIBarButtonItem*)barButton
{
    //doneAction
}

/*! cancelAction. */
-(void)cancelAction:(UIBarButtonItem*)barButton
{
    //cancelAction
}

Doing custom work on textField with returning NO in textFieldShouldBeginEditing: delegate:-

Generally if developer need to perform some custom task on a particular textField click, then usually developer write their custom code inside textFieldShouldBeginEditing: and returning NO for that textField. But if you are using IQKeyboardManager, then IQKeyboardManager also asks textField to recognize it can become first responder or not using canBecomeFirstResponder in IQUIView+Hierarchy category, and textField asks it’s delegate to respond from textFieldShouldBeginEditing:, so this method is called for each textField everytime when a textField becomeFirstResponder. Unintentionally custom code runs multiple times even when we do not touch the textField to become it as first responder. To overcome this situation please use isAskingCanBecomeFirstResponder BOOL property to check that the delegate is called by IQKeyboardManager or not. (#88)

1) You may need to import IQUIView+Hierarchy category

#import "IQUIView+Hierarchy.h"

2) check for isAskingCanBecomeFirstResponder in textFieldShouldBeginEditing: delegate.

-(BOOL)textFieldShouldBeginEditing:(UITextField *)textField
{
    if (textField == customWorkTextField)
    {
        if (textField.isAskingCanBecomeFirstResponder == NO)
        {
            //Do your work on tapping textField.
            [[[UIAlertView alloc] initWithTitle:@"IQKeyboardManager" message:@"Do your custom work here" delegate:nil cancelButtonTitle:@"OK" otherButtonTitles:nil, nil] show];
        }

        return NO;
    }
    else    return YES;
}

Control Flow Diagram

IQKeyboardManager CFD

Properties and functions usage:-

UIKeyboard handling

+(instancetype)sharedManager : Returns the default singleton instance.

@property BOOL enable : Use this to enable/disable managing distance between keyboard & textField/textView).

@property CGFloat keyboardDistanceFromTextField : Set Distance between keyboard & textField. Can’t be less than zero. Default is 10.

@property BOOL preventShowingBottomBlankSpace : Prevent to show bottom blanck area when keyboard slide up the view. Default is YES. (#93).

IQToolbar handling

@property BOOL enableAutoToolbar : Enable autoToolbar behaviour. If It is set to NO. You have to manually create UIToolbar for keyboard. Default is YES.

@property IQAutoToolbarManageBehaviour toolbarManageBehaviour : Setting toolbar behaviour to IQAutoToolbarBySubviews to manage previous/next according to UITextField’s hierarchy in it’s SuperView. Set it to IQAutoToolbarByTag to manage previous/next according to UITextField’s tag property in increasing order. Default is IQAutoToolbarBySubviews.

@property BOOL shouldToolbarUsesTextFieldTintColor : If YES, then uses textField’s tintColor property for IQToolbar, otherwise tintColor is black. Default is NO. (#27)

@property BOOL shouldShowTextFieldPlaceholder : If YES, then it add the textField’s placeholder text on IQToolbar. Default is YES. (#27)

@property UIFont *placeholderFont : placeholder Font. Default is nil. (#27)

UITextView handling

@property BOOL canAdjustTextView : Giving permission to modify TextView’s frame. Adjust textView’s frame when it is too big in height. Default is NO. (#30)

@property BOOL shouldFixTextViewClip : Adjust textView’s contentInset to fix fix for iOS 7.0.x -(#Stackoverflow). Default is YES.

UIKeyboard Appearance overriding

@property BOOL overrideKeyboardAppearance : Override the keyboardAppearance for all textField/textView. Default is NO.

@property UIKeyboardAppearance keyboardAppearance : If overrideKeyboardAppearance is YES, then all the textField keyboardAppearance is set using this property.

UITextField/UITextView Resign handling

@property BOOL shouldResignOnTouchOutside : Resign textField if touched outside of UITextField/UITextView. (#14)

-(void)resignFirstResponder : Resigns currently first responder field.

UISound handling

@property BOOL shouldPlayInputClicks : If YES, then it plays inputClick sound on next/previous/done click. Default is NO.

UIAnimation handling

@property BOOL shouldAdoptDefaultKeyboardAnimation : If YES, then uses keyboard default animation curve style to move view, otherwise uses UIViewAnimationOptionCurveEaseOut animation style. Default is YES.

Feature:-

1) Support Device Orientation.

2) Enable/Disable Keyboard Manager when needed with enable boolean.

3) Easiest integration.

4) AutoHandle UIToolbar as a accessoryInputView of textField/textView with enableAutoToolbar boolean.

5) AutoHandle UIToolbar can be manged by superview’s hierarchy or can be managed by tag property of textField/textView using toolbarManageBehaviour enum.

6) UIView Category for easily adding Next/Previous and Done button as Keyboard UIToolBar, even automatic with enableAutoToolbar boolean.

7) Enable/Disable Next/Previous buttons with Category methods, even automatic with enableAutoToolbar boolean.

8) Set keyboard distance from textFields using keyboardDistanceFromTextField.

9) Resign keyboard on touching outside using shouldResignOnTouchOutside.

10) Manage UITextView’s frame when it’s hight is too large to fit on screen with canAdjustTextView boolean.

11) Can manage UITextField/UITextView inside UITableView/UIScrollView.

12) Can play input sound on Next/Previous/Done click.

LICENSE

Distributed under the MIT License.

Contributions

Any contribution is more than welcome! You can contribute through pull requests and issues on GitHub.

Author

If you wish to contact me, email at: hack.iftekhar@gmail.com

Bitdeli Badge