IQKeyboardManager README

The project's README from github.com/hackiftekhar/IQKeyboardManager. As one markdown file: README.md.

Icon

LICENSE.md Build Status Platform iOS CocoaPods Github tag

IQKeyboardManager Objective-C version source code is moved to https://github.com/hackiftekhar/IQKeyboardManagerObjC

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 Line of Code - Just enable and it works
  2. Works Automatically - No manual setup required
  3. No More UIScrollView - Automatically handles scroll views
  4. No More Subclasses - Works with standard UIKit components
  5. No More Manual Work - Handles all edge cases automatically
  6. Modular Architecture - Include only what you need via subspecs

What's Included

Optional Features (via Subspecs)

Subspecs

Now IQKeyboardManagerSwift uses a modular architecture with subspecs. By default, all subspecs are included, but you can include only what you need:

Available Subspecs

Including Specific Subspecs

# Include toolbar example
pod 'IQKeyboardManagerSwift/IQKeyboardToolbarManager'

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

Requirements

Minimum iOS Target Minimum Xcode Version
IQKeyboardManagerSwift iOS 13.0 Xcode 13
Demo Project Xcode 15

Swift versions support

Swift Xcode IQKeyboardManagerSwift
5.9, 5.8, 5.7 16 >= 7.0.0
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

Installation

CocoaPods

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

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

Minimal Setup (Core Only)

In AppDelegate.swift, import and enable IQKeyboardManager:

import IQKeyboardManagerSwift

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?

    func application(_ application: UIApplication, 
                     didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

        // Enable keyboard management
        IQKeyboardManager.shared.isEnabled = true

        return true
    }
}

That's it! The keyboard will now automatically adjust to avoid covering text fields.

With Toolbar (Requires IQKeyboardToolbarManager Subspec)

import IQKeyboardManagerSwift

func application(_ application: UIApplication, 
                 didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

    // Enable keyboard management
    IQKeyboardManager.shared.isEnabled = true
    
    // Enable toolbar (@Deprecated: Please use IQKeyboardToolbarManager pod independently)
    IQKeyboardManager.shared.enableAutoToolbar = true

    return true
}

With All Features

import IQKeyboardManagerSwift

func application(_ application: UIApplication, 
                 didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

    // Core functionality
    IQKeyboardManager.shared.isEnabled = true
    IQKeyboardManager.shared.keyboardDistance = 20.0
    
    // Toolbar (if using IQKeyboardToolbarManager subspec)
    IQKeyboardManager.shared.enableAutoToolbar = true
    
    // Tap to resign (if using Resign subspec)
    IQKeyboardManager.shared.resignOnTouchOutside = true
    
    // Appearance (if using Appearance subspec)
    IQKeyboardManager.shared.keyboardConfiguration.overrideKeyboardAppearance = true
    IQKeyboardManager.shared.keyboardConfiguration.keyboardAppearance = .dark

    return true
}

Migration Guide

Other Links

Dependency Diagram

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

IQKeyboardManager (hackiftekhar/IQKeyboardManager)

Searching Database…

16.6K ·GitHub
IQKeyboardManager
What is this?IQKeyboardManager is a drop-in iOS library that automatically prevents the keyboard from sliding up and covering a UITextField or UITextView, with no code or manual setup needed.
Is it a framework I have to build around, or just a library I drop in?It is a lightweight drop-in library: you add it to your project and enable it with one line of code, and it handles keyboard avoidance automatically for standard UIKit components.
How do I add it to my project?Install via CocoaPods (add a line to the Podfile), Carthage (add to Cartfile and run 'carthage update --use-xcframeworks'), or Swift Package Manager through Xcode's Add Package Dependency dialog, then enable it in AppDelegate.swift.
Do I need a specific Xcode or iOS version?IQKeyboardManagerSwift requires a minimum iOS target of 13.0 and Xcode 13, with support mapped to specific Swift versions in a compatibility table.
Any install pitfalls I should know about?Since version 7.2.0, installing from raw source code is not supported because the library now depends on other independent libraries, which can cause compilation issues; use CocoaPods, Carthage, or SPM instead.
Should I use this inside my own SDK or third-party library?No — the author explicitly warns against shipping IQKeyboardManager as a dependency of another SDK/library/framework; it's meant for app projects, not for bundling into third-party libraries.
What happens if it conflicts with another third-party UI library?It's the developer's responsibility to manually enable or disable IQKeyboardManager when presenting or dismissing that third-party UI, since the third-party library won't handle it.
Can I pick only parts of the library instead of everything?Yes, it uses a modular subspec architecture — Core is always included, and you can optionally add Appearance, IQKeyboardReturnManager, IQKeyboardToolbarManager, IQTextView, or Resign depending on what features you need.
Does it add a toolbar with Previous/Next/Done buttons?Yes, that's available as the optional IQKeyboardToolbarManager subspec rather than being part of the Core module.
Does it still support the Objective-C version?The Objective-C version's source code has been moved elsewhere and is no longer maintained in this Swift-focused repo.
What are similar projects?Spring, AFNetworking, SVProgressHUD, FSCalendar, SwiftyJSON, Eureka, FLEX, chameleon
Which topics is it in?appkit, swift-library, productivity-tools, cocoapods, keyboard, objective-c, xcode, apple, swift, sdk, utility, mobile
Creator
hackiftekhar
Size
24.8 MB
Stars
16.6K
Updated
CommitMay 25Release8.0.3May 25
Age
13y
Commits · 90 Days