Skip to content
master
Switch branches/tags
Code

KeyboardKit

Version Platform Swift 5.3 MIT License Twitter: @danielsaidi

About KeyboardKit

KeyboardKit is a Swift library that helps you create custom keyboard extensions for iOS and iPadOS.

KeyboardKit contains tools for creating keyboards that mimic native iOS keyboards, as well as entirely custom ones. You can use any views you like and use the tools and extension in the library to create anything you like.

The end result can look something like this...or entirely different:

The movie above demonstrates an extensions that mimics a native keyboard. KeyboardKit lets you create rich system keyboards like that with support for multiple locales, multi-gestures, secondary action callouts etc.

If you're new to iOS keyboard extensions, this great guide will help you get started. You can also have a look at the demo app for inspiration.

Installation

Swift Package Manager

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

CocoaPods

target 'MyApp' do
  pod 'KeyboardKit'
end

target 'MyKeyboard' do
  pod 'KeyboardKit'
end

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

Getting Started

To build a keyboard extension with KeyboardKit, add KeyboardKit to your project as shown above.

If you use Swift Package Manager, make sure to add KeyboardKit to your keyboard extension. You can add it to your hosting app as well, but the keyboard extension must have it.

You should then inherit KeyboardInputViewController instead of UIInputViewController. It provides you with a lot of additional functionality, e.g. extra properties like keyboardContext, keyboardActionHandler, keyboardAppearance etc. The extension will also get access to autocomplete logic, extensions and much more.

KeyboardInputViewController has a setup(with:) function that can be used to setup your extension with any SwiftUI view. This will make it the main view of the extension, inject necessary environment objects and resize the keyboard extension to fit the view.

Have a look at the demo application and read more below to see how it all fits together.

SwiftUI vs. UIKit

KeyboardKit supports both SwiftUI and UIKit, but SwiftUI is the main focus going forward. The rest of this readme assumes that you're using SwiftUI. You can read more about UIKit support here.

Important about SwiftUI previews

KeyboardKit contains color and text resources that are embedded within the Swift package. However, SwiftUI previews outside this library can't access there resources, since the .module bundle isn't defined. This makes the previews crash.

Until this is solved in SwiftUI and SPM, call KeyboardPreviews.enable() in each preview to use fake colors and texts that don't break the preview.

Features

📦 Extensions

Even though KeyboardKit contains so much more, you can use its' extensions alone to simplify working with keyboard extensions. For instance, it has a bunch of UITextDocumentProxy extensions that make your life easier. Check out the demo apps and source code for examples and more information.

💥 Keyboard Actions

KeyboardKit comes with many keyboard-specific actions, like character inputs, emojis, backspace, space, newline, image etc. You can even create your own actions.

Read more here

😊 Keyboard Types

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

Read more here

🔤 Input Sets

KeyboardKit comes with an input set engine that make it easy to create alphabetic, numeric and symbolic keyboards in different languages.

Read more here

⌨️ Keyboard Layouts

KeyboardKit comes with a layout engine that makes it easy to create specific keyboard layouts for various devices, orientations and locales.

Read more here

🇸🇪 Localization

KeyboardKit comes with built-in support for English keyboards and can be easily extended to support more locales. KeyboardKit also has a KKL10n enum that provides localized texts.

KeyboardKit Pro adds support for even more locales:

  • 🇩🇰 Danish
  • 🇳🇱 Dutch
  • 🇺🇸 English (US)
  • 🇬🇧 English (UK)
  • 🇫🇮 Finnish
  • 🇩🇪 German
  • 🇮🇹 Italian
  • 🇳🇴 Norwegian
  • 🇸🇪 Swedish

Read more here

🎨 Appearances

KeyboardKit lets you style your custom keyboards with custom appearances.

Read more here

🗯 Callouts

KeyboardKit lets you show callout bubbles as users type, as well as secondary action callouts with optional actions.

Read more here

💡Autocomplete

KeyboardKit can present autocomplete suggestions as users type. The core library doesn't come with an implemented engine, but you can inject your own.

KeyboardKit Pro adds a localized autocomplete engine that provides localized suggestions.

Read more here

Haptic Feedback

KeyboardKit keyboards can give haptic feedback as users type.

Read more here.

🔈 Audio Feedback

KeyboardKit keyboards can give audio feedback as users type.

Read more here.

Demo Application

This repository contains a demo app that demonstrates different keyboards, like alphabetical (lowercased, uppercased and capslocked), numerical, symbols, emojis and images. It's not intended to be production ready, but rather to give you inspiration to how you can build your own keyboards.

To run the demo app, open and run the Demo/Demo.xcodeproj project, then enable the keyboards under system settings. Enable full access to support all features, like audio and haptic feedback.

KeyboardKit Pro

KeyboardKit Pro is a license-based extensions that unlocks pro features, such as additional locales and an autocomplete engine. Going pro is also a way to support this project.

Go Pro here!

Contact

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

Sponsors and Clients

This project is proudly sponsored by the following individuals and companies:

Oribi Logo Anomaly Software Logo Milo Creative Logo

You can support KeyboardKit by sponsoring the project on GitHub Sponsors, signing up for a KeyboardKit Pro license or hiring me for consultation.

License

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

About

KeyboardKit is a Swift library that helps you create custom keyboard extensions for iOS and ipadOS.

Topics

Resources

License

Sponsor this project

 

Packages

No packages published