[webview_flutter] Implementation of the app facing WebViewWidget for v4 (#6367)

Author: bparrishMines

packages/webview_flutter/webview_flutter/lib/src/v4/src/webview_widget.dart

@@ -0,0 +1,64 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter/cupertino.dart';
+import 'package:flutter/foundation.dart';
+import 'package:flutter/gestures.dart';
+import 'package:webview_flutter_platform_interface/v4/webview_flutter_platform_interface.dart';
+
+import 'webview_controller.dart';
+
+/// Displays a native WebView as a Widget.
+class WebViewWidget extends StatelessWidget {
+  /// Constructs a [WebViewWidget].
+  WebViewWidget({
+    Key? key,
+    required WebViewController controller,
+    TextDirection layoutDirection = TextDirection.ltr,
+    Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers =
+        const <Factory<OneSequenceGestureRecognizer>>{},
+  }) : this.fromPlatformCreationParams(
+          key: key,
+          params: PlatformWebViewWidgetCreationParams(
+            controller: controller.platform,
+            layoutDirection: layoutDirection,
+            gestureRecognizers: gestureRecognizers,
+          ),
+        );
+
+  /// Constructs a [WebViewWidget] from creation params for a specific
+  /// platform.
+  WebViewWidget.fromPlatformCreationParams({
+    Key? key,
+    required PlatformWebViewWidgetCreationParams params,
+  }) : this.fromPlatform(key: key, platform: PlatformWebViewWidget(params));
+
+  /// Constructs a [WebViewWidget] from a specific platform implementation.
+  WebViewWidget.fromPlatform({Key? key, required this.platform})
+      : super(key: key);
+
+  /// Implementation of [PlatformWebViewWidget] for the current platform.
+  final PlatformWebViewWidget platform;
+
+  /// The layout direction to use for the embedded WebView.
+  late final TextDirection layoutDirection = platform.params.layoutDirection;
+
+  /// Specifies which gestures should be consumed by the web view.
+  ///
+  /// It is possible for other gesture recognizers to be competing with the web
+  /// view on pointer events, e.g if the web view is inside a [ListView] the
+  /// [ListView] will want to handle vertical drags. The web view will claim
+  /// gestures that are recognized by any of the recognizers on this list.
+  ///
+  /// When `gestureRecognizers` is empty (default), the web view will only
+  /// handle pointer events for gestures that were not claimed by any other
+  /// gesture recognizer.
+  late final Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers =
+      platform.params.gestureRecognizers;
+
+  @override
+  Widget build(BuildContext context) {
+    return platform.build(context);
+  }
+}

packages/webview_flutter/webview_flutter/lib/src/v4/webview_flutter.dart

@@ -9,3 +9,4 @@ export 'package:webview_flutter_platform_interface/v4/webview_flutter_platform_i
 
 export 'src/webview_controller.dart';
 export 'src/webview_cookie_manager.dart';
+export 'src/webview_widget.dart';

packages/webview_flutter/webview_flutter/test/v4/webview_widget_test.dart

@@ -0,0 +1,87 @@
+// Copyright 2013 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:flutter/foundation.dart';
+import 'package:flutter/gestures.dart';
+import 'package:flutter/widgets.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:mockito/annotations.dart';
+import 'package:mockito/mockito.dart';
+import 'package:webview_flutter/src/v4/webview_flutter.dart';
+import 'package:webview_flutter_platform_interface/v4/webview_flutter_platform_interface.dart';
+
+import 'webview_widget_test.mocks.dart';
+
+@GenerateMocks(<Type>[PlatformWebViewController, PlatformWebViewWidget])
+void main() {
+  TestWidgetsFlutterBinding.ensureInitialized();
+
+  group('WebViewWidget', () {
+    testWidgets('build', (WidgetTester tester) async {
+      final MockPlatformWebViewWidget mockPlatformWebViewWidget =
+          MockPlatformWebViewWidget();
+      when(mockPlatformWebViewWidget.build(any)).thenReturn(Container());
+
+      await tester.pumpWidget(WebViewWidget.fromPlatform(
+        platform: mockPlatformWebViewWidget,
+      ));
+
+      expect(find.byType(Container), findsOneWidget);
+    });
+
+    testWidgets(
+        'constructor parameters are correctly passed to creation params',
+        (WidgetTester tester) async {
+      WebViewPlatform.instance = TestWebViewPlatform();
+
+      final MockPlatformWebViewController mockPlatformWebViewController =
+          MockPlatformWebViewController();
+      final WebViewController webViewController =
+          WebViewController.fromPlatform(
+        mockPlatformWebViewController,
+      );
+
+      final WebViewWidget webViewWidget = WebViewWidget(
+        key: GlobalKey(),
+        controller: webViewController,
+        layoutDirection: TextDirection.rtl,
+        gestureRecognizers: <Factory<OneSequenceGestureRecognizer>>{
+          Factory<OneSequenceGestureRecognizer>(() => EagerGestureRecognizer()),
+        },
+      );
+
+      // The key passed to the default constructor is used by the super class
+      // and not passed to the platform implementation.
+      expect(webViewWidget.platform.params.key, isNull);
+      expect(
+        webViewWidget.platform.params.controller,
+        webViewController.platform,
+      );
+      expect(webViewWidget.platform.params.layoutDirection, TextDirection.rtl);
+      expect(
+        webViewWidget.platform.params.gestureRecognizers.isNotEmpty,
+        isTrue,
+      );
+    });
+  });
+}
+
+class TestWebViewPlatform extends WebViewPlatform {
+  @override
+  PlatformWebViewWidget createPlatformWebViewWidget(
+    PlatformWebViewWidgetCreationParams params,
+  ) {
+    return TestPlatformWebViewWidget(params);
+  }
+}
+
+class TestPlatformWebViewWidget extends PlatformWebViewWidget {
+  TestPlatformWebViewWidget(PlatformWebViewWidgetCreationParams params)
+      : super.implementation(params);
+
+  @override
+  Widget build(BuildContext context) {
+    throw UnimplementedError();
+  }
+}