standalone library
Standalone-mode APIs for virtual_keypad.
Import this library when you want to attach VirtualKeypad to standard Flutter TextField or TextFormField widgets without using VirtualKeypadScope and VirtualKeypadTextField.
This is the fastest way to add an on-screen keypad to an existing Flutter form on kiosk, POS, or desktop screens, with no changes to your fields.
Included Surface
- VirtualKeypad for the keyboard widget itself
- VirtualKeypadFloating for a draggable floating keyboard host
- VirtualKeypadStandaloneScope to limit standalone behavior to a subtree
- StandaloneInputControl for advanced text-input interception use cases
- Layout and theming types needed for custom standalone keyboards
Classes
- KeyboardLanguage
- Defines all keyboard layouts for a specific language.
- KeyboardLayoutProvider
- Manages keyboard languages and provides access to layouts.
- KeyboardLayoutSet
- A complete set of keyboard layouts for a specific input type.
- StandaloneInputControl
- A TextInputControl that intercepts Flutter's text input system, allowing VirtualKeypad to work with any standard TextField or TextFormField without requiring VirtualKeypadScope.
- VirtualKey
- Represents a single key on the virtual keyboard or keypad.
- VirtualKeypad
- A customizable virtual on-screen keyboard widget.
- VirtualKeypadColorEmoji
- Registers a color emoji font at runtime, so web can show color emoji without every app paying for one in its bundle.
- VirtualKeypadFloating
- A floating, draggable host for VirtualKeypad.
- VirtualKeypadFloatingController
- Controls the visibility and docking of VirtualKeypadFloating.
- VirtualKeypadStandaloneScope
- Scopes a VirtualKeypad in standalone mode to only respond to text fields within its subtree.
- VirtualKeypadStandaloneScopeState
- State for VirtualKeypadStandaloneScope.
- VirtualKeypadTheme
- Theme configuration for VirtualKeypad appearance.
- VkpColors
- Default color constants for VirtualKeypadTheme.
Enums
- KeyAction
- Actions that can be performed by special keys on the keyboard.
- KeyboardType
- Keyboard input types that determine the layout shown.
- KeyFeedback
- How a key press is confirmed to the user, beyond the visual key preview.
- KeyType
- The type of a virtual keyboard key.
- LayoutStage
- Current layout stage for keyboards with multiple pages.
- VirtualKeypadFloatingVisibilityMode
- Controls how VirtualKeypadFloating decides when the panel is visible.
Extensions
- VirtualKeypadEmojiFont on ThemeData
- Adds the bundled emoji font to a ThemeData so emoji render offline on web.
Constants
- kBundledEmojiFontFamily → const String
- Emoji font bundled with this package, subset to the codepoints the emoji picker uses.
Functions
-
bundledEmojiFallbackFamilies(
) → List< String> - Emoji font families to fall back through, best first.
-
defaultEmojiTextStyle(
) → TextStyle? - Emoji text style applied when the caller does not supply one.
-
initializeKeyboardLayouts(
) → void - Initialize the provider with default languages.
-
withBundledEmojiFallback(
TextStyle? style) → TextStyle? -
Appends the emoji fallback families to
styleso emoji in that text render offline on web.
Typedefs
-
EmojiFontBytesLoader
= Future<
ByteData> Function() - Supplies the bytes of a color emoji font.
-
KeyboardLayout
= List<
KeyRow> - A complete keyboard layout consisting of multiple rows.
-
KeyRow
= List<
VirtualKey> - A row of keys in a keyboard layout.