KeyboardKit

5.1.0

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

What's New

2021-10-17T20:31:05Z

This version adds support for estonian, latvian and lithuanian.

This version also adds new inspection capabilities and fixes some bugs.

🌐 New locales

  • 🇪🇪 Estonian
  • 🇱🇻 Latvian
  • 🇱🇹 Lithuanian

New features

  • UITextDocumentProxy has a new hasCurrentWord property.
  • InputCallout has a new calloutPadding property.
  • KeyboardEnabledState has a new isKeyboardCurrentlyActive property.
  • KeyboardEnabledStateInspector has a new isFullAccessEnabled property.
  • KeyboardEnabledStateInspector has a new isKeyboardCurrentlyActive function.

💡 Behavior changes

  • InputCallout now calculates a minimum callout width based on button size, curve size etc.
  • InputCallout now applies a minimum callout size instead of a fixed one, which means that the callout content can be larger.

🐛 Bug fixes

  • InputCallout was rendered too wide by default, when used in SystemKeyboard. This has been fixed.
  • SecondaryInputCallout applied an incorrect leading corner radius. This has been fixed.

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 using SwiftUI.

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

KeyboardKit lets you create rich system keyboards with support for multiple locales, gestures, 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, first add KeyboardKit to your app's keyboard extension as shown above. You can add it to the main app target as well, if you want to use it there.

Then, inherit KeyboardInputViewController instead of UIInputViewController. It provides you with a lot of additional functionality, e.g. new lifecycle functions, observables like keyboardContext and services like keyboardActionHandler, keyboardAppearance, autocomplete logic etc.

KeyboardInputViewController will call viewWillSetupKeyboard whenever the keyboard must be created or re-created. You can use setup(with:) in that function, to setup your extension with any SwiftUI view.

Setting up the view controller with a SwiftUI view will make the view 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.

🇸🇪 Localization

KeyboardKit is localized in the following languages:

  • 🇺🇸 English (US - Default)

  • 🇩🇰 Danish

  • 🇳🇱 Dutch

  • 🇬🇧 English (UK)

  • 🇪🇪 Estonian

  • 🇫🇮 Finnish

  • 🇫🇷 French

  • 🇩🇪 German

  • 🇮🇹 Italian

  • 🇱🇻 Latvian

  • 🇱🇹 Lithuanian

  • 🇳🇴 Norwegian

  • 🇪🇸 Spanish

  • 🇸🇪 Swedish

KeyboardKit also supports localized keyboards, where the keyboard layout, secondary actions etc. behave just like they should for a certain locale.

Read more here

Features

Even though KeyboardKit contains a lot of features, you can use its' extensions and views alone to simplify working with keyboard extensions. For instance, there are a bunch of UITextDocumentProxy extensions that make your life easier, and views that don't require you to use the rest of the library.

Check out the demo apps and source code for examples and more information.

💥 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

🎨 Appearance

KeyboardKit comes with an appearance engine that lets you easily style your keyboards.

Read more here

🔊 Audio

KeyboardKit defines system audio types and ways to play them.

Read more here

💡Autocomplete

KeyboardKit can present autocomplete suggestions as users type.

Read more here

🗯 Callouts

KeyboardKit lets you show input callouts as users type, as well as secondary action callouts with secondary input actions.

Read more here

😊 Emojis

KeyboardKit defines emojis and emoji categories that you can use in your own keyboards.

Read more here

🧩 Extensions

KeyboardKit provides a bunch of extensions to native types.

Read more here

⌨️ External Keyboards

KeyboardKit lets you detect whether or not an external keyboard is used.

Read more here

👋 Feedback

KeyboardKit keyboards can give audio and haptic feedback as users type.

Read more about audio feedback and haptic feedback.

👆 Gestures

KeyboardKit comes with keyboard-specific gestures that you can use in your own keyboards.

Read more here

👋 Haptics

KeyboardKit defines haptic feedback types and ways to trigger them.

Read more here

🔤 Input

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

💱 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

🌐 Locales

KeyboardKit defines keyboard-specific locales and provides localized content for the supported locales.

[Read more here][Locales]

👁 Previews

KeyboardKit defines a bunch of preview-specific types that simplify previewing keyboard views in SwiftUI.

Read more here

➡️ Proxy

KeyboardKit defines a bunch of extensions to UITextDocumentProxy and ways to route text to other sources.

Read more here

🎨 Styles

KeyboardKit defines a bunch of styles that simplify customizing the look of various keyboard components and buttons.

Read more here

🖼 Views

KeyboardKit comes with a bunch of keyboard-specific views:

  • Autocomplete contains autocomplete toolbars and toolbar items.
  • Callouts contains input and secondary input callout views.
  • Emojis contains various emoji keyboards and keyboard components.
  • Input contains text inputs that can be used in a keyboard extension.
  • System contains views that can be used to mimic native systme keyboards.
  • KeyboardGrid can be used to evenly space a set of views in a grid.
  • NextKeyboardButton can be used to switch to the next keyboard.

You can also use these views without using the rest of KeyboardKit.

Demo Application

This repository contains a demo app that demonstrates different keyboards, like alphabetical (lowercased, uppercased and capslocked), numerical, symbols, emojis and images.

The demo app is not intended to be production ready, but rather to give you inspiration to how you can build your own keyboards. Just keep in mind that your keyboards can look anyway you like. They don't have to look like a system keyboard.

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.

Note that you may have to update the KeyboardKit dependencies for the demo to run. If so, you can do that under File/Swift Packages/Update to Latest Package Versions.

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.

Description

  • Swift Tools 5.3.0
View More Packages from this Author

Dependencies

Last updated: Wed Oct 27 2021 00:51:31 GMT-0500 (GMT-05:00)