KeyboardKit makes it easy to add hardware keyboard control to iOS and Mac Catalyst apps.
Keyboard control is a standard expectation of Mac apps. It’s important on iOS too because a hardware keyboard improves speed and ergonomics, which makes an iPad an even more powerful productivity machine.
Apps created with AppKit tend to have better support for keyboard control compared to UIKit-based apps because most AppKit components respond to key input out of the box, while most UIKit components do not. KeyboardKit narrows this gap by providing subclasses of UIKit components that respond to key commands.
- Keyboard cell selection (collection views, table views)
- Keyboard navigation (split views, navigation controllers, tab bars, modals)
- Keyboard scrolling and zooming (including page up, page down, home, end)
- Key equivalents for bar buttons (navigation bars, toolbars)
- Advanced text navigation (find next/previous, define)
- Keyboard window management (open, close, cycle)
- Keyboard date picker (change day, week, month or year)
- Discoverability titles in 39 localisations
KeyboardKit supports iOS 12.0 onwards on iPad, iPhone and Mac Catalyst (both scaled and optimised). tvOS is not supported. The latest Xcode 12.x is required.
Both Swift and Objective-C apps are supported. Since KeyboardKit is implemented in Swift, it’s not possible subclass KeyboardKit classes from Objective-C. However all other features of KeyboardKit are available to Objective-C apps.
Add KeyboardKit to an existing Xcode project as a package dependency:
- From the File menu, select Swift Packages › Add Package Dependency…
- Enter "https://github.com/douglashill/KeyboardKit" into the package repository URL text field.
- Clone this repository.
- Drag
KeyboardKit.xcodeproj
into your Xcode project. - Add the KeyboardKit target as a dependency of your target.
- Add
KeyboardKit.framework
as an embedded framework.
This Swift package contains localised resources, so Swift 5.3 (Xcode 12) or later is required.
Swift Package Manager requires the Swift and Objective-C sources to be separated into modules. The KeyboardKitObjC
module is used internally by KeyboardKit and does not need to be imported explicitly by your app.
KeyboardKit is available on CocoaPods as Keyboard-Kit
.
Please open a pull request if you notice any integration problems.
Import the framework:
import KeyboardKit
Instead of creating or subclassing a UIKit class directly, use the subclasses from KeyboardKit instead. All KeyboardKit subclasses are named by changing UI
to Keyboard
. For example replace
class SettingsViewController: UICollectionViewController {
...
}
with
class SettingsViewController: KeyboardCollectionViewController {
...
}
Or create KeyboardKit subclasses directly:
let tabBarController = KeyboardTabBarController()
tabBarController.viewControllers = [
KeyboardNavigationController(rootViewController: SettingsViewController()),
]
In order to receive key commands, an object must be on the responder chain.
You can see more in the KeyboardKitDemo app, and each class includes API documentation in their Swift source file.
The public API is currently kept minimal so components are easy to drop in. If there is something you’d like to be able to customise in KeyboardKit, please open an issue to discuss. You could also consider directly integrating the source code and modify it as needed.
- Conference talk: Keyboard control in UIKit apps at iOS Conf SG 2020
- Podcast discussion: iPhreaks episode 297
- Blog post: What’s New in KeyboardKit for iOS 14?
- Change log
KeyboardKit is a project from Douglas Hill with the kind help of contributors. Some concepts were originally developed for PSPDFKit and reimplemented in Swift for KeyboardKit. I use KeyboardKit in my reading app.
I’d love to have help on this project. For small changes please open a pull request, for larger changes please open an issue first to discuss what you’d like to see.
Tests are not required for new functionality, but fixed regressions should have automated tests. Use KeyboardKitTests
for unit tests that don’t need views or a responder chain. Use KeyboardKitDemoUITests
for integration tests that can be reproduced in the demo app. This only works on Mac Catalyst currently because iOS does not allow simulating hardware keyboard input. Use KeyboardKitUITests
for any test cases between, which is probably most cases.
MIT license — see License.txt