devzhr / KeyboardKit

KeyboardKit is a Swift library that helps you create iOS keyboard extensions.

KeyboardKit

About KeyboardKit

KeyboardKit is a helps you create custom keyboard extensions for iOS and ipadOS. It provides you with a rich set of tools and actions, haptic and audio feedback, input sets, keyboard layouts etc. and lets you create keyboards with characters, numbers, symbols, emojis, images or entirely custom logic.

You can create native looking keyboards like the example below, or completely custom keyboards:

If you're new to iOS keyboard extensions, this great guide can help you get started. You can also have a look at the demo apps for examples on how to use this library.

Installation

Swift Package Manager

https://github.com/danielsaidi/KeyboardKit.git

CocoaPods

target 'MyApp' do
  pod 'KeyboardKit'
end

target 'MyKeyboard' do
  pod 'KeyboardKit'
end

Getting Started

With KeyboardKit, you should inherit KeyboardInputViewController instead of UIInputViewController. It provides you with many tools that helps you build custom keyboard extension.

KeyboardKit supports both UIKit and SwiftUI, so you can pick the option that suits your needs best.

UIKit

KeyboardKit contains a rich set of tools to create UIKit-based keyboards. Read more here.

You can also follow this tutorial.

SwiftUI is the main focus going forward, but UIKit support will be around and be improved if needed.

SwiftUI

KeyboardKit can be extended with KeyboardKitSwiftUI to create SwiftUI-based keyboards. Read more here.

You can also follow this tutorial.

SwiftUI is the main focus going forward, and will be the main technology from version 4.0.

Actions

KeyboardKit supports many different keyboard actions, like character inputs, emoji inputs, backspace, newline, space, image etc. You can even create your own, custom actions.

Read more here

Keyboard Types

KeyboardKit supports many different keyboard types, like alphabetic, numeric, symbolic, emoji etc. You can even create your own, custom keyboard types.

Read more here

Input Sets

KeyboardKit provides you with locale-specific input sets, which makes it easy to create alphabetic, numeric and symbolic keyboards in many languages.

KeyboardKit comes with a set of locale-specific input sets for e.g. English, German, Italian and Swedish.

Read more here

Keyboard Layouts

KeyboardKit can combine an input set with surrounding actions to create a keyboard layout, which is the total set of actions on a keyboard.

KeyboardKit comes with a set of locale and device-specific keyboard layouts for iPhones and iPads.

Read more here

Autocomplete

KeyboardKit supports autocomplete and can present autocomplete suggestions to users as they type.

Read more here

Haptic Feedback

KeyboardKit supports haptic feedback and can give users haptic feedback as they type.

Read more here.

Audio Feedback

KeyboardKit supports audio feedback and can give users audio feedback as they type.

Read more here.

Extensions

KeyboardKit comes with many keyboard-specific extensions. Check out the demo apps and source code for examples and more information.

Demo Applications

This repository contains two demo apps that demonstrate different keyboard types, like alphabetical (lower/uppercased and caps locked), numerical, symbols, emojis and images.

• KeyboardKitDemoKeyboard uses UIKit to implement various keyboards that mimics system keyboards.
• KeyboardKitDemoKeyboard_SwiftUI uses SwiftUI to implement the same keyboards in another way.

Since KeyboardKitSwiftUI is still under development, the SwiftUI demo app lacks a lot of functionality that the UIKit app supports.

To run the demo app, open and run the KeyboardKit.xcodeproj project, then enable the keyboards under system settings. Don't forget to enable full access to support all features, like audio and haptic feedback.

Contact me

Feel free to reach out if you have questions or if you want to contribute in any way:

• E-mail: [e-mail]
• Twitter: @danielsaidi
• Web site: danielsaidi.com

Clients

KeyboardKit is proudly supported by:

Your company can support KeyboardKit by either sponsoring the project on GitHub Sponsors or by paying for consultation. I'ld be happy to help you out with your keyboard needs.

License

KeyboardKit is available under the MIT license. See LICENSE file for more info.