Home

Awesome

<p align="center"> <img src="https://raw.githubusercontent.com/hackiftekhar/IQKeyboardManager/master/Demo/Resources/icon.png" alt="Icon"/> </p> <H1 align="center">IQKeyboardManager</H1> <p align="center"> <img src="https://img.shields.io/github/license/hackiftekhar/IQKeyboardManager.svg" alt="GitHub license"/>

Build Status

While developing iOS apps, we often run into issues where the iPhone keyboard slides up and covers the UITextField/UITextView. IQKeyboardManager allows you to prevent this issue of keyboard sliding up and covering UITextField/UITextView without needing you to write any code or make any additional setup. 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. It also has nice optional features allowing you to customize the distance from the text field, behaviour of previous, next and done buttons in the keyboard toolbar, play sound when the user navigates through the form and more.

Screenshot

Screenshot 1 Screenshot 2 Screenshot 3 Screenshot 4 Screenshot 5

GIF animation

IQKeyboardManager

Video

<a href="http://youtu.be/WAYc2Qj-OQg" target="_blank"><img src="http://img.youtube.com/vi/WAYc2Qj-OQg/0.jpg" alt="IQKeyboardManager Demo Video" width="480" height="360" border="10" /></a>

Tutorial video by @rebeloper (#1135)

@rebeloper demonstrated two videos on how to implement IQKeyboardManager at it's core:

<a href="https://www.youtube.com/playlist?list=PL_csAAO9PQ8aTL87XnueOXi3RpWE2m_8v" target="_blank"><img src="https://raw.githubusercontent.com/hackiftekhar/IQKeyboardManager/master/Screenshot/ThirdPartyYoutubeTutorial.jpg" alt="Youtube Tutorial Playlist"/></a>

https://www.youtube.com/playlist?list=PL_csAAO9PQ8aTL87XnueOXi3RpWE2m_8v

Warning

Requirements

Platform iOS

LanguageMinimum iOS TargetMinimum Xcode Version
IQKeyboardManagerObj-CiOS 11.0Xcode 13
IQKeyboardManagerSwiftSwiftiOS 13.0Xcode 13
Demo ProjectXcode 15

Swift versions support

SwiftXcodeIQKeyboardManagerSwift
5.9, 5.8, 5.7, 5.615>= 7.0.0
5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.211>= 6.5.7
5.1, 5.0, 4.2, 4.0, 3.2, 3.011>= 6.5.0
5.0,4.2, 4.0, 3.2, 3.010.2>= 6.2.1
4.2, 4.0, 3.2, 3.010.0>= 6.0.4
4.0, 3.2, 3.09.05.0.0

7.0.0 version notes

Installation

Installation with CocoaPods

CocoaPods

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

pod 'IQKeyboardManager' #iOS13 and later

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

Swift 5.9, 5.8, 5.7, 5.6, 5.5 (Xcode 15)

pod 'IQKeyboardManagerSwift'

Or you can choose the version you need based on Swift support table from Requirements

pod 'IQKeyboardManagerSwift', '6.3.0'

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: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

      IQKeyboardManager.shared.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, add the following line to 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 based on your need. Make sure to add only one framework and not both.

Installation with Source Code

Github tag

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: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

      IQKeyboardManager.shared.enable = true

      return true
    }
}

Installation with Swift Package Manager

Swift Package Manager(SPM) is Apple's dependency manager tool. It is now supported in Xcode 11. So it can be used in all appleOS types of projects. It can be used alongside other tools like CocoaPods and Carthage as well.

To install IQKeyboardManagerSwift package via Xcode

Migration Guide

Other Links

Flow Diagram

IQKeyboardManager CFD

If you would like to see detailed Flow diagram then check Detailed Flow Diagram.

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