📱 keyboard_safe #

A lightweight Flutter widget that prevents keyboard overflow by automatically adjusting padding and optionally scrolling input fields into view.

✅ Why KeyboardSafe? #

Flutter apps often struggle with keyboard handling, especially in complex forms.
KeyboardSafe solves this with a single, configurable wrapper that offers:

• ✅ Automatically adjusts padding when the keyboard appears
• 🎯 Auto-scrolls to focused input fields
• 📌 Optional sticky footer support above the keyboard
• 👆 Tap outside to dismiss keyboard
• 📦 Optional SafeArea wrapping
• 🎬 Smooth animated transitions

🔧 Install it #

Add it to your pubspec.yaml:

dependencies:
  keyboard_safe: ^0.0.1

Then run:

flutter pub get

🔨 Usage #

Wrap your form or layout with KeyboardSafe:

import 'package:keyboard_safe/keyboard_safe.dart';

@override
Widget build(BuildContext context) {
  return KeyboardSafe(
    scroll: true,
    dismissOnTapOutside: true,
    footer: ElevatedButton(
      onPressed: () {},
      child: const Text('Submit'),
    ),
    child: Column(
      crossAxisAlignment: CrossAxisAlignment.stretch,
      children: const [
        TextField(decoration: InputDecoration(labelText: 'Email')),
        SizedBox(height: 16),
        TextField(decoration: InputDecoration(labelText: 'Password')),
      ],
    ),
  );
}

📱 Example App #

The example/ app demonstrates the benefits of using KeyboardSafe:

✅ Includes a toggle for 'With' vs 'Without KeyboardSafe'
✅ Demonstrates auto-scroll to input, sticky footer, keyboard avoidance, and tap-outside dismissal

To run:

flutter run example

📦 Parameters #

⌨️ Dismiss Keyboard #

You can programmatically dismiss the keyboard using:

KeyboardSafe.dismissKeyboard(context);

🧪 Testing #

This package includes widget tests that verify key behaviors:

flutter test

Covered features:

✅ Padding applied when MediaQuery.viewInsets.bottom is non-zero
✅ Keyboard dismissal when tapping outside of input

📄 License #

MIT License. See LICENSE for details.

💡 Contribute #

Feel free to file issues or submit PRs to help improve this package.
Star ⭐ the repo if you found this helpful!

💬 Maintainer #

Made by @ChathraNavoda