README.md
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.
Now IQKeyboardManagerSwift uses a modular architecture with subspecs. By default, all subspecs are included, but you can include only what you need:
# Include toolbar example
pod 'IQKeyboardManagerSwift/IQKeyboardToolbarManager'
<a href="http://youtu.be/WAYc2Qj-OQg" target="_blank"></a>
@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"></a>
https://www.youtube.com/playlist?list=PL_csAAO9PQ8aTL87XnueOXi3RpWE2m_8v
| Minimum iOS Target | Minimum Xcode Version | |
|---|---|---|
| IQKeyboardManagerSwift | iOS 13.0 | Xcode 13 |
| Demo Project | Xcode 15 |
| 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 |
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'
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.
To install IQKeyboardManagerSwift package via Xcode
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.
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.
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
}
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
}
Distributed under the MIT License.
Any contribution is more than welcome! You can contribute through pull requests and issues on GitHub.
If you wish to contact me, email at: [email protected]