base on Get notified on keyboard visibility changes in your Flutter app # Flutter Keyboard Visibility [](https://pub.dev/packages/flutter_keyboard_visibility)  [](https://codecov.io/gh/MisterJimson/flutter_keyboard_visibility) React to keyboard visibility changes. ### Note about Flutter Web and Desktop support Web support is an open issue [here](https://github.com/MisterJimson/flutter_keyboard_visibility/issues/10), desktop support is an open issue [here](https://github.com/MisterJimson/flutter_keyboard_visibility/issues/124). Currently this library will just return `false` for keyboard visibility on web and desktop. ## Install [Install the package](https://pub.dev/packages/flutter_keyboard_visibility/install) ## Usage: React to Keyboard Visibility Changes ### Option 1: Within your `Widget` tree using a builder Build your Widget tree based on whether or not the keyboard is visible by using `KeyboardVisibilityBuilder`. ```dart import 'package:flutter_keyboard_visibility/flutter_keyboard_visibility.dart'; /// In any of your widgets... @override Widget build(BuildContext context) { return KeyboardVisibilityBuilder( builder: (context, isKeyboardVisible) { return Text( 'The keyboard is: ${isKeyboardVisible ? 'VISIBLE' : 'NOT VISIBLE'}', ); } ); ``` ### Option 2: Within your `Widget` tree using a provider Build your `Widget` tree based on whether or not the keyboard is visible by including a `KeyboardVisibilityProvider` near the top of your tree. ```dart import 'package:flutter_keyboard_visibility/flutter_keyboard_visibility.dart'; // Somewhere near the top of your tree... @override Widget build(BuildContext context) { return KeyboardVisibilityProvider( child: MyDemoPage(), ); } // Within MyDemoPage... @override Widget build(BuildContext context) { final bool isKeyboardVisible = KeyboardVisibilityProvider.isKeyboardVisible(context); return Text( 'The keyboard is: ${isKeyboardVisible ? 'VISIBLE' : 'NOT VISIBLE'}', ); } ``` ### Option 3: Direct query and subscription Query and/or subscribe to keyboard visibility directly with the `KeyboardVisibilityController` class. ```dart import 'package:flutter_keyboard_visibility/flutter_keyboard_visibility.dart'; import 'dart:async'; late StreamSubscription<bool> keyboardSubscription; @override void initState() { super.initState(); var keyboardVisibilityController = KeyboardVisibilityController(); // Query print('Keyboard visibility direct query: ${keyboardVisibilityController.isVisible}'); // Subscribe keyboardSubscription = keyboardVisibilityController.onChange.listen((bool visible) { print('Keyboard visibility update. Is visible: $visible'); }); } @override void dispose() { keyboardSubscription.cancel(); super.dispose(); } ``` ## Usage: Dismiss keyboard on tap Place a `KeyboardDismissOnTap` near the top of your `Widget` tree. When a user taps outside of the currently focused `Widget`, the `Widget` will drop focus and the keyboard will be dismissed. ```dart import 'package:flutter_keyboard_visibility/flutter_keyboard_visibility.dart'; // Somewhere near the top of your tree... @override Widget build(BuildContext context) { return KeyboardDismissOnTap( child: MyDemoPage(), ); } ``` By default `KeyboardDismissOnTap` will only dismiss taps not captured by other interactive `Widget`s, like buttons. If you would like to dismiss the keyboard for any tap, including taps on interactive `Widget`s, set `dismissOnCapturedTaps` to true. ```dart import 'package:flutter_keyboard_visibility/flutter_keyboard_visibility.dart'; // Somewhere near the top of your tree... @override Widget build(BuildContext context) { return KeyboardDismissOnTap( dismissOnCapturedTaps: true, child: MyDemoPage(), ); } ``` The `IgnoreKeyboardDismiss` `Widget` can be used to further refine which taps do and do not dismiss the keyboard. Checkout the example app for more detail. ## Testing ### Testing using mocks `KeyboardVisibilityProvider` and `KeyboardVisibilityBuilder` accept a `controller` parameter that allow you to mock or replace the logic for reporting keyboard visibility updates. ```dart @GenerateMocks([KeyboardVisibilityController]) void main() { testWidgets('It reports true when the keyboard is visible', (WidgetTester tester) async { // Pretend that the keyboard is visible. var mockController = MockKeyboardVisibilityController(); when(mockController.onChange) .thenAnswer((_) => Stream.fromIterable([true])); when(mockController.isVisible).thenAnswer((_) => true); // Build a Widget tree and query KeyboardVisibilityProvider // for the visibility of the keyboard. bool? isKeyboardVisible; await tester.pumpWidget( KeyboardVisibilityProvider( controller: mockController, child: Builder( builder: (BuildContext context) { isKeyboardVisible = KeyboardVisibilityProvider.isKeyboardVisible(context); return SizedBox(); }, ), ), ); // Verify that KeyboardVisibilityProvider reported that the // keyboard is visible. expect(isKeyboardVisible, true); }); } ``` ### Testing with a global override Call `KeyboardVisibilityTesting.setVisibilityForTesting(false);` to set a custom value to use during `flutter test`. This is set globally and will override the standard logic of the native platform. ```dart void main() { testWidgets('My Test', (WidgetTester tester) async { KeyboardVisibilityTesting.setVisibilityForTesting(true); await tester.pumpWidget(MyApp()); }); } ``` ", Assign "at most 3 tags" to the expected json: {"id":"13515","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"