Installation

IQKeyboardManager can be installed using CocoaPods, Swift Package Manager (SPM), or Carthage. Choose the method that works best for your project.

Installation Methods

Swift Package Manager
CocoaPods
Carthage

Swift Package Manager is the recommended method for installing IQKeyboardManager.

Step 1: Add Package Dependency

In Xcode, add the package:

Go to File → Swift Packages → Add Package Dependency…

Enter the repository URL:

https://github.com/hackiftekhar/IQKeyboardManager.git

Choose the version you want (latest is recommended)
Click Add Package

Step 2: Select Target

Select your app target and click Finish.

SPM automatically includes all subspecs and their dependencies.

Package Dependencies

IQKeyboardManager depends on several independent libraries:

IQKeyboardNotification (>= 1.0.6)
IQTextInputViewNotification (>= 1.0.9)
IQKeyboardToolbarManager (>= 1.1.4)
IQKeyboardReturnManager (>= 1.0.6)
IQTextView (>= 1.0.5)

These are automatically managed by SPM.

Install IQKeyboardManager using CocoaPods.

Step 1: Add to Podfile

Add the following line to your Podfile:

pod 'IQKeyboardManagerSwift'

Step 2: Install

Run the install command:

pod install

By default, all subspecs are included. See below for including specific subspecs only.

Version-Specific Installation

To install a specific version based on Swift compatibility:

# For Swift 5.7, 5.8, 5.9 (Xcode 15+)
pod 'IQKeyboardManagerSwift', '8.0.0'

# For Swift 5.5+ (Xcode 11+)
pod 'IQKeyboardManagerSwift', '6.5.7'

# For Swift 5.0+ (Xcode 10.2+)
pod 'IQKeyboardManagerSwift', '6.2.1'

Refer to the Swift version compatibility table for more details.

Installing Specific Subspecs

To optimize your app size, include only the subspecs you need:

# Include core functionality and toolbar only
pod 'IQKeyboardManagerSwift/Core'
pod 'IQKeyboardManagerSwift/IQKeyboardToolbarManager'

Available Subspecs

Subspec	Description	Dependencies
`Core`	Basic keyboard distance management (always required)	IQKeyboardNotification, IQTextInputViewNotification
`Appearance`	Keyboard appearance configuration	IQTextInputViewNotification
`IQKeyboardReturnManager`	Return key handling	IQKeyboardReturnManager
`IQKeyboardToolbarManager`	Toolbar with Previous/Next/Done buttons	IQKeyboardToolbarManager
`IQTextView`	UITextView with placeholder support	IQTextView
`Resign`	Tap-to-resign keyboard functionality	IQTextInputViewNotification

Install IQKeyboardManager using Carthage.

Step 1: Add to Cartfile

Add the following line to your Cartfile:

github "hackiftekhar/IQKeyboardManager"

Step 2: Build Frameworks

Run Carthage to build the frameworks:

carthage update --use-xcframeworks

Step 3: Add Framework to Project

In Xcode, go to your target’s General settings
Drag IQKeyboardManagerSwift.xcframework from the Carthage/Build folder into the Frameworks, Libraries, and Embedded Content section
Ensure it’s set to Embed & Sign

Only add IQKeyboardManagerSwift.xcframework. Do not add both Objective-C and Swift versions.

Swift Version Compatibility

Make sure to install the correct version based on your Swift and Xcode versions:

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

Source Code Installation

Source code installation is not supported since version 7.2.0.

The library now depends on several independent libraries, which makes source code installation complex and prone to compilation issues. Please use one of the package managers above.

Verification

After installation, verify that IQKeyboardManager is properly integrated:

Step 1: Import the Framework

In your AppDelegate.swift, add the import statement:

import IQKeyboardManagerSwift

Step 2: Check for Errors

Build your project (⌘+B) and ensure there are no import errors.

If you see a “No such module” error, clean the build folder (⌘+Shift+K) and rebuild.

Step 3: Test Basic Functionality

Add this code to verify the singleton is accessible:

func application(_ application: UIApplication, 
                 didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    
    print("IQKeyboardManager available: \(IQKeyboardManager.shared)")
    return true
}

If this prints successfully, the installation is complete!

Troubleshooting

Module 'IQKeyboardManagerSwift' not found

This usually means the framework wasn’t properly linked. Try:

Clean build folder: Product → Clean Build Folder (⌘+Shift+K)
Delete derived data: ~/Library/Developer/Xcode/DerivedData
Close and reopen Xcode
Rebuild the project

For CocoaPods:

pod deintegrate
pod install

For SPM:

File → Swift Packages → Reset Package Caches
File → Swift Packages → Resolve Package Versions

Build errors after installation

If you see build errors after installing:

Ensure your deployment target is iOS 13.0 or later
Check that you’re using a compatible Xcode version (13+)
Verify your Swift version matches the compatibility table
Make sure you’re not mixing Swift and Objective-C versions

Carthage build fails

If Carthage fails to build:

# Try using xcframeworks
carthage update --use-xcframeworks --platform iOS

# Or specify the new build system
carthage update --use-xcframeworks --platform iOS --no-use-binaries

CocoaPods integration issues

If CocoaPods shows warnings or errors:

# Update CocoaPods
sudo gem install cocoapods

# Update repository
pod repo update

# Clear cache and reinstall
pod cache clean --all
pod deintegrate
pod install

Xcode 15+ Code Signing Issues

If you encounter code signing issues in Xcode 15+:The library includes ENABLE_USER_SCRIPT_SANDBOXING = NO in its xcconfig to prevent build issues. If you still have problems, add this to your project’s build settings or Podfile:

post_install do |installer|
  installer.pods_project.targets.each do |target|
    target.build_configurations.each do |config|
      config.build_settings['ENABLE_USER_SCRIPT_SANDBOXING'] = 'NO'
    end
  end
end

Next Steps

Quick Start

Now that you’ve installed IQKeyboardManager, learn how to set it up and use it in your app.

Get Started

Core Concepts

Guides

Migration

Installation Methods

Step 1: Add Package Dependency

Step 2: Select Target

Package Dependencies

Step 1: Add to Podfile

Step 2: Install

Version-Specific Installation

Installing Specific Subspecs

Available Subspecs

Step 1: Add to Cartfile

Step 2: Build Frameworks

Step 3: Add Framework to Project

Swift Version Compatibility

Source Code Installation

Verification

Step 1: Import the Framework

Step 2: Check for Errors

Step 3: Test Basic Functionality

Troubleshooting

Next Steps

Quick Start

Build docs developers (and LLMs) love

Get Started

Core Concepts

Guides

Migration

​Installation Methods

​Step 1: Add Package Dependency

​Step 2: Select Target

​Package Dependencies

​Step 1: Add to Podfile

​Step 2: Install

​Version-Specific Installation

​Installing Specific Subspecs

​Available Subspecs

​Step 1: Add to Cartfile

​Step 2: Build Frameworks

​Step 3: Add Framework to Project

​Swift Version Compatibility

​Source Code Installation

​Verification

​Step 1: Import the Framework

​Step 2: Check for Errors

​Step 3: Test Basic Functionality

​Troubleshooting

​Next Steps

Quick Start

Build docs developers (and LLMs) love

Installation Methods

Step 1: Add Package Dependency

Step 2: Select Target

Package Dependencies

Step 1: Add to Podfile

Step 2: Install

Version-Specific Installation

Installing Specific Subspecs

Available Subspecs

Step 1: Add to Cartfile

Step 2: Build Frameworks

Step 3: Add Framework to Project

Swift Version Compatibility

Source Code Installation

Verification

Step 1: Import the Framework

Step 2: Check for Errors

Step 3: Test Basic Functionality

Troubleshooting

Next Steps