VirtualKeypad constructor

const VirtualKeypad({
  1. Key? key,
  2. KeyboardType? type,
  3. TextInputAction? inputAction,
  4. double height = 280,
  5. double? width,
  6. VirtualKeypadTheme theme = VirtualKeypadTheme.light,
  7. KeyFeedback feedback = KeyFeedback.sound,
  8. void onKeyPressed(
    1. VirtualKey key
    )?,
  9. void onKeyPressedWithText(
    1. VirtualKey key,
    2. String? text
    )?,
  10. void onStandaloneInputAction(
    1. KeyAction action,
    2. String text
    )?,
  11. List<String>? availableLanguages,
  12. String? initialLanguage,
  13. ValueChanged<String>? onLanguageChanged,
  14. KeyboardLayout? customLayout,
  15. bool enableEmojiKey = false,
  16. bool showEmojiKeyboardInitially = false,
  17. TextStyle? emojiTextStyle,
  18. EmojiFontBytesLoader? colorEmojiFontLoader,
  19. bool checkEmojiPlatformCompatibility = false,
  20. bool enableDpadNavigation = false,
  21. bool hideWhenUnfocused = false,
  22. bool standalone = false,
  23. ValueChanged<bool>? onVisibilityChanged,
  24. Duration animationDuration = const Duration(milliseconds: 200),
  25. Curve animationCurve = Curves.easeInOut,
  26. VirtualKeypadKeyBuilder? keyBuilder,
  27. KeyShuffle keyShuffle = KeyShuffle.none,
  28. Listenable? shuffleTrigger,
})

Creates a virtual keyboard.

When standalone is true, the keyboard works with any standard Flutter TextField or TextFormField without requiring VirtualKeypadScope. It intercepts Flutter's text input system to route key presses to the currently focused text field.

Implementation

const VirtualKeypad({
  super.key,
  this.type,
  this.inputAction,
  this.height = 280,
  this.width,
  this.theme = VirtualKeypadTheme.light,
  this.feedback = KeyFeedback.sound,
  this.onKeyPressed,
  this.onKeyPressedWithText,
  this.onStandaloneInputAction,
  this.availableLanguages,
  this.initialLanguage,
  this.onLanguageChanged,
  this.customLayout,
  this.enableEmojiKey = false,
  this.showEmojiKeyboardInitially = false,
  this.emojiTextStyle,
  this.colorEmojiFontLoader,
  this.checkEmojiPlatformCompatibility = false,
  this.enableDpadNavigation = false,
  this.hideWhenUnfocused = false,
  this.standalone = false,
  this.onVisibilityChanged,
  this.animationDuration = const Duration(milliseconds: 200),
  this.animationCurve = Curves.easeInOut,
  this.keyBuilder,
  this.keyShuffle = KeyShuffle.none,
  this.shuffleTrigger,
})  : assert(
        type != KeyboardType.custom || customLayout != null,
        'VirtualKeypad.customLayout is required when type is KeyboardType.custom.',
      ),
      assert(
        customLayout == null || type == KeyboardType.custom,
        'VirtualKeypad.customLayout can only be used when type is KeyboardType.custom.',
      );