Flutter Keyboard Visibility

https://pub.dev/packages/flutter_keyboard_visibility
Admin
A Flutter plugin for discovering the state of the soft-keyboard visibility on Android and iOS, with...
Tokens:5,560
Snippets:100
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Example app main.dart using KeyboardVisibilityBuilder and KeyboardDismissOnTap

Source: https://pub.dev/packages/flutter_keyboard_visibility/example

Main entry point for the example app. It sets up a MaterialApp with a Demo screen that uses KeyboardDismissOnTap to dismiss the keyboard on tap, provides buttons to navigate to ProviderDemo and KeyboardDismissDemo, and includes a TextField and a KeyboardVisibilityBuilder that displays whether the keyboard is visible.

```dart
import 'package:flutter/material.dart';
import 'package:flutter_keyboard_visibility/flutter_keyboard_visibility.dart';
import 'package:flutter_keyboard_visibility_example/keyboard_dismiss_demo.dart';
import 'package:flutter_keyboard_visibility_example/provider_demo.dart';

void main() {
  runApp(const App());
}

class App extends StatelessWidget {
  const App({super.key});

  @override
  Widget build(BuildContext context) {
    return const MaterialApp(home: Demo());
  }
}

class Demo extends StatelessWidget {
  const Demo({super.key});

  @override
  Widget build(BuildContext context) {
    return KeyboardDismissOnTap(
      child: Scaffold(
        appBar: AppBar(title: Text('Keyboard Visibility Example')),
        body: Center(
          child: Padding(
            padding: EdgeInsets.all(24.0),
            child: Column(
              mainAxisAlignment: MainAxisAlignment.center,
              children: <Widget>[
                ElevatedButton(
                  onPressed: () {
                    Navigator.push(
                      context,
                      MaterialPageRoute(
                        builder: (context) => const ProviderDemo(),
                      ),
                    );
                  },
                  child: Text('Provider Demo'),
                ),
                ElevatedButton(
                  onPressed: () {
                    Navigator.push(
                      context,
                      MaterialPageRoute(
                        builder: (context) => const KeyboardDismissDemo(),
                      ),
                    );
                  },
                  child: Text('KeyboardDismiss Demo'),
                ),
                Spacer(),
                TextField(
                  keyboardType: TextInputType.text,
                  decoration: InputDecoration(
                    labelText: 'Input box for keyboard test',
                  ),
                ),
                Container(height: 60.0),
                KeyboardVisibilityBuilder(
                  builder: (context, visible) {
                    return Text(
                      'The keyboard is: ${visible ? 'VISIBLE' : 'NOT VISIBLE'}',
                    );
                  },
                ),
                Spacer(),
              ],
            ),
          ),
        ),
      ),
    );
  }
}

```

--------------------------------

### Test keyboard visibility with mocks

Source: https://pub.dev/packages/flutter_keyboard_visibility

Mock KeyboardVisibilityController to test keyboard visibility logic. The example verifies that KeyboardVisibilityProvider reports true when the mocked controller emits true.

```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);
  });
}

```

--------------------------------

### Query and subscribe with KeyboardVisibilityController

Source: https://pub.dev/packages/flutter_keyboard_visibility

Directly query and subscribe to keyboard visibility changes using KeyboardVisibilityController. Query the current state with isVisible and listen to the onChange stream for updates. Remember to cancel the subscription in dispose.

```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();
}

```

--------------------------------

### Provide keyboard visibility with KeyboardVisibilityProvider

Source: https://pub.dev/packages/flutter_keyboard_visibility

Use KeyboardVisibilityProvider to provide keyboard visibility state to the widget tree. Access the current visibility with KeyboardVisibilityProvider.isKeyboardVisible(context) in descendant widgets.

```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'}',
  );
}

```

--------------------------------

### React to keyboard visibility with KeyboardVisibilityBuilder

Source: https://pub.dev/packages/flutter_keyboard_visibility

Use KeyboardVisibilityBuilder to rebuild your widget tree based on keyboard visibility. The builder receives a boolean indicating whether the keyboard is visible, allowing you to conditionally render content.

```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'}',
        );
      }
  );


```

--------------------------------

### Test with global override using setVisibilityForTesting

Source: https://pub.dev/packages/flutter_keyboard_visibility

Use KeyboardVisibilityTesting.setVisibilityForTesting to set a global visibility value during flutter test, overriding the native platform logic.

```dart
void main() {
  testWidgets('My Test', (WidgetTester tester) async {
    KeyboardVisibilityTesting.setVisibilityForTesting(true);
    await tester.pumpWidget(MyApp());
  });
}

```

--------------------------------

### Dismiss keyboard on any tap with dismissOnCapturedTaps

Source: https://pub.dev/packages/flutter_keyboard_visibility

Set dismissOnCapturedTaps to true to dismiss the keyboard for any tap, including taps on interactive widgets like buttons.

```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(),
  );
}

```

--------------------------------

### Dismiss keyboard on tap with KeyboardDismissOnTap

Source: https://pub.dev/packages/flutter_keyboard_visibility

Wrap your widget tree with KeyboardDismissOnTap to dismiss the keyboard when tapping outside the focused widget. By default, taps on interactive widgets like buttons are not captured.

```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(),
  );
}

```
Tokens:
Raw