flutter_v_keyboard library

A fully customizable, native-feeling virtual keyboard and text input system for Flutter.

Wrap your app (or a subtree) in a VKeyboardScope and use VTextField in place of TextField. The keyboard appears when a field gains focus and pushes the UI like the system keyboard.

Classes

BuiltinLayouts
Built-in keyboard layouts and the resolver that maps a VKeyboardType to a KeyboardLayout.
CandidateBar
Horizontal candidate suggestion strip displayed above the keyboard during active IME composition (e.g. Chinese Pinyin/Zhuyin or Japanese Kana).
ClipboardActions
Standard clipboard operations against a TextEditingController, using Flutter's Clipboard. Mutations fire onChanged with the new text.
ClipboardCallbacks
Optional developer overrides for clipboard / context-menu actions. Returning true from a handler suppresses the package's default behaviour.
ClipboardHistoryItem
A single recorded clipboard snippet in ClipboardHistoryManager.
ClipboardHistoryManager
Manages clipboard history recording, persistence, search, pinning, and deletion.
ClipboardHistoryPanel
A scrollable Clipboard History panel displayed when currentPage == 'clipboard'.
ClipboardHistoryStorage
Abstract persistence contract for ClipboardHistoryManager.
DesktopFullKeyboard
A full-featured, edge-to-edge responsive Desktop On-Screen Keyboard widget supporting multiple hardware form factors (60%, 65%, 75%, 87% TKL, 98%, and 100% Full-Size).
DesktopFullLayoutData
Provides modular, mathematically verified keycap row factories across all 6 desktop form factors (layout60, layout65, layout75, layout87TKL, layout98, layout100) and both hardware OS conventions (windows, macos).
DesktopKeyboardThemeData
Visual styling theme tailored for DesktopFullKeyboard.
DesktopLayouts
Builds the desktop (Windows On-Screen-Keyboard style) layout.
EmojiData
Curated, categorised emoji set for the emoji panel.
EmojiPanel
A scrollable, categorised emoji panel shown for the emoji page.
Emojis
HangulComposer
Pure algorithmic syllable composition and decomposition engine for Korean Hangul 2-Set (두벌식 / Dubeolsik) keyboards.
ImeEngine
Interface for language Input Method Engines (IME) that provide candidate suggestions based on a composing text buffer.
InMemoryClipboardHistoryStorage
In-memory storage implementation for testing or transient sessions.
InMemoryLayoutSelectionStorage
In-memory layout storage implementation for testing or transient sessions.
JapaneseImeEngine
Japanese Kana-to-Kanji and Katakana Input Method Engine (ja_JP).
KanaComposer
Algorithmic kana dakuten (voicing) and handakuten (semi-voicing) composer for Japanese keyboards.
KeyboardLayout
A keyboard layout: one or more named pages of key rows.
KeyboardMetrics
Responsive sizing for the keyboard, computed from the viewport — never hard-coded. Adapts to screen size, orientation, platform and form factor, and centres + width-limits the keyboard on large desktop windows.
KeyboardModifierController
Tracks modifier and lock state for the desktop keyboard.
KeyboardNavigation
Pure cursor / selection navigation over TextEditingValue.
KeyboardSession
An editing session: everything the controller needs to drive a single VTextField. Created when a field gains focus and discarded when it loses focus.
KeyboardShortcutManager
Resolves developer-registered keyboard shortcuts.
KeyboardView
Renders the current keyboard page: a background, responsive key grid and a bottom safe-area / dismiss bar. Centred and width-limited on large viewports.
KeyData
Immutable description of a single key.
KeyModel
Immutable structural definition for a proportional key in DesktopFullKeyboard.
LayoutDeDe
German (de_DE) QWERTZ layout with ä, ö, ü, ß and € currency.
LayoutElGr
Greek (el_GR) layout with Greek alphabet and € currency.
LayoutEnGb
English (UK) QWERTY layout with £ currency symbol.
LayoutEnUs
English (US) QWERTY layout.
LayoutEsEs
Spanish (es_ES) layout with ñ, ¿, ¡ and € currency.
LayoutFrFr
French (fr_FR) AZERTY layout with A/Q, Z/W swapped, M next to L, é, è, à, ç, ù, and € currency.
LayoutJaJp
Japanese (ja_JP) JIS Kana layout with ¥ currency and voicing marks (゛, ゜).
LayoutKoKr
Korean (ko_KR) 2-Set Hangul (두벌식) layout with ₩ currency.
LayoutNordic
Nordic layout supporting Swedish, Norwegian, Danish, Finnish: å, ä, ö, æ, ø, with € and kr currency symbols.
LayoutRuRu
Russian (ru_RU) ЙЦУКЕН layout with ₽ currency.
LayoutSelectionStorage
Abstract persistence contract for storing the user's selected keyboard layout.
LayoutThTh
Thai (th_TH) Kedmanee (เกษมณี) layout with ฿ (Thai Baht) currency and Thai numerals.
LayoutTrTr
Turkish Q (tr_TR) layout with ğ, ü, ş, ı, ö, ç, strict dotted/dotless i casing (i ↔ İ, ı ↔ I), and ₺ currency.
LayoutViVn
Vietnamese (vi_VN) QWERTY layout with ₫ (Vietnamese Đồng) currency and diacritic alternates.
LayoutZhCn
Simplified Chinese (zh_CN) Pinyin layout with Chinese punctuation and ¥ currency.
LayoutZhTw
Traditional Chinese (zh_TW) Zhuyin (注音 / Bopomofo) layout with tone marks and Traditional punctuation.
PinyinImeEngine
Simplified Chinese Pinyin Input Method Engine (zh_CN).
TelexComposer
Algorithmic Telex syllable composer for Vietnamese keyboards.
TextInputEngine
Pure text-editing operations on TextEditingValue.
VirtualKeyButton
A proportional keycap widget powered by Expanded so every row adapts edge-to-edge across arbitrary desktop monitor widths and resolutions.
VKeyboardConfig
Behavioural configuration for the virtual keyboard.
VKeyboardController
Orchestrates the virtual keyboard for both the mobile and desktop layouts.
VKeyboardLayoutMetadata
Metadata for a registered keyboard layout.
VKeyboardLayoutPickerPanel
The list of enabled layouts shown by showVKeyboardLayoutPicker.
VKeyboardLayouts
Global registry for virtual keyboard layouts.
VKeyboardScope
Root of the virtual keyboard system. Wrap your app (or any subtree containing VTextFields) in one of these.
VKeyboardScopeData
Data exposed by VKeyboardScope to descendants.
VKeyboardShortcuts
Registers custom keyboard shortcuts and desktop callbacks for the subtree.
VKeyboardTheme
Visual theme for the virtual keyboard.
VTextField
A drop-in text field driven by the VKeyboardScope keyboard instead of the OS keyboard.
ZhuyinImeEngine
Traditional Chinese Zhuyin / Bopomofo Input Method Engine (zh_TW).

Enums

ClipboardIntent
Clipboard intents.
DesktopKeyboardPlatform
Hardware OS layout convention used by DesktopFullKeyboard.
DeviceFormFactor
Device form factor derived from the viewport.
KeyboardLayoutType
Standard mechanical / OSK form-factor presets supported by DesktopFullKeyboard.
KeyKind
Semantic kind of a keyboard key. Drives how the controller reacts to a tap.
KeyType
Semantic classification for a key inside DesktopFullKeyboard.
LockKey
Lock keys whose state persists until toggled again.
MediaIntent
Optional media intents (delivered to a developer callback).
ModifierKey
Momentary modifier keys (sticky-toggle on the virtual keyboard).
Cursor / selection movement intents for navigation keys.
VirtualKeyAction
High-level semantic actions triggered by non-character desktop keys.
VKeyboardLocale
Built-in language and country keyboard layout locales.
VKeyboardType
Built-in keyboard types.

Extensions

ModifierKeyLogical on ModifierKey
Maps a ModifierKey to the generic (synonym) LogicalKeyboardKey used when building a LogicalKeySet for shortcut matching, so developer-declared shortcuts using LogicalKeyboardKey.control etc. match.

Functions

logicalKeyForChar(String char) → LogicalKeyboardKey?
Maps a single character to a LogicalKeyboardKey for shortcut matching (letters and digits — enough for the common Ctrl/Alt combos).
showVKeyboardLayoutPicker(BuildContext context, {required VKeyboardController controller, required VKeyboardTheme theme}) → Future<String?>
Shows a picker to select from the enabled keyboard layouts.