IQKeyboardManager

Codeless drop-in universal library allows to prevent issues of keyboard sliding up and cover UITextField/UITextView. Neither need to write any code nor any setup required and much more.

16,430

2,405

16,430

View on GitHub

Top Related Projects

ImageSlideshow

1,772

Swift image slideshow with circular scrolling, timer and full screen viewer

SlackTextViewController

8,324

⛔️**DEPRECATED** ⛔️ A drop-in UIViewController subclass with a growing text input view and other useful messaging features

KeyboardKit

1,481

KeyboardKit is a Swift SDK that lets you create fully customizable keyboards with a few lines of code, using SwiftUI.

TPKeyboardAvoiding

5,811

A drop-in universal solution for moving text fields out of the way of the keyboard in iOS

Quick Overview

IQKeyboardManager is an iOS library that prevents issues of keyboard sliding up and covering UITextField/UITextView. It also manages the navigation between UITextFields/UITextViews and adds toolbar buttons to move between them. This library provides an automatic way to handle keyboard interactions without requiring you to write any code.

Pros

Easy to implement with minimal setup required
Automatically handles keyboard appearance and dismissal
Provides smooth scrolling and text field focus management
Supports both Objective-C and Swift projects

Cons

May conflict with custom keyboard handling implementations
Some users report occasional glitches or unexpected behavior
Can add unnecessary overhead for projects with simple keyboard requirements
Limited customization options for complex scenarios

Code Examples

Basic setup in AppDelegate:

import IQKeyboardManagerSwift

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        IQKeyboardManager.shared.enable = true
        return true
    }
}

Customizing toolbar appearance:

IQKeyboardManager.shared.enableAutoToolbar = true
IQKeyboardManager.shared.toolbarTintColor = .blue
IQKeyboardManager.shared.toolbarBarTintColor = .lightGray

Excluding specific view controllers:

class MyViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        IQKeyboardManager.shared.disabledDistanceHandlingClasses.append(MyViewController.self)
    }
}

Getting Started

Install IQKeyboardManager using CocoaPods by adding the following to your Podfile:

pod 'IQKeyboardManager'

Run pod install in your terminal.
Import the library in your AppDelegate:

import IQKeyboardManagerSwift

Enable IQKeyboardManager in your AppDelegate's application(_:didFinishLaunchingWithOptions:) method:

IQKeyboardManager.shared.enable = true

That's it! IQKeyboardManager will now automatically handle keyboard interactions in your app.

Competitor Comparisons

ImageSlideshow

1,772

Swift image slideshow with circular scrolling, timer and full screen viewer

Pros of ImageSlideshow

Focused on image presentation and slideshow functionality
Supports various image sources (local, URL, custom)
Customizable transitions and animations

Cons of ImageSlideshow

Limited to image handling, not a general-purpose UI component
May require additional setup for complex image loading scenarios
Less frequent updates and smaller community compared to IQKeyboardManager

Code Comparison

ImageSlideshow:

let slideshow = ImageSlideshow(frame: CGRect(x: 0, y: 0, width: 300, height: 200))
slideshow.setImageInputs([
    ImageSource(image: UIImage(named: "myImage"))!,
    AlamofireSource(urlString: "https://example.com/image.jpg")!
])
view.addSubview(slideshow)

IQKeyboardManager:

IQKeyboardManager.shared.enable = true
IQKeyboardManager.shared.enableAutoToolbar = false
IQKeyboardManager.shared.keyboardDistanceFromTextField = 10

While both libraries aim to improve iOS app development, they serve different purposes. ImageSlideshow focuses on creating image slideshows with various sources and transitions, while IQKeyboardManager handles keyboard interactions and text field management. The code examples demonstrate their distinct functionalities, with ImageSlideshow setting up an image slideshow and IQKeyboardManager configuring keyboard behavior globally.

RxKeyboard

1,600

Reactive Keyboard in iOS

Pros of RxKeyboard

Integrates seamlessly with RxSwift, allowing for reactive programming patterns
Provides more granular control over keyboard events and states
Lightweight and focused specifically on keyboard management

Cons of RxKeyboard

Requires knowledge of RxSwift, which may have a steeper learning curve
Less comprehensive in features compared to IQKeyboardManager
May require more manual setup and configuration

Code Comparison

RxKeyboard:

RxKeyboard.instance.visibleHeight
    .drive(onNext: { [weak self] keyboardVisibleHeight in
        self?.tableView.contentInset.bottom = keyboardVisibleHeight
    })
    .disposed(by: disposeBag)

IQKeyboardManager:

IQKeyboardManager.shared.enable = true
IQKeyboardManager.shared.enableAutoToolbar = false
IQKeyboardManager.shared.shouldResignOnTouchOutside = true

RxKeyboard offers a more reactive approach, allowing developers to respond to keyboard events using RxSwift's observable streams. This can lead to more flexible and composable code. IQKeyboardManager, on the other hand, provides a simpler setup with fewer lines of code, making it easier to implement basic keyboard management functionality.

While RxKeyboard excels in scenarios where fine-grained control and reactive programming are desired, IQKeyboardManager offers a more comprehensive set of features out-of-the-box, making it suitable for a wider range of use cases with minimal configuration.

SlackTextViewController

8,324

⛔️**DEPRECATED** ⛔️ A drop-in UIViewController subclass with a growing text input view and other useful messaging features

Pros of SlackTextViewController

More comprehensive UI components, including a customizable text input toolbar
Built-in support for auto-growing text views and message composition
Includes features like autocomplete and @mentioning out of the box

Cons of SlackTextViewController

Larger and more complex, potentially harder to integrate for simple use cases
Less focused on keyboard management specifically
May require more customization to fit non-messaging apps

Code Comparison

SlackTextViewController:

let textView = SLKTextView()
textView.placeholder = "Message"
textView.placeholderColor = .lightGray
textView.pastableMediaTypes = [.image, .movie, .url]

IQKeyboardManager:

IQKeyboardManager.shared.enable = true
IQKeyboardManager.shared.enableAutoToolbar = false
IQKeyboardManager.shared.keyboardDistanceFromTextField = 10

SlackTextViewController provides a rich text input experience with built-in features for messaging apps, while IQKeyboardManager focuses solely on managing keyboard interactions across the entire app. SlackTextViewController requires more setup but offers more functionality out of the box, whereas IQKeyboardManager is simpler to implement and works automatically with minimal configuration. The choice between the two depends on the specific needs of your app, with SlackTextViewController being more suitable for complex messaging interfaces and IQKeyboardManager for general keyboard management across various app types.

YYKit

13,992

A collection of iOS components.

Pros of YYKit

Comprehensive collection of iOS development tools and utilities
High-performance image and text rendering capabilities
Extensive caching mechanisms for improved app performance

Cons of YYKit

Larger codebase and potential overhead for projects not utilizing all features
Steeper learning curve due to the wide range of functionalities
Less frequent updates compared to IQKeyboardManager

Code Comparison

YYKit (Image loading and caching):

UIImageView *imageView = [UIImageView new];
[imageView yy_setImageWithURL:[NSURL URLWithString:@"http://example.com/image.jpg"]
                 placeholder:[UIImage imageNamed:@"placeholder.png"]];

IQKeyboardManager (Keyboard handling):

IQKeyboardManager.shared.enable = true
IQKeyboardManager.shared.enableAutoToolbar = false
IQKeyboardManager.shared.shouldResignOnTouchOutside = true

While both libraries serve different purposes, YYKit offers a broader range of functionalities for iOS development, including image handling, text rendering, and caching. IQKeyboardManager, on the other hand, focuses specifically on managing keyboard interactions and provides a simpler, more targeted solution for keyboard-related issues in iOS apps.

KeyboardKit

1,481

KeyboardKit is a Swift SDK that lets you create fully customizable keyboards with a few lines of code, using SwiftUI.

Pros of KeyboardKit

More comprehensive keyboard customization options
Supports custom input views and keyboard extensions
Offers a SwiftUI-friendly API

Cons of KeyboardKit

Steeper learning curve due to more complex API
Requires more setup and configuration for basic use cases
May be overkill for simple keyboard management needs

Code Comparison

IQKeyboardManager:

import IQKeyboardManagerSwift

IQKeyboardManager.shared.enable = true
IQKeyboardManager.shared.enableAutoToolbar = false

KeyboardKit:

import KeyboardKit

struct ContentView: View {
    @StateObject var keyboardHandler = KeyboardInputViewController()
    
    var body: some View {
        TextField("Enter text", text: .constant(""))
            .keyboardType(.default)
            .autocapitalization(.none)
            .disableAutocorrection(true)
            .keyboardAppearance(.dark)
    }
}

Summary

IQKeyboardManager is simpler to implement and ideal for basic keyboard management, while KeyboardKit offers more advanced customization options and SwiftUI integration. IQKeyboardManager is better suited for quick implementations, whereas KeyboardKit shines in projects requiring extensive keyboard customization and control.

TPKeyboardAvoiding

5,811

A drop-in universal solution for moving text fields out of the way of the keyboard in iOS

Pros of TPKeyboardAvoiding

Lightweight and simple implementation
Easy to integrate with existing projects
Minimal setup required for basic functionality

Cons of TPKeyboardAvoiding

Limited customization options
Lacks advanced features like keyboard appearance prediction
May require additional code for complex layouts or edge cases

Code Comparison

TPKeyboardAvoiding:

scrollView.contentInset = UIEdgeInsets(top: 0, left: 0, bottom: keyboardHeight, right: 0)
scrollView.scrollIndicatorInsets = scrollView.contentInset

IQKeyboardManager:

IQKeyboardManager.shared.enable = true
IQKeyboardManager.shared.enableAutoToolbar = false
IQKeyboardManager.shared.keyboardDistanceFromTextField = 10

TPKeyboardAvoiding offers a more manual approach, requiring developers to handle content inset adjustments. IQKeyboardManager provides a more automated solution with additional configuration options.

TPKeyboardAvoiding is suitable for simpler projects or when fine-grained control is needed. IQKeyboardManager excels in complex applications with multiple input fields and diverse layouts, offering a more comprehensive keyboard management solution out of the box.

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Big updates are coming soon!

First of all, Thank You for using IQKeyboardManager!

It's been 11 years since it's first release in 2013. The library has grown a lot and we have added many new features since then.

Motivation

Recently while working on bug fixes, I realized that in 2013 there were only 2 files IQKeyboardManager.{h,m} in Objective-C version, while now in Swift version there are 50+ files which makes the debugging a lot difficult than before. Also some of the features are rarely used in apps.

New Idea

I realized that some of the features are not tightly linked to each other and can be moved out of the library easily. For Example:-

IQTextView clas
IQKeyboardListener class
IQTextFieldViewListener class
IQReturnKeyHandler class
Toolbar related features like IQToolbar and IQBarButtonItem and their support classes.
...

Moving above things out will make the library more lightweight and user can plug in/out features as per their needs.

Action Plan

I have decided to move loosly linked features out, and publish them to their separate github repo, and use them as dependencies as per requirements.

Below are the action plans

Introduction

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

One Lines of Code
Works Automatically
No More UIScrollView
No More Subclasses
No More Manual Work
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

GIF animation

Video

Tutorial video by @rebeloper (#1135)

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

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

Warning

If you're planning to build SDK/library/framework and want to handle UITextField/UITextView with IQKeyboardManager then you're totally going the 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 own solution to achieve same kind of results. 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 have implemented their custom solution to handle UITextField/UITextView in 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

	Language	Minimum iOS Target	Minimum Xcode Version
IQKeyboardManager	Obj-C	iOS 13.0	Xcode 13
IQKeyboardManagerSwift	Swift	iOS 13.0	Xcode 13
Demo Project			Xcode 15

Swift versions support

Swift	Xcode	IQKeyboardManagerSwift
5.9, 5.8, 5.7, 5.6	15	>= 7.0.0
5.5, 5.4, 5.3, 5.2, 5.1, 5.0, 4.2	11	>= 6.5.7
5.1, 5.0, 4.2, 4.0, 3.2, 3.0	11	>= 6.5.0
5.0,4.2, 4.0, 3.2, 3.0	10.2	>= 6.2.1
4.2, 4.0, 3.2, 3.0	10.0	>= 6.0.4
4.0, 3.2, 3.0	9.0	5.0.0

7.0.0 version notes

In this major release, a lot of variables and functions have been moved here and there. We have mentioned most of the major things in the MIGRATION GUIDE. So please take a look to make changes in your project when upgrading to this version.
The 7.0.0 version adopted the latest Swift Concurrency/Actor feature and only available iOS 13.0 and above.
Internal keyboard management handling have been updated with a different and better approach than legacy versions. However when adopting 7.0.0, please verify if it is working as expected in your apps, if there are any serious problems with 7.0.0 please open an issue with all the details and switch back to legacy version temporarily.

Installation

Installation with 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

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

Go to File -> Swift Packages -> Add Package Dependency...
Then search for https://github.com/hackiftekhar/IQKeyboardManager.git
And choose the version you want

Top Related Projects

Quick Overview

Pros

Cons

Code Examples

Getting Started

Competitor Comparisons

Pros of ImageSlideshow

Cons of ImageSlideshow

Code Comparison

Pros of RxKeyboard

Cons of RxKeyboard

Code Comparison

Pros of SlackTextViewController

Cons of SlackTextViewController

Code Comparison

Pros of YYKit

Cons of YYKit

Code Comparison

Pros of KeyboardKit

Cons of KeyboardKit

Code Comparison

Summary

Pros of TPKeyboardAvoiding

Cons of TPKeyboardAvoiding

Code Comparison

Convert designs to code with AI

README

Big updates are coming soon!

First of all, Thank You for using IQKeyboardManager!

Motivation

New Idea

Action Plan

Introduction

Key Features

Screenshot

GIF animation

Video

Tutorial video by @rebeloper (#1135)

Warning

Requirements

Swift versions support

7.0.0 version notes

Installation

Installation with CocoaPods

Installation with Carthage

Installation with Source Code

Installation with Swift Package Manager

Migration Guide

Other Links

Flow Diagram

LICENSE

Contributions

Author

Top Related Projects

Convert designs to code with AI