FleksyManagedSettings

Settings Management

The FleksyManagedSettings class is a helper type to perform operations related to settings.

This is a helper, which means you are not required to use it. However, if you want to modify the settings from the host app, this class will manage the communication between the host app and the extension.

Summary

This class has a subset of properties from the TypingConfiguration and the StyleConfiguration.

All these properties can also be configured from the extension, providing a convenient way to simplify configuration from the host app.

Look and Feel

Part of these properties, there are a subset of them related to the look and feel of the keyboard and the user language.

Property Related Default Description
lightKeyboardTheme KeyboardTheme default This is the light theme used by the keyboard. By default, it contains the dark theme provided.
darkKeyboardTheme KeyboardTheme default This is the dark theme used by the keyboard. By default, it contains the dark theme provided.
keyboardFont StyleConfiguration. KeyboardFont normal iOS standard size.
keyboardSize StyleConfiguration. KeyboardSize standard Different sizes for the keyboard.
haptics FeedbackConfiguration false Haptic feedback is enabled or not.
soundMode FeedbackConfiguration silent Which type of sound is desired when pressing the keys.
userLanguages KeyboardLanguage empty This is an array of KeyboardLanguages. The initial value is empty. By adding a language here, it is able to automatically download the language and install it to be able to be used by the user.

Typing

Property Related Default Description
caseSensitive TypingConfiguration true keyboard keys are sensitive.
smartPunctuation TypingConfiguration true It automatically adds spaces after punctuation.
autoCorrection TypingConfiguration true It corrects words while typing.
autoCapitalization TypingConfiguration true This indicates whether the capital letter is applied after a punctuation symbol.
autoCorrect-AfterPunctuation TypingConfiguration true This indicates whether a word after punctuation should be corrected or not.
autoLearn TypingConfiguration true Automatically learns words while typing.
doubleSpaceTap-AddsPunctuation TypingConfiguration true Two taps on the space bar translate to a punctuation symbol.
backspaceTo-UndoAutoCorrection TypingConfiguration true Tapping the backspace key after an auto correction will undo the auto correction.
swipeTyping TypingConfiguration true Swipe typing enabled or disabled.
swipeLeftToDelete TypingConfiguration false Swipe left to earase a complete word. This is not compatible with swipeTyping. When swipeTyping is enabled, this setting is discarded.
wordPredictions TypingConfiguration true The keyboard shows word predictions on the top bar.
emojiPredictions TypingConfiguration true The keyboard shows emoji predictions on the top bar.
keitaiEnabled TypingConfiguration true It indicates if keitai mode is enabled on Japanese Flick layout.
spacebarMovesCursor TypingConfiguration true Long pressing the spacebar enables cursor movement within the text field.
numberRow TypingConfiguration false Wether an extra numbers row should be added on top of the letter layout for the supported languages.

Logs

Property Value Description
storeLogs Bool Enable or disable logs.
logsDirectory URL Folder where the SDK logs are stored.

If something needs to be added or if you find an error in our documentation, please let us know either on our GitHub or Discord.

Last updated on May 15, 2024