4.0.0 (#47)

* move away from statics

* docs

* use handler

* update tests

* tests update

* publish interface

* publish web

* updated docs

* docs for platform interface

* Documentation updates for web

* bump

* minor

* minor

* update readme

* update

Author: MisterJimson

README.md

@@ -7,7 +7,7 @@ React to keyboard visibility changes.
 Add the dependency to your pubspec.yaml
 ```yaml
 dependencies:
-  flutter_keyboard_visibility: ^3.3.0
+  flutter_keyboard_visibility: ^4.0.0
 ```
 ## Usage: React to Keyboard Visibility Changes
 ### Option 1: Within your `Widget` tree using a builder
@@ -54,19 +54,21 @@ Widget build(BuildContext context) {
 ### Option 3: Direct query and subscription
 
 Query and/or subscribe to keyboard visibility directly with the  
-`KeyboardVisibility` class.
+`KeyboardVisibilityController` class.
 
 ```dart
 import 'package:flutter_keyboard_visibility/flutter_keyboard_visibility.dart';
 
 @override
 void initState() {
   super.initState();
+
+  var keyboardVisibilityController = KeyboardVisibilityController();
   // Query
-  print('Keyboard visibility direct query: ${KeyboardVisibility.isVisible}');
+  print('Keyboard visibility direct query: ${keyboardVisibilityController.isVisible}');
   
   // Subscribe
-  KeyboardVisibility.onChange.listen((bool visible) {
+  keyboardVisibilityController.listen((bool visible) {
     print('Keyboard visibility update. Is visible: ${visible}');
   });
 }

flutter_keyboard_visibility/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [4.0.1] - November 23, 2020
+
+* Update documentation
+
+## [4.0.0] - November 23, 2020
+
+* Federated the plugin to better support more platforms going forward
+* Refactored internal implementation
+* Deprecated KeyboardVisibility static access, will be removed in a future release
+* Added KeyboardVisibilityController as a new way to access keyboard visibility
+* KeyboardVisibilityBuilder & KeyboardVisibilityProvider now have `controller` parameters that allow
+you to pass a mock implementation of KeyboardVisibilityController for testing.
+
 ## [3.3.0] - November 6, 2020
 
 Thanks to lukepighetti for this feature

flutter_keyboard_visibility/README.md

@@ -7,7 +7,7 @@ React to keyboard visibility changes.
 Add the dependency to your pubspec.yaml
 ```yaml
 dependencies:
-  flutter_keyboard_visibility: ^3.3.0
+  flutter_keyboard_visibility: ^4.0.0
 ```
 ## Usage: React to Keyboard Visibility Changes
 ### Option 1: Within your `Widget` tree using a builder
@@ -53,20 +53,22 @@ Widget build(BuildContext context) {
 
 ### Option 3: Direct query and subscription
 
-Query and/or subscribe to keyboard visibility directly with the  
-`KeyboardVisibility` class.
+Query and/or subscribe to keyboard visibility directly with the
+`KeyboardVisibilityController` class.
 
 ```dart
 import 'package:flutter_keyboard_visibility/flutter_keyboard_visibility.dart';
 
 @override
 void initState() {
   super.initState();
+
+  var keyboardVisibilityController = KeyboardVisibilityController();
   // Query
-  print('Keyboard visibility direct query: ${KeyboardVisibility.isVisible}');
-  
+  print('Keyboard visibility direct query: ${keyboardVisibilityController.isVisible}');
+
   // Subscribe
-  KeyboardVisibility.onChange.listen((bool visible) {
+  keyboardVisibilityController.listen((bool visible) {
     print('Keyboard visibility update. Is visible: ${visible}');
   });
 }

flutter_keyboard_visibility/example/test/widget_test.dart

@@ -3,6 +3,8 @@ import 'package:flutter_test/flutter_test.dart';
 
 import 'package:flutter_keyboard_visibility_example/main.dart';
 
+// ignore_for_file: deprecated_member_use
+
 /// If [KeyboardVisibility.setVisibilityForTesting] is set we should not see
 /// a MissingPluginException logged
 void main() {

flutter_keyboard_visibility/example_old/test/widget_test.dart

@@ -3,6 +3,8 @@ import 'package:flutter_test/flutter_test.dart';
 
 import 'package:example_old/main.dart';
 
+// ignore_for_file: deprecated_member_use
+
 /// If [KeyboardVisibility.setVisibilityForTesting] is set we should not see
 /// a MissingPluginException logged
 void main() {

flutter_keyboard_visibility/lib/flutter_keyboard_visibility.dart

@@ -1,6 +1,7 @@
 library flutter_keyboard_visibility;
 
 export 'package:flutter_keyboard_visibility/src/keyboard_visibility.dart';
+export 'package:flutter_keyboard_visibility/src/keyboard_visibility_controller.dart';
 export 'package:flutter_keyboard_visibility/src/ui/keyboard_visibility_provider.dart';
 export 'package:flutter_keyboard_visibility/src/ui/keyboard_visibility_builder.dart';
 export 'package:flutter_keyboard_visibility/src/ui/keyboard_dismiss_on_tap.dart';

flutter_keyboard_visibility/lib/src/keyboard_visibility.dart

@@ -1,53 +1,34 @@
 import 'dart:async';
+import 'package:flutter_keyboard_visibility/src/keyboard_visibility_handler.dart';
 import 'package:meta/meta.dart';
-import 'package:flutter_keyboard_visibility_platform_interface/flutter_keyboard_visibility_platform_interface.dart';
 
 /// Provides access to the current keyboard visibility state and emits
 /// changes as they happen.
+@Deprecated(
+    'Use KeyboardVisibilityController instead. Will be removed in a future release.')
 class KeyboardVisibility {
   KeyboardVisibility._();
 
-  static FlutterKeyboardVisibilityPlatform get _platform =>
-      FlutterKeyboardVisibilityPlatform.instance;
-
-  static bool _isInitialized = false;
-  static final _onChangeController = StreamController<bool>();
-  static final _onChange = _onChangeController.stream.asBroadcastStream();
-
   /// Emits true every time the keyboard is shown, and false every time the
   /// keyboard is dismissed.
-  static Stream<bool> get onChange {
-    // If _testIsVisible set, don't try to create the EventChannel
-    if (!_isInitialized && _testIsVisible == null) {
-      _platform.onChange.listen(_updateValue);
-      _isInitialized = true;
-    }
-    return _onChange;
-  }
+  @Deprecated(
+      'Use KeyboardVisibilityController instead. Will be removed in a future release.')
+  static Stream<bool> get onChange => KeyboardVisibilityHandler.onChange;
 
   /// Returns true if the keyboard is currently visible, false if not.
-  static bool get isVisible => _testIsVisible ?? _isVisible;
-  static bool _isVisible = false;
-
-  /// Fake representation of whether or not the keyboard is visible
-  /// for testing purposes. When this value is non-null, it will be
-  /// reported exclusively by the `isVisible` getter.
-  static bool _testIsVisible;
+  @Deprecated(
+      'Use KeyboardVisibilityController instead. Will be removed in a future release.')
+  static bool get isVisible => KeyboardVisibilityHandler.isVisible;
 
   /// Forces `KeyboardVisibility` to report `isKeyboardVisible`
   /// for testing purposes.
   ///
   /// `KeyboardVisibility` will continue reporting `isKeyboardVisible`
   /// until the value is changed again with this method. To stop
   /// using fake values altogether, set `isKeyboardVisible` to null.
+  @Deprecated(
+      'Mock KeyboardVisibilityController instead. Will be removed in a future release.')
   @visibleForTesting
-  static void setVisibilityForTesting(bool isKeyboardVisible) {
-    _updateValue(isKeyboardVisible);
-  }
-
-  static void _updateValue(bool newValue) {
-    _isVisible = newValue;
-    _testIsVisible = newValue;
-    _onChangeController.add(newValue);
-  }
+  static void setVisibilityForTesting(bool isKeyboardVisible) =>
+      KeyboardVisibilityHandler.setVisibilityForTesting(isKeyboardVisible);
 }

flutter_keyboard_visibility/lib/src/keyboard_visibility_controller.dart

@@ -0,0 +1,24 @@
+import 'package:flutter_keyboard_visibility/src/keyboard_visibility_handler.dart';
+
+/// Provides direct information about keyboard visibility and allows you
+/// to subscribe to changes.
+class KeyboardVisibilityController {
+  /// Constructs a singleton instance of [KeyboardVisibilityController].
+  ///
+  /// [KeyboardVisibilityController] is designed to work as a singleton.
+  // When a second instance is created, the first instance will not be able to listen to the
+  // EventChannel because it is overridden. Forcing the class to be a singleton class can prevent
+  // misuse of creating a second instance from a programmer.
+  factory KeyboardVisibilityController() {
+    _instance ??= KeyboardVisibilityController._();
+    return _instance;
+  }
+
+  KeyboardVisibilityController._();
+
+  static KeyboardVisibilityController _instance;
+
+  Stream<bool> get onChange => KeyboardVisibilityHandler.onChange;
+
+  bool get isVisible => KeyboardVisibilityHandler.isVisible;
+}

flutter_keyboard_visibility/lib/src/keyboard_visibility_handler.dart

@@ -0,0 +1,51 @@
+import 'dart:async';
+import 'package:flutter_keyboard_visibility_platform_interface/flutter_keyboard_visibility_platform_interface.dart';
+
+/// Provides access to the current keyboard visibility state and emits
+/// changes as they happen. For internal use only.
+class KeyboardVisibilityHandler {
+  KeyboardVisibilityHandler._();
+
+  static FlutterKeyboardVisibilityPlatform get _platform =>
+      FlutterKeyboardVisibilityPlatform.instance;
+
+  static bool _isInitialized = false;
+  static final _onChangeController = StreamController<bool>();
+  static final _onChange = _onChangeController.stream.asBroadcastStream();
+
+  /// Emits true every time the keyboard is shown, and false every time the
+  /// keyboard is dismissed.
+  static Stream<bool> get onChange {
+    // If _testIsVisible set, don't try to create the EventChannel
+    if (!_isInitialized && _testIsVisible == null) {
+      _platform.onChange.listen(_updateValue);
+      _isInitialized = true;
+    }
+    return _onChange;
+  }
+
+  /// Returns true if the keyboard is currently visible, false if not.
+  static bool get isVisible => _testIsVisible ?? _isVisible;
+  static bool _isVisible = false;
+
+  /// Fake representation of whether or not the keyboard is visible
+  /// for testing purposes. When this value is non-null, it will be
+  /// reported exclusively by the `isVisible` getter.
+  static bool _testIsVisible;
+
+  /// Forces `KeyboardVisibility` to report `isKeyboardVisible`
+  /// for testing purposes.
+  ///
+  /// `KeyboardVisibility` will continue reporting `isKeyboardVisible`
+  /// until the value is changed again with this method. To stop
+  /// using fake values altogether, set `isKeyboardVisible` to null.
+  static void setVisibilityForTesting(bool isKeyboardVisible) {
+    _updateValue(isKeyboardVisible);
+  }
+
+  static void _updateValue(bool newValue) {
+    _isVisible = newValue;
+    _testIsVisible = newValue;
+    _onChangeController.add(newValue);
+  }
+}

flutter_keyboard_visibility/lib/src/ui/keyboard_visibility_builder.dart

@@ -1,18 +1,27 @@
 import 'package:flutter/widgets.dart';
-import 'package:flutter_keyboard_visibility/src/keyboard_visibility.dart';
+import 'package:flutter_keyboard_visibility/src/keyboard_visibility_controller.dart';
 
 /// A convenience builder that exposes if the native keyboard is visible.
 class KeyboardVisibilityBuilder extends StatelessWidget {
-  const KeyboardVisibilityBuilder({Key key, this.builder}) : super(key: key);
+  /// Optional: pass in a controller you already have created. This is useful
+  /// for testing, as you can pass in a mock instance. If no controller is
+  /// passed in, one will be created automatically.
+  final KeyboardVisibilityController controller;
+
+  KeyboardVisibilityController get _controller =>
+      controller ?? KeyboardVisibilityController();
+
+  const KeyboardVisibilityBuilder({Key key, this.builder, this.controller})
+      : super(key: key);
 
   /// A builder method that exposes if the native keyboard is visible.
   final Widget Function(BuildContext, bool isKeyboardVisible) builder;
 
   @override
   Widget build(BuildContext context) {
     return StreamBuilder<bool>(
-      stream: KeyboardVisibility.onChange,
-      initialData: KeyboardVisibility.isVisible,
+      stream: _controller.onChange,
+      initialData: _controller.isVisible,
       builder: (context, snapshot) {
         final isKeyboardVisible = snapshot.data;
 

flutter_keyboard_visibility/lib/src/ui/keyboard_visibility_provider.dart

@@ -1,6 +1,6 @@
 import 'dart:async';
 import 'package:flutter/widgets.dart';
-import 'package:flutter_keyboard_visibility/src/keyboard_visibility.dart';
+import 'package:flutter_keyboard_visibility/src/keyboard_visibility_controller.dart';
 
 /// Widget that reports to its descendants whether or not
 /// the keyboard is currently visible.
@@ -16,14 +16,30 @@ import 'package:flutter_keyboard_visibility/src/keyboard_visibility.dart';
 /// return KeyboardVisibilityProvider(
 ///   child: Builder(
 ///     builder: (BuildContext context) {
-///       final bool isKeyboardVisible = KeyboarVisibilityProvider.isKeyboardVisible(context);
+///       final bool isKeyboardVisible = KeyboardVisibilityProvider.isKeyboardVisible(context);
 ///
 ///       return Text('Keyboard is visible: $isKeyboardVisible');
 ///     },
 ///   ),
 /// );
 /// ```
 class KeyboardVisibilityProvider extends StatefulWidget {
+  final Widget child;
+
+  /// Optional: pass in a controller you already have created. This is useful
+  /// for testing, as you can pass in a mock instance. If no controller is
+  /// passed in, one will be created automatically.
+  final KeyboardVisibilityController controller;
+
+  KeyboardVisibilityController get _controller =>
+      controller ?? KeyboardVisibilityController();
+
+  const KeyboardVisibilityProvider({
+    Key key,
+    this.child,
+    this.controller,
+  }) : super(key: key);
+
   /// Returns `true` if the keyboard is currently visible, `false`
   /// if the keyboard is not currently visible, or `null` if
   /// the `flutter_keyboard_visibility` plugin does not yet
@@ -39,13 +55,6 @@ class KeyboardVisibilityProvider extends StatefulWidget {
         .isKeyboardVisible;
   }
 
-  const KeyboardVisibilityProvider({
-    Key key,
-    this.child,
-  }) : super(key: key);
-
-  final Widget child;
-
   @override
   _KeyboardVisibilityProviderState createState() =>
       _KeyboardVisibilityProviderState();
@@ -59,9 +68,9 @@ class _KeyboardVisibilityProviderState
   @override
   void initState() {
     super.initState();
-    _isKeyboardVisible = KeyboardVisibility.isVisible;
+    _isKeyboardVisible = widget._controller.isVisible;
     _subscription =
-        KeyboardVisibility.onChange.listen(_onKeyboardVisibilityChange);
+        widget._controller.onChange.listen(_onKeyboardVisibilityChange);
   }
 
   void _onKeyboardVisibilityChange(bool isKeyboardVisible) {

flutter_keyboard_visibility/pubspec.yaml

@@ -1,22 +1,22 @@
 name: flutter_keyboard_visibility
 description: Flutter plugin for discovering the state of the soft-keyboard visibility on Android and iOS.
-version: 4.0.0
+version: 4.0.1
 homepage: https://github.com/MisterJimson/flutter_keyboard_visibility
+repository: https://github.com/MisterJimson/flutter_keyboard_visibility
 
 environment:
   sdk: ">=2.1.0 <3.0.0"
-  flutter: ">=1.12.13+hotfix.6"
+  flutter: ">=1.20.0"
 
 dependencies:
-  meta: any
-  flutter_keyboard_visibility_platform_interface:
-    path: ../flutter_keyboard_visibility_platform_interface
-  flutter_keyboard_visibility_web:
-    path: ../flutter_keyboard_visibility_web
+  meta: ">=1.0.0 <2.0.0"
+  flutter_keyboard_visibility_platform_interface: ^1.0.1
+  flutter_keyboard_visibility_web: ^1.0.1
   flutter:
     sdk: flutter
 
 dev_dependencies:
+  mockito: ^4.1.3
   pedantic: 1.9.0
   flutter_test:
     sdk: flutter