Skip to content

9.0.0-rc.4

Compare
Choose a tag to compare
@danielsaidi danielsaidi released this 20 Nov 20:32
· 28 commits to master since this release

✨ What's new in RC 4?

KeyboardKit 9.0 RC 4 fixes a couple of bugs and behaviors, e.g. makes the theme screen update when you select a theme, makes the emoji search uses a "done" button, and makes the emoji keyboard and emoji search enforce a minimum toolbar height to avoid incorrect rendering when the keyboard view has no toolbar.

The keyboard feedback context and its configuration are simplified, to avoid incorrect state by removing the enabled configs. Instead, we can just use the settings to disable feedback. Autocomplete has also been improved to trigger fewer times.

Services are renamed to make it easier to search and debug them. We previously had many StandardService, but the new naming convention adds the type of service to the name, e.g. KeyboardLayout.StandardLayoutService.

KeyboardKit Pro adds support for OpenAI-based next word prediction! Just add an .openAI(apiKey: ...) request to the KeyboardApp, and your keyboard will use OpenAI to predict the next word.

KeyboardKit Pro also improves license validation, and lets you use multiple keyboards with a single license, without having to register any additional bundle IDs.


💡 KeyboardKit 9 Migration Guide

When migrating from KeyboardKit 8 to 9, first upgrade to the last 8 version and fix all the deprecation warnings that it provides. This helps you prepare for KeyboardKit 9.

When you have fixed all warnings, first upgrade to KeyboardKit 9.0. It will provide you with migration deprecations that help you migrate to its many architectural changes.

Once you have fixes all migration deprecations, you can start using KeyboardKit 9. You can now configure SPM to use the latest major version number, i.e. the latest 9.x version.

The legacy migrations will be removed in 9.1, so make sure to first upgrade to 9.0 when migrating from KeyboardKit 8. If you're on KeyboardKit 7, first repeat these steps for 8.0.

9.0

This version upgrades the deployment targets to iOS 15, macOS 12, tvOS 15, watchOS 8, and visionOS 1, removes all deprecated code, and simplifies many concepts.

This version has migration deprecations to help you transition from KeyboardKit 8. Just follow the instructions to migrate your code if needed. They will be removed in 9.1.

This version also moves a lot of non-essential views and utilities from KeyboardKit to KeyboardKit Pro, to make the open-source framework a bit more basic and overviewable.

You may still run into a few breaking changes, where migrations were not possible due to architectural changes. For such breaking changes, see the changes & comments below.

Migration-based changes that are not listed under "Breaking Changes" will become breaking if you don't address any such warnings before upgrading to KeyboardKit 9.1 and later.

👑 Pro

KeyboardKit Pro can now be used by multiple targets in the same app, using a single app bundle ID.

KeyboardKit Pro can now activate yearly Gold & Enterprise licenses with a standalone license file.

🧪 Experiments

The next keyboard button experiments have been made permanent.

⌨️ Essentials

The KeyboardContext has a new isKeyboardCollapsed as well as a new isAutoCollapsedEnabled setting.

The KeyboardContext has a new keyboardCase that lets us decouple the keyboard type from the keyboard case.

The KeyboardContext has a new keyboardTypeForKeyboard that updates to phone when the keyboard is floating on iPad.

The KeyboardType.alphabetic keyboard type is also decoupled from the case, which makes the type a lot easier to use.

The KeyboardController protocol now has services and state properties, so that it can be used in even more places.

The KeyboardView now supports being used as a floating keyboard on iPad devices, which will render it as a phone keyboard.

The KeyboardView now has a collapsedView that will be displayed when the keyboard context isKeyboardCollapsed is true.

Keyboard.CollapsedView is a new standard view that can be displayed when the keyboard context isKeyboardCollapsed is true.

⚙️ Services

The service name changes and refactoring have been a great adjustment, but went a little too far.

Developers have provided feedback that it's hard to tell services apart since there are now many StandardService.

As such, this version takes one step back and adds the service type to the class name. The shorthands stay the same.

This means that the adjusted name for e.g. KeyboardLayout.StandardService will be KeyboardLayout.StandardLayoutService.

This name change will hopefully make it easier to distinguish between various services when searching and debugging the SDK.

💥 Actions

The KeyboardAction.StandardActionHandler now implements KeyboardBehavior.

📱 App

The KeyboardApp now lets you register a custom next word prediction request.

💡 Autocomplete

The AutocompleteService now returns a Autocomplete.ServiceResult instead of just a list of suggestions.

The Autocomplete.NextWordPredictionRequest is a new type with Claude and OpenAI integration requests.

The Autocomplete.Suggestion type now implements Codable and Equatable. This required additional info changes.

The Autocomplete.Toolbar now uses views builder params. The standard views are also polished to look more native.

The KeyboardInputController now disables autocorrect instead of autocomplete if a keyboard type doesn't prefer autocomplete.

The reason for the autocomplete change is that custom keyboards must always have top padding, so hiding autocomplete makes little sense.

🗯️ Callouts

The Callouts namespace has been renamed to KeyboardCallout and simplified to only use a single style and a single context.

Most changes have migration deprecations, where using the old ways will either map to the new way, or in some cases do nothing.

The KeyboardStyleService has been adjusted to return an optional callout style, to only override the environment style if it's defined.

The KeyboardTheme has been adjusted to only provide a single calloutStyle, instead of providing individual action & input callout styles.

The .calloutStyle view modifier can therefore be applied to KeyboardView now, which will either use the service style or the environment one.

🎤 Dictation

The Dictation namespace has been simplified to only use a single service that can handle all dictation scenarios.

The new DictationService doesn't need a configuration. It uses a KeyboardContext & KeyboardApp to determine its behavior.

😀 Emojis

Emoji localization has been drastically improved, and now supports Swedish localizations.

The EmojiKeyboardStyle has been moved to KeyboardKit. The .emojiKeyboardStyle modifier takes a style builder instead of a style, to allow root level styling.

The standard emoji styles no longer take an input toolbar display mode. You can instead use the new .augmented(for:) style function if you need to adjust the style.

The KeyboardKit Pro EmojiKeyboard has been rebuilt from scratch, and now behaves more like a native keyboard, by scrolling through all categories and supporting search.

🧩 Extensions

The String .lastSentence property now includes the last sentence even if it's not ended.

⌨️ External Keyboard

The ExternalKeyboardContext has been moved to the open-source library and added to Keyboard.State.

🔉 Feedback

The Feedback namespace has been renamed to KeyboardFeedback and simplified quite a bit.

The haptic feedback has been adjusted to be lighter when typing, to make the typing not feel as heavy.

The FeedbackContext no longer has enabled configs, since its settings is now used to toggle feedback.

🇸🇪 Localization

The KeyboardLocale enum has been replaced with using the native Locale everywhere.

This version adds support for 🇦🇺 English (Australia) and 🇨🇦 English (Canada), bringing the number of supported locales up to 70.

🔣 Layout

InputSet can now be created with device variations, which allows for resolving device-specific items at runtime.

This makes it possible to render the same input for different devices, which makes the floating keyboard possible.

KeyboardLayout is now a struct instead of a class, which better reflects the value type nature of its model.

This requires you to change any layout variables to use var instead of let when you want to mutate the layout.

The KeyboardLayoutIdentifiable protocol has been removed to make layout item mutations easier to understand & use.

KeyboardKit Pro adds layout item mutations to the KeyboardLayout itself, which will allow for future improvements.

🎛️ Settings

Persistent settings have moved from the various contexts to nested settings types, to separate properties from settings.

📝 Text Input

The KeyboardContext is now responsible for the textInputProxy. The controller refers to this proxy, but the context owns it.

The KeyboardKit Pro input text components can therefore be setup with a KeyboardContext, and no longer need a controller instance.

🍭 Themes

The KeyboardStyle.ThemeBasedStyleService can now be created with a theme context, which makes it auto-update when the theme is changed.

🚨 Breaking Changes

There are breaking changes in this version, but most are handled by migration deprecations that will be removed in 9.1.

Make sure that you address any migration deprecation warnings you receive, to avoid breaking changes in KeyboardKit 9.1.

Some things that are not covered by migration deprecations are:

  • All previously deprecated code has been removed.
  • All previously mutable styles and configs are now computed.
  • The dictation changes can't be migrated since the services are merged.
  • Autocomplete.Suggestion implements protocols that required info constraints.
  • Autocomplete.LocalAutocompleteService now requires a keyboard context for contextual info.
  • InputSet no longer implements the removed KeyboardLayoutIdentifiable protocol.
  • KeyboardLayout is now a struct, and must now be a var for you to customize it.
  • KeyboardStyleService and callout style view modifiers now only use the base style.
  • StandardSpeechRecognizer has been refactored, and must be updated for you to use it.

A problem you may face, is that KeyboardInputViewController.setupKeyboardView(_ view: @autoclosure @escaping () -> Content) has been renamed to setupKeyboardView(with:) to remove DocC ambiguity. If you do, just add with:.