Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/keyboardkit/keyboardkit
KeyboardKit lets you create custom keyboards with a few lines of code, using Swift & SwiftUI.
https://github.com/keyboardkit/keyboardkit
apple emoji ios keyboard keyboard-extension macos swift swiftui tvos visionos watchos
Last synced: 6 days ago
JSON representation
KeyboardKit lets you create custom keyboards with a few lines of code, using Swift & SwiftUI.
- Host: GitHub
- URL: https://github.com/keyboardkit/keyboardkit
- Owner: KeyboardKit
- License: mit
- Created: 2016-08-19T01:43:45.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-01-14T08:43:02.000Z (8 days ago)
- Last Synced: 2025-01-16T04:04:13.341Z (6 days ago)
- Topics: apple, emoji, ios, keyboard, keyboard-extension, macos, swift, swiftui, tvos, visionos, watchos
- Language: Swift
- Homepage: https://keyboardkit.com
- Size: 74 MB
- Stars: 1,543
- Watchers: 29
- Forks: 233
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## About KeyboardKit
KeyboardKit is a SwiftUI SDK that lets you create fully customizable [keyboard extensions][About] with a few lines of code.
KeyboardKit extends Apple's limited keyboard APIs with more capabilities, and provides additional functionality, to let you build outstanding custom keyboards with little effort.
KeyboardKit is open-source and completely free. It can be extended with [KeyboardKit Pro][Pro] to unlock Pro features, like localized keyboards, autocomplete & autocorrect, AI support, an emoji keyboard, themes, dictation, and more.
## Installation
KeyboardKit can be installed with the Swift Package Manager:
```
https://github.com/KeyboardKit/KeyboardKit.git
```## Getting Started
To use KeyboardKit in a keyboard extension, just import `KeyboardKit` and let your `KeyboardController` inherit ``KeyboardInputViewController`` instead of `UIInputViewController`:
```swift
import KeyboardKitclass KeyboardController: KeyboardInputViewController {}
```This gives you access to lifecycle functions like `viewWillSetupKeyboardView`, observable state, services, etc.
The easiest way to set up KeyboardKit is to create a `KeyboardApp` value that defines information for your app:
```swift
extension KeyboardApp {static var keyboardKitDemo: Self {
.init(
name: "KeyboardKit",
licenseKey: "keyboardkitpro-license-key",
bundleId: "com.keyboardkit.demo",
appGroupId: "group.com.keyboardkit.demo",
deepLinks: .init(app: "kkdemo://")
)
}
}
```To set up your keyboard, just override `viewDidLoad` and call `setup(for:)` with your `KeyboardApp` value:
```swift
class KeyboardViewController: KeyboardInputViewControllerย {override func viewDidLoad() {
super.viewDidLoad()
setup(for: .keyboardKitDemo)
}
}
```To replace or customize the standard `KeyboardView` keyboard, just override `viewWillSetupKeyboardView` and call `setupKeyboardView` with the view you want to use:
```swift
class KeyboardViewController: KeyboardInputViewControllerย {override func viewWillSetupKeyboardView() {
super.viewWillSetupKeyboardView()
setupKeyboardView { [weak self] controller in // <-- Use weak or unknowned self!
KeyboardView(
state: controller.state,
services: controller.services,
buttonContent: { $0.view },
buttonView: { $0.view },
collapsedView: { $0.view },
emojiKeyboard: { $0.view },
toolbar: { _ in MyCustomToolbar() }
)
}
}
}
```To set up your main app with the same configuration, just wrap the root content view in a `KeyboardAppView`:
```swift
import SwiftUI
import KeyboardKit@main
struct MyApp: App {var body: some Scene {
WindowGroup {
KeyboardAppView(for: .keyboardKitDemo) {
ContentView()
}
}
}
}
```Setting up your app and keyboard with a `KeyboardApp` will make settings sync between the two if an ``appGroupId`` is defined, register your KeyboardKit Pro license if a ``licenseKey`` is defined, set up dictation, deep links, etc.
For more information, see the [getting started guide][Getting-Started].
## Localization
KeyboardKit supports [71 keyboard-specific locales][Localization]:
๐บ๐ธ ๐ฆ๐ฑ ๐ฆ๐ช ๐ฆ๐ฒ ๐ง๐พ ๐ง๐ฌ ๐ฆ๐ฉ ๐ณ๏ธ ๐ณ๏ธ ๐ญ๐ท
๐จ๐ฟ ๐ฉ๐ฐ ๐ณ๐ฑ ๐ง๐ช ๐ฆ๐บ ๐จ๐ฆ ๐ฌ๐ง ๐บ๐ธ ๐ช๐ช ๐ซ๐ด
๐ต๐ญ ๐ซ๐ฎ ๐ซ๐ท ๐จ๐ฆ ๐ง๐ช ๐จ๐ญ ๐ฌ๐ช ๐ฉ๐ช ๐ฆ๐น ๐จ๐ญ
๐ฌ๐ท ๐บ๐ธ ๐ฎ๐ฑ ๐ญ๐บ ๐ฎ๐ธ ๐ณ๏ธ ๐ฎ๐ฉ ๐ฎ๐ช ๐ฎ๐น ๐ฐ๐ฟ
๐น๐ฏ ๐น๐ฏ ๐น๐ฏ ๐ฑ๐ป ๐ฑ๐น ๐ฒ๐ฐ ๐ฒ๐พ ๐ฒ๐น ๐ฒ๐ณ ๐ณ๏ธ
๐ณ๐ด ๐ณ๐ด ๐ฎ๐ท ๐ต๐ฑ ๐ต๐น ๐ง๐ท ๐ท๐ด ๐ท๐บ ๐ท๐ธ ๐ท๐ธ
๐ธ๐ฐ ๐ธ๐ฎ ๐ช๐ธ ๐ฆ๐ท ๐ฒ๐ฝ ๐ธ๐ช ๐ฐ๐ช ๐น๐ท ๐บ๐ฆ ๐บ๐ฟ
๐ด๓ ง๓ ข๓ ท๓ ฌ๓ ณ๓ ฟKeyboardKit only includes localized strings, whileย [KeyboardKit Pro][Pro] unlocks localized keyboards, layouts, callouts and behaviors for all supported locales.
## Features
KeyboardKit is packed with features to help you build amazing custom keyboards:
* โจ๏ธ [Essentials][Essentials] - Essential keyboard utilities, models, services & views.
* ๐ฅ [Actions][Actions] - Trigger & handle keyboard-related actions.
* ๐ฑ [App][App] - Define and set up your app, settings, etc.
* ๐ก [Autocomplete][Autocomplete] - Perform autocomplete as the user types.
* ๐ฏ [Callouts][Callouts] - Show input & secondary action callouts.
* ๐ฅ๏ธ [Device][Device] - Identify device type, device capabilities, etc.
* ๐ [Emojis][Emojis] - Emojis, categories, versions, skin tones, etc.
* ๐ [Feedback][Feedback] - Trigger audio & haptic feedback with ease.
* ๐ [Gestures][Gestures] - Handle a rich set of gestures on any key.
* ๐ฃ [Layout][Layout] - Define and customize dynamic keyboard layouts.
* ๐ [Localization][Localization] - Localize your keyboard in **71 locales**.
* ๐บ๏ธ [Navigation][Navigation] - Open urls and other apps from the keyboard.
* ๐ [Previews][Previews] - Extensive SwiftUI preview support.
* ๐ [Proxy][Proxy] - Extend the text document proxy with more capabilities.
* โ๏ธ [Settings][Settings] - Provide keyboard settings & link to System Settings.
* ๐ฉบ [Status][Status] - Detect if a keyboard is enabled, has full access, etc.
* ๐จ [Styling][Styling] - Style your keyboard to great extent.## ๐ Pro Features
[KeyboardKit Pro][Pro] extends KeyboardKit with Pro features:
* โจ๏ธ [Essentials][Essentials] - More essential tools, previews, toolbars, etc.
* ๐ค [AI][AI] - Features that are needed for AI.
* ๐ฑ [App][App] - App-specific screens & views.
* ๐ก [Autocomplete][Autocomplete] - Local & remote autocomplete, next word prediction, etc.
* ๐ฏ [Callouts][Callouts] - Localized callout actions for all supported locales.
* ๐ค [Dictation][Dictation] - Dictate text from the keyboard.
* ๐ [Emojis][Emojis] - A powerful emoji keyboard, search, etc.
* โจ๏ธ [External][External] - Auto-detect if an external keyboard is connected.
* ๐ [Host][Host] - Identify and open specific host applications.
* ๐ฃ [Layout][Layout] - Localized layouts for all supported locales.
* ๐ [Localization][Localization] - Services & views for all supported locales.
* ๐ [Previews][Previews] - Keyboard & theme previews for in-app use.
* ๐ [Proxy][Proxy] - Allow `UITextDocumentProxy` to read the full document.
* ๐ [Text][Text-Input] - Allow users to type within the keyboard.
* ๐ญ [Themes][Themes] - A theme engine with many pre-defined themes.## Documentation
The [online documentation][Documentation] has a detailed article for each feature, a thorough getting-started guide, code samples, etc. You can also build it from the source code to get better formatting.
## Demo App
The `Demo` folder has a demo app that shows how to set up the main keyboard app, show keyboard status, provide in-app settings, link to system settings, apply custom styles, etc.
The app has two keyboards - a `Keyboard` that uses KeyboardKit and a `KeyboardPro` that uses KeyboardKit Pro. Note that you need to enable Full Access for some features to work, like haptic feedback.
> [!IMPORTANT]
> The demo isn't code signed and can therefore not use an App Group to sync settings between the app and its keyboards. As such, the `KeyboardPro` keyboard has settings screens in the keyboard as well.## KeyboardKit App
If you want to try KeyboardKit without having to write any code or build the demo app from Xcode, the [KeyboardKit app][KeyboardKit-App] lets you try out many features by just downloading it from the App Store.
## Support This Project
KeyboardKit is open-source and completely free, but you can support the project by becoming a [GitHub Sponsor][Sponsors], upgrading to [KeyboardKit Pro][Pro] or [get in touch][Email] for freelance work, paid support etc.
## Contact
Feel free to reach out if you have questions or if you want to contribute in any way:
* Website: [keyboardkit.com][Website]
* Mastodon: [@[email protected]][Mastodon]
* Twitter: [@getkeyboardkit][Twitter]
* E-mail: [[email protected]][Email]## License
KeyboardKit is available under the MIT license. See the [LICENSE][License] file for more info.
[Email]: mailto:[email protected]
[Website]: https://keyboardkit.com
[Twitter]: http://twitter.com/getkeyboardkit
[Mastodon]: https://techhub.social/@keyboardkit
[Sponsors]: https://github.com/sponsors/danielsaidi[About]: https://keyboardkit.com/about
[KeyboardKit]: https://github.com/KeyboardKit/KeyboardKit
[KeyboardKit-App]: https://keyboardkit.com/app
[Pro]: https://github.com/KeyboardKit/KeyboardKitPro
[Gumroad]: https://kankoda.gumroad.com
[License]: https://github.com/KeyboardKit/KeyboardKit/blob/master/LICENSE[Documentation]: https://keyboardkit.github.io/KeyboardKit/
[Getting-Started]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/getting-started-article
[Essentials]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/essentials-article[Actions]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/actions-article
[AI]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/ai-article
[App]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/app-article
[Autocomplete]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/autocomplete-article
[Buttons]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/buttons-article
[Callouts]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/callouts-article
[Device]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/device-article
[Dictation]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/dictation-article
[Emojis]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/emojis-article
[External]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/external-keyboards-article
[Feedback]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/feedback-article
[Gestures]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/gestures-article
[Host]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/host-article
[Layout]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/layout-article
[Localization]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/localization-article
[Navigation]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/navigation-article
[Previews]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/previews-article
[Proxy]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/proxy-article
[Settings]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/settings-article
[Status]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/status-article
[Styling]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/styling-article
[Text-Input]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/text-input-article
[Themes]: https://keyboardkit.github.io/KeyboardKit/documentation/keyboardkit/themes-article