drogel / keyboard_dismisser

A simple Flutter package to hide the keyboard when performing a gesture outside of it.

keyboard_dismisser

A simple Flutter package to hide the keyboard when performing a gesture outside of it.

Features

• By default, dismisses the keyboard when tapping outside of it on an inactive widget.
• Supports several gestures at the same time.
• Supports all the gestures available in Flutter's GestureDetector.
• Supports directional swipes to dismiss the keyboard.
• Can be applied to a whole page by wrapping its Scaffold.
• Can be applied to a whole app, by wrapping its MaterialApp, WidgetsApp, or CupertinoApp.
• Customizable drag start behavior and gesture hit testing behavior.
• Can be excluded from the semantics tree.

Usage

This package exposes a KeyboardDismisser stateless widget. You can wrap your widget with it, and your widget will be able to dismiss the keyboard when performing a gesture.

    Widget build(BuildContext context) => KeyboardDismisser(
        child: Scaffold(
            body: ...,
        ),
      );

KeyboardDismisser takes a gestures parameter, which is a list of GestureType enum cases. This way, you can pass any gesture you like for the keyboard dismissal. By default, KeyboardDismisser will dismiss the keyboard when tapping outside of it, but it handles several gestures at the same time.

    Widget build(BuildContext context) => KeyboardDismisser(
        gestures: [GestureType.onTap, GestureType.onPanUpdateDownDirection],
        child: Scaffold(
            body: ...,
        ),
      );

Getting started

In the pubspec.yaml of your flutter project, add the following dependency:

dependencies:
  keyboard_dismisser: "^[LATEST_VERSION]"

Then run $ flutter pub get. In your library, add the following import:

import 'package:keyboard_dismisser/keyboard_dismisser.dart';

Author

Diego Rogel - GitHub

Changelog

Check the Changelog page to see what's recently changed.

License

This project is licensed under the MIT License - see the LICENSE file for details.

keyboard_dismisser's Issues

flutter 3.0.0 detecting issue in the library

/D:/flutter_windows_3.0.0-stable/flutter/.pub-cache/hosted/pub.dartlang.org/keyboard_dismisser-2.0.1/lib/keyboard_dismisser.dart(418,22): warning G1E0FE241: Operand of null-aware operation '?.' has type 'WidgetsBinding' which excludes null. [D:\FlutterProjects\billz_cashier_desktop\build\windows\flutter\flutter_assemble.vcxproj]

Ability to disable dismissal on certain widgets

Hi and thank you for the package !
I'm trying to achieve the facebook messenger app kind of UX on my chat app, the issue in hand is that I want to keep the keyboard shown when user taps on the send message widget but at the same time I'm using the Keyboard dismiss globally in my materialApp builder , I couldn't find a trick to disabling the dismissal on a specific widget, do you think it's possible to have a widget 'preventKeyboardDismissal' wrapping the send message button to achieve the desired behavior ?

On Hide Keyboard Function

How to know when the keyboard is hidden?
I think this plugin needs an onHideKeyboard function.
Will you update this?

Error: Property 'focusManager' cannot be accessed on 'WidgetsBinding?' because it is potentially null.

`/D:/flutter/.pub-cache/hosted/pub.dartlang.org/keyboard_dismisser-3.0.0/lib/keyboard_dismisser.dart:418:31: Error: Property 'focusManager' cannot be accessed on 'WidgetsBinding?' because it is potentially null.

• 'WidgetsBinding' is from 'package:flutter/src/widgets/binding.dart' ('/D:/flutter/packages/flutter/lib/src/widgets/binding.dart').
  Try accessing using ?. instead.
  WidgetsBinding.instance.focusManager.primaryFocus?.unfocus();`
  

on keyboard hide

this package does not work if the keyboard hide it sill fouces thanks

onPanUpdateDownDirection Doesn't work

While onPanDown and Tap works but onPanUpdateUpDirection/Down Direction doesn't work.

does not work on web mobile

it seems that this package does not work on web mobile; tapping outside of the textfield after wrapping the page in KeyboardDismisser() does not dismiss the keyboard

Doesn't unfocus on latest beta build if outside of MaterialApp

This issue is just there to track progress of this issue: flutter/flutter#48903 (comment)

(Don't know if this is a problem of this, plugin or flutter at the moment)

Add a Helper Function to Dismiss Keyboard On Callback

Sometimes I want to dismiss the keyboard because the user dragged or tapped outside of a given widget, this package is great for this!

However, in other places I also want to dismiss the keyboard from an arbitrary callback. As such, it'd be great if this package provided both. Here's one version of what this could look like:

// In `KeyboardDismisser`.
static void dismiss(BuildContext context) {...}
.
.
.
// In my arbitrary callback.
KeyboardDismisser.dismiss(context);