README.md

IQKeyboardManager

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

1. **CODELESS**, Zero Lines 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

GIF animation

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 thought 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 8.0

Demo Project:-

Minimum Xcode Version: Xcode 8.3.2

Installation

Installation with Cocoapod:-

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)

iOS8 and later pod 'IQKeyboardManager'

iOS7 pod 'IQKeyboardManagerSwift', '3.3.7'

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

Swift 3.1 (Xcode 8.0)

pod 'IQKeyboardManagerSwift'

Or

pod 'IQKeyboardManagerSwift', '4.0.10'

Swift 3.1 (Xcode 8.3) pod 'IQKeyboardManagerSwift', '4.0.10'

Swift 3.0(3.0.2) (Xcode 8.2) pod 'IQKeyboardManagerSwift', '4.0.8'

Swift 2.2 or 2.3 (Xcode 7.3) pod 'IQKeyboardManagerSwift', '4.0.5'

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
    }
}

Installation with Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks.

You can install Carthage with Homebrew using the following command:

$ brew update
$ brew install carthage

To integrate IQKeyboardManger or IQKeyboardManagerSwift into your Xcode project using Carthage, specify it in your Cartfile:

github "hackiftekhar/IQKeyboardManager"

Run carthage to build the frameworks and drag the appropriate framework (IQKeyboardManager.framework or IQKeyboardManagerSwift.framework) into your Xcode project according to your need. Make sure to add only one framework and not both.

Installation with Source Code:-

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:-

You can find known issues list here.

Manual Management:-

You can find some manual management tweaks & examples here.

Flow Diagram

If you would like to see detailed Flow diagram then see here.

Properties and functions usage:-

You can find some documentation about properties, methods and their uses here.

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: [email protected]