KeyboardKit helps you create custom keyboards for iOS and iPadOS, using Swift and SwiftUI. It extends Apple's native keyboard APIs and provides you with more functionality.
KeyboardKit lets you create keyboards that mimic the native iOS keyboards in a few lines of code. These keyboards can be customized to change input keys, layout, design, behavior etc.
KeyboardKit also lets you use completely custom views together with the features that the library provides. Most of the library can be used on all major Apple platforms.
KeyboardKit supports iOS 14
, macOS 11
, tvOS 14
and watchOS 7
, although some features are unavailable on some platforms.
KeyboardKit can be installed with the Swift Package Manager:
https://github.com/KeyboardKit/KeyboardKit.git
You can add the library to the main app, the keyboard extension and any other targets that need it. If you prefer to not have external dependencies, you can also just copy the source code into your app.
KeyboardKit is localized in 60+ keyboard-specific locales:
๐ฆ๐ฑ ๐ฆ๐ช ๐ฆ๐ฒ ๐ง๐พ ๐ง๐ฌ ๐ฆ๐ฉ ๐ณ๏ธ ๐ญ๐ท ๐จ๐ฟ ๐ฉ๐ฐ
๐ณ๐ฑ ๐ง๐ช ๐บ๐ธ ๐ฌ๐ง ๐บ๐ธ ๐ช๐ช ๐ซ๐ด ๐ต๐ญ ๐ซ๐ฎ ๐ซ๐ท
๐ง๐ช ๐จ๐ญ ๐ฌ๐ช ๐ฉ๐ช ๐ฆ๐น ๐จ๐ญ ๐ฌ๐ท ๐บ๐ธ ๐ฎ๐ฑ ๐ญ๐บ
๐ฎ๐ธ ๐ฎ๐ฉ ๐ฎ๐ช ๐ฎ๐น ๐ฐ๐ฟ ๐น๐ฏ ๐น๐ฏ ๐น๐ฏ ๐ฑ๐ป ๐ฑ๐น
๐ฒ๐ฐ ๐ฒ๐พ ๐ฒ๐น ๐ฒ๐ณ ๐ณ๐ด ๐ฎ๐ท ๐ต๐ฑ ๐ต๐น ๐ง๐ท ๐ท๐ด
๐ท๐บ ๐ท๐ธ ๐ท๐ธ ๐ธ๐ฐ ๐ธ๐ฎ ๐ช๐ธ ๐ฐ๐ช ๐ธ๐ช ๐น๐ท ๐บ๐ฆ
๐บ๐ฟ
KeyboardKit comes with localized input sets, layouts and callouts for U.S. English.
KeyboardKit comes packed features to help you build amazing and powerful keyboards:
UITextDocumentProxy
and makes it do a lot more.The online documentation has a getting-started guide that helps you get started.
After installing KeyboardKit, just import KeyboardKit
and make your KeyboardViewController
inherit KeyboardInputViewController
instead of UIInputViewController
:
import KeyboardKit
class KeyboardController: KeyboardInputViewController {}
This gives your controller access to additional functionality, such as new lifecycle functions like viewWillSetupKeyboard()
, observable state like keyboardContext
, services like keyboardActionHandler
and much more.
The default KeyboardInputViewController
behavior is to setup an English SystemKeyboard
. It will then call viewWillSetupKeyboard()
when the keyboard view should be created or updated.
To set up KeyboardKit with a custom view, you can override viewWillSetupKeyboard()
and call .setup(with:)
to customize the SystemKeyboard
or use a custom view:
class KeyboardViewController: KeyboardInputViewControllerย {
func viewWillSetupKeyboard() {
super.viewWillSetupKeyboard()
setup { controller in
VStack(spacing: 0) {
MyCustomToolbar()
SystemKeyboard(
controller: controller,
autocompleteToolbar: .none
)
}
}
}
}
The view builder provides an unowned controller reference to avoid reference cycles and memory leaks.
For more information, please see the online documentation and getting-started guide.
The online documentation has articles, code examples etc. that let you overview the various parts of the library and understand how they all connect to each other.
The online documentation is currently iOS-specific. To generate documentation for the other platforms, open the package in Xcode, select a simulator then run Product/Build Documentation
.
KeyboardKit Pro extends KeyboardKit with pro features, such as localized keyboards and services, autocomplete, dictation, emoji skintones, additional views etc. It lets you create fully localized keyboards with a single line of code.
If you want to try out KeyboardKit without having to write any code, there is a [KeyboardKit app][app-store] in the App Store, that lets you try out KeyboardKit and many of its features.
The App Store app uses KeyboardKit Pro to provide support for 60+ locales, autocomplete, dictation, emoji skintones etc.
This project has a demo app that lets you try out KeyboardKit and KeyboardKit Pro.
English
keyboard uses KeyboardKit and a SystemKeyboard
with a standard, English locale.Unicode
keyboard uses KeyboardKit and a SystemKeyboard
with unicode-based input keys.Custom
keyboard uses KeyboardKit and a SystemKeyboard
with custom keys, layouts and styles.Pro
keyboard uses KeyboardKit Pro and a SystemKeyboard
with all LRT locales, autocomplete etc.Just open and run the demo app in the Demo
folder, then enable the keyboards you want to try under System Settings. Note that you need to enable full access to try some features, like audio and haptic feedback.
KeyboardKit is open-source and completely free, but you can sponsor this project on GitHub Sponsors, upgrade to KeyboardKit Pro or get in touch for freelance work, paid support etc.
Feel free to reach out if you have questions or if you want to contribute in any way:
KeyboardKit is available under the MIT license. See the LICENSE file for more info.
link |
Stars: 1223 |
Last commit: 1 hour ago |
This version adjusts things in KeyboardKit Pro.
Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics