modify IQKeyboardManager

Overview

Icon

IQKeyboardManager

GitHub license

Build Status Coverage Status 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 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

IQKeyboardManager Settings

GIF animation

IQKeyboardManager

Video

IQKeyboardManager Demo Video

Tutorial video by @rebeloper (#1135)

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

Youtube Tutorial Playlist

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

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

Platform iOS

Language Minimum iOS Target Minimum Xcode Version
IQKeyboardManager Obj-C iOS 8.0 Xcode 8.2.1
IQKeyboardManagerSwift Swift iOS 8.0 Xcode 8.2.1
Demo Project Xcode 9.0

Note

  • 3.3.7 is the last iOS 7 supported version.

Swift versions support

Swift Xcode IQKeyboardManagerSwift
4.X 9.0 >= 5.0.0
4.0 9.0 5.0.0
3.1 8.3 4.0.10
3.0 (3.0.2) 8.2 4.0.8
2.2 or 2.3 7.3 4.0.5
2.1.1 7.2 4.0.0
2.0 7.0 3.3.3.1

Note

  • 5.0.0 is backward compatible till Swift 3.

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' #iOS8 and later

pod 'IQKeyboardManager', '3.3.7' #iOS7

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

Swift 4.0 (Xcode 9.0)

pod 'IQKeyboardManagerSwift'

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

pod 'IQKeyboardManagerSwift', '5.0.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: [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

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

IQKeyboardManager CFD

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]

You might also like...
Owner
WL
Just a developer
WL
A fast, convenient and nonintrusive conversion framework between JSON and model. Your model class doesn't need to extend any base class. You don't need to modify any model file.

MJExtension A fast, convenient and nonintrusive conversion framework between JSON and model. 转换速度快、使用简单方便的字典转模型框架 ?? ✍??Release Notes: more details Co

M了个J 8.5k Jan 3, 2023
Swift Package used for video where I demonstrate how to extract a package to a local framework and modify it.

SegmentedPicker NOTE: This sample code is taken from the article by Frank Jia in his article titled Build a Custom iOS Segmented Control With SwiftUI

Stewart Lynch 1 Oct 11, 2021
Workaround to hide/modify List separators in SwiftUI iOS13 and iOS14

Help support my open source work! iOS15 List finally supports setting list row separator color and style as of iOS15! They still don't support list in

Michael Schmidt 135 Dec 7, 2022
Cookbook app that allows you to read, add and modify your recipes.

What-s-For-Dinner-iOS-App Cookbook app that allows you to read, add and modify your recipes. Features ?? ?? View You can see recipes divided into cate

Katie Saramutina 2 May 18, 2022