Convert Figma logo to code with AI

hackiftekhar logoIQKeyboardManager

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,499
2,416
16,499
9
View on GitHub

Top Related Projects

zvonicek's avatar

ImageSlideshow

1,782

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

RxSwiftCommunity's avatar

RxKeyboard

1,609

Reactive Keyboard in iOS

slackhq's avatar

SlackTextViewController

8,322

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

ibireme's avatar

YYKit

13,987

A collection of iOS components.

KeyboardKit's avatar

KeyboardKit

1,528

KeyboardKit lets you create custom keyboards with a few lines of code, using Swift & SwiftUI.

michaeltyson's avatar

TPKeyboardAvoiding

5,809

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

  1. 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
    }
}
  1. Customizing toolbar appearance:
IQKeyboardManager.shared.enableAutoToolbar = true
IQKeyboardManager.shared.toolbarTintColor = .blue
IQKeyboardManager.shared.toolbarBarTintColor = .lightGray
  1. Excluding specific view controllers:
class MyViewController: UIViewController {
    override func viewDidLoad() {
        super.viewDidLoad()
        IQKeyboardManager.shared.disabledDistanceHandlingClasses.append(MyViewController.self)
    }
}

Getting Started

  1. Install IQKeyboardManager using CocoaPods by adding the following to your Podfile:
pod 'IQKeyboardManager'

  1. Run pod install in your terminal.

  2. Import the library in your AppDelegate:

import IQKeyboardManagerSwift
  1. 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

zvonicek logo

ImageSlideshow

1,782

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.

RxSwiftCommunity logo

RxKeyboard

1,609

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.

slackhq logo

SlackTextViewController

8,322

⛔️**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.

ibireme logo

YYKit

13,987

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 logo

KeyboardKit

1,528

KeyboardKit lets you create custom keyboards with a few lines of code, using Swift & 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.

michaeltyson logo

TPKeyboardAvoiding

5,809

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 Figma logo designs to code with AI

Visual Copilot

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

Try Visual Copilot

README

Icon

LICENSE.md Build Status Platform iOS CocoaPods Github tag

Major updates have arrived!

First of all, Thank You for using IQKeyboardManager!

It's been 12 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 were 50+ files (version 7.x.x) 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 class
  • 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 Execution

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

  • Published IQKeyboardCore
  • This contains necessary classes and functions to be used by IQKeyboardManager related libraries. Please note that you shouldn't directly install this as dependency
  • Published IQTextView
  • This is purely separated a separate library now.
  • This is usually used for showing placeholder in UITextView.
  • Published IQKeyboardReturnManager
  • This is a renamed of IQReturnKeyHandler. This is also separated from the library and can be used independently.
  • This depends on IQKeyboardCore for TextInputView type confirmation.
  • Published IQTextInputViewNotification
  • This is a renamed of IQTextFieldViewListener. This can be used independently to subscribe/unsubscribe for UITextView/UITextField beginEditing/endEditing events.
  • This depends on the IQKeyboardCore to add some additional customized features for UITextView/UITextField.
  • Published IQKeyboardToolbar
  • This contains toolbar related classes like IQKeyboardToolbar, IQBarButtonItem, IQTitleBarButtonItems, their configuration classes and other useful functions to add toolbar in keyboard. This can be used independently to add toolbar in keyboard.
  • This depends on the IQKeyboardCore to add some additional customized features for UITextView/UITextField.
  • Published IQKeyboardToolbarManager
  • This is something similar to IQKeyboardManager. This has been moved out of the library as a huge update.
  • This depends on the IQTextInputViewNotification to know which textField is currently in focus.
  • This depends on the IQKeyboardToolbar to add/remove toolbars over keyboard.
  • Published IQKeyboardNotification
  • This is a renamed of IQKeyboardListener. This can be used independently to subscribe/unsubscribe for keyboard events.
  • Published IQKeyboardManager 7.2.0 for all the current support without any compilation error but by deprecating most of the things which are moved out of the library.
  • This now only contains functions for handling distance between UITextView/UITextField and their useful functions.
  • This depends on the IQKeyboardNotification to get keyboard notification callbacks.
  • This depends on the IQTextInputViewNotification to know which textField is currently in focus.
  • Now there are subspecs support since 7.2.0.
  • IQKeyboardManagerSwift/Appearance
  • IQKeyboardManagerSwift/IQKeyboardReturnManager
  • IQKeyboardManagerSwift/IQKeyboardToolbarManager
  • IQKeyboardManagerSwift/IQTextView
  • IQKeyboardManagerSwift/Resign
  • Published IQKeyboardManager 8.0.0 by marking deprecated classes as unavailable.
  • In this release, we removed deprecated classes and marking some of them as unavailable for easier migration.
  • Bug fixes which may have arrived due to the library segregation.
  • We need your support on this one.

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

  1. One 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, behavior 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

IQKeyboardManager Demo Video

Tutorial video by @rebeloper (#1135)

@rebeloper demonstrated two videos on how to implement IQKeyboardManager 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 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

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

Swift versions support

SwiftXcodeIQKeyboardManagerSwift
5.9, 5.8, 5.716>= 7.0.0
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

Installation

CocoaPods

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

pod 'IQKeyboardManager' #iOS13 and later

IQKeyboardManager (Swift): To install it, simply add the following line to your Podfile: (#236)

pod 'IQKeyboardManagerSwift'

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

pod 'IQKeyboardManagerSwift', '8.0.0'

Carthage

To integrate IQKeyboardManger or IQKeyboardManagerSwift into your Xcode project using Carthage, add the following line to your Cartfile:

github "hackiftekhar/IQKeyboardManager"

Run carthage update --use-xcframeworks to build the frameworks and drag the appropriate framework (IQKeyboardManager.xcframework or IQKeyboardManagerSwift.xcframework) into your Xcode project based on your need. Make sure to add only one framework, not both.

Swift Package Manager (SPM)

To install IQKeyboardManagerSwift package via Xcode

Source Code

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

IQKeyboardManager (Swift): Source code installation is not supported (since 7.2.0) because now the library depends on some other independent libraries. Due to this you may face compilation issues.

Basic Usage

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.isEnabled = true

      return true
    }
}

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