[webview_flutter] Expose the allowsLinkPreview property in WKWebView for iOS

packages/webview_flutter/webview_flutter/CHANGELOG.md

@@ -1,5 +1,6 @@
-## NEXT
+## 3.0.5
 
+* Adds support for the `allowsLinkPreview` property on iOS.
 * Updates minimum Flutter version to 2.10.
 * Fixes avoid_redundant_argument_values lint warnings and minor typos.
 * Ignores unnecessary import warnings in preparation for [upcoming Flutter changes](https://github.com/flutter/flutter/pull/104231).

packages/webview_flutter/webview_flutter/example/pubspec.yaml

@@ -18,6 +18,15 @@ dependencies:
     # the parent directory to use the current plugin's version.
     path: ../
 
+# FOR TESTING ONLY. DO NOT MERGE.
+dependency_overrides:
+  webview_flutter_android:
+    path: ../../webview_flutter_android
+  webview_flutter_platform_interface:
+    path: ../../webview_flutter_platform_interface
+  webview_flutter_wkwebview:
+    path: ../../webview_flutter_wkwebview
+
 dev_dependencies:
   espresso: ^0.1.0+2
   flutter_driver:

packages/webview_flutter/webview_flutter/lib/src/webview.dart

@@ -90,6 +90,7 @@ class WebView extends StatefulWidget {
     this.onWebResourceError,
     this.debuggingEnabled = false,
     this.gestureNavigationEnabled = false,
+    this.allowsLinkPreview = true,
     this.userAgent,
     this.zoomEnabled = true,
     this.initialMediaPlaybackPolicy =
@@ -260,6 +261,13 @@ class WebView extends StatefulWidget {
   /// By default `gestureNavigationEnabled` is false.
   final bool gestureNavigationEnabled;
 
+  /// Whether pressing a link displays a preview of the destination for the link.
+  ///
+  /// Not supported on all platforms.
+  ///
+  /// By default `allowsLinkPreview` is true.
+  final bool allowsLinkPreview;
+
   /// The value used for the HTTP User-Agent: request header.
   ///
   /// When null the platform's webview default is used for the User-Agent header.
@@ -380,6 +388,7 @@ WebSettings _webSettingsFromWidget(WebView widget) {
     hasProgressTracking: widget.onProgress != null,
     debuggingEnabled: widget.debuggingEnabled,
     gestureNavigationEnabled: widget.gestureNavigationEnabled,
+    allowsLinkPreview: widget.allowsLinkPreview,
     allowsInlineMediaPlayback: widget.allowsInlineMediaPlayback,
     userAgent: WebSetting<String?>.of(widget.userAgent),
     zoomEnabled: widget.zoomEnabled,
@@ -399,13 +408,16 @@ WebSettings _clearUnchangedWebSettings(
   assert(newValue.debuggingEnabled != null);
   assert(newValue.userAgent != null);
   assert(newValue.zoomEnabled != null);
+  assert(newValue.allowsLinkPreview != null);
 
   JavascriptMode? javascriptMode;
   bool? hasNavigationDelegate;
   bool? hasProgressTracking;
   bool? debuggingEnabled;
   WebSetting<String?> userAgent = const WebSetting<String?>.absent();
   bool? zoomEnabled;
+  bool? allowsLinkPreview;
+
   if (currentValue.javascriptMode != newValue.javascriptMode) {
     javascriptMode = newValue.javascriptMode;
   }
@@ -424,6 +436,9 @@ WebSettings _clearUnchangedWebSettings(
   if (currentValue.zoomEnabled != newValue.zoomEnabled) {
     zoomEnabled = newValue.zoomEnabled;
   }
+  if (currentValue.allowsLinkPreview != newValue.allowsLinkPreview) {
+    allowsLinkPreview = newValue.allowsLinkPreview;
+  }
 
   return WebSettings(
     javascriptMode: javascriptMode,
@@ -432,6 +447,7 @@ WebSettings _clearUnchangedWebSettings(
     debuggingEnabled: debuggingEnabled,
     userAgent: userAgent,
     zoomEnabled: zoomEnabled,
+    allowsLinkPreview: allowsLinkPreview,
   );
 }
 

packages/webview_flutter/webview_flutter/pubspec.yaml

@@ -2,7 +2,7 @@ name: webview_flutter
 description: A Flutter plugin that provides a WebView widget on Android and iOS.
 repository: https://github.com/flutter/plugins/tree/main/packages/webview_flutter/webview_flutter
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+webview%22
-version: 3.0.4
+version: 3.0.5
 
 environment:
   sdk: ">=2.14.0 <3.0.0"
@@ -23,6 +23,15 @@ dependencies:
   webview_flutter_platform_interface: ^1.9.3
   webview_flutter_wkwebview: ^2.7.0
 
+# FOR TESTING ONLY. DO NOT MERGE.
+dependency_overrides:
+  webview_flutter_android:
+    path: ../webview_flutter_android
+  webview_flutter_platform_interface:
+    path: ../webview_flutter_platform_interface
+  webview_flutter_wkwebview:
+    path: ../webview_flutter_wkwebview
+
 dev_dependencies:
   build_runner: ^2.1.5
   flutter_driver:

packages/webview_flutter/webview_flutter/test/webview_flutter_test.dart

@@ -1114,6 +1114,58 @@ void main() {
     });
   });
 
+  group('allowsLinkPreview', () {
+    testWidgets('defaults to true', (WidgetTester tester) async {
+      await tester.pumpWidget(const WebView());
+
+      final CreationParams params = captureBuildArgs(
+        mockWebViewPlatform,
+        creationParams: true,
+      ).single as CreationParams;
+
+      expect(params.webSettings!.allowsLinkPreview, true);
+    });
+
+    testWidgets('can be disabled', (WidgetTester tester) async {
+      await tester.pumpWidget(const WebView(
+        allowsLinkPreview: false,
+      ));
+
+      final CreationParams params = captureBuildArgs(
+        mockWebViewPlatform,
+        creationParams: true,
+      ).single as CreationParams;
+
+      expect(params.webSettings!.allowsLinkPreview, false);
+    });
+
+    testWidgets('can be changed', (WidgetTester tester) async {
+      final GlobalKey key = GlobalKey();
+      await tester.pumpWidget(WebView(key: key));
+
+      await tester.pumpWidget(WebView(
+        key: key,
+        allowsLinkPreview: false,
+      ));
+
+      final WebSettings enabledSettings =
+          verify(mockWebViewPlatformController.updateSettings(captureAny))
+              .captured
+              .last as WebSettings;
+      expect(enabledSettings.allowsLinkPreview, false);
+
+      await tester.pumpWidget(WebView(
+        key: key,
+      ));
+
+      final WebSettings disabledSettings =
+          verify(mockWebViewPlatformController.updateSettings(captureAny))
+              .captured
+              .last as WebSettings;
+      expect(disabledSettings.allowsLinkPreview, true);
+    });
+  });
+
   group('Custom platform implementation', () {
     setUp(() {
       WebView.platform = MyWebViewPlatform();
@@ -1143,6 +1195,7 @@ void main() {
               debuggingEnabled: false,
               userAgent: const WebSetting<String?>.of(null),
               gestureNavigationEnabled: true,
+              allowsLinkPreview: true,
               zoomEnabled: true,
             ),
           )));
@@ -1325,6 +1378,7 @@ class MatchesWebSettings extends Matcher {
         _webSettings!.debuggingEnabled == webSettings.debuggingEnabled &&
         _webSettings!.gestureNavigationEnabled ==
             webSettings.gestureNavigationEnabled &&
+        _webSettings!.allowsLinkPreview == webSettings.allowsLinkPreview &&
         _webSettings!.userAgent == webSettings.userAgent &&
         _webSettings!.zoomEnabled == webSettings.zoomEnabled;
   }

packages/webview_flutter/webview_flutter_platform_interface/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.9.4
+
+* Adds support for the `allowsLinkPreview` property on iOS.
+
 ## 1.9.3
 
 * Updates minimum Flutter version to 2.10.

packages/webview_flutter/webview_flutter_platform_interface/lib/src/types/web_settings.dart

@@ -82,6 +82,7 @@ class WebSettings {
     this.hasProgressTracking,
     this.debuggingEnabled,
     this.gestureNavigationEnabled,
+    this.allowsLinkPreview,
     this.allowsInlineMediaPlayback,
     this.zoomEnabled,
     required this.userAgent,
@@ -125,8 +126,13 @@ class WebSettings {
   /// See also: [WebView.gestureNavigationEnabled]
   final bool? gestureNavigationEnabled;
 
+  /// Determines whether pressing a link displays a preview of the destination for the link in iOS.
+  ///
+  /// See also: [WebView.allowsLinkPreview]
+  final bool? allowsLinkPreview;
+
   @override
   String toString() {
-    return 'WebSettings(javascriptMode: $javascriptMode, hasNavigationDelegate: $hasNavigationDelegate, hasProgressTracking: $hasProgressTracking, debuggingEnabled: $debuggingEnabled, gestureNavigationEnabled: $gestureNavigationEnabled, userAgent: $userAgent, allowsInlineMediaPlayback: $allowsInlineMediaPlayback)';
+    return 'WebSettings(javascriptMode: $javascriptMode, hasNavigationDelegate: $hasNavigationDelegate, hasProgressTracking: $hasProgressTracking, debuggingEnabled: $debuggingEnabled, gestureNavigationEnabled: $gestureNavigationEnabled, allowsLinkPreview: $allowsLinkPreview, userAgent: $userAgent, allowsInlineMediaPlayback: $allowsInlineMediaPlayback)';
   }
 }

packages/webview_flutter/webview_flutter_platform_interface/pubspec.yaml

@@ -4,7 +4,7 @@ repository: https://github.com/flutter/plugins/tree/main/packages/webview_flutte
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+webview_flutter%22
 # NOTE: We strongly prefer non-breaking changes, even at the expense of a
 # less-clean API. See https://flutter.dev/go/platform-interface-breaking-changes
-version: 1.9.3
+version: 1.9.4
 
 environment:
   sdk: ">=2.12.0 <3.0.0"

packages/webview_flutter/webview_flutter_wkwebview/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## 2.9.4
 
+* Adds support for the `allowsLinkPreview` property on iOS.
 * Fixes avoid_redundant_argument_values lint warnings and minor typos.
 * Fixes typo in an internal method name, from `setCookieForInsances` to `setCookieForInstances`.
 

packages/webview_flutter/webview_flutter_wkwebview/example/ios/RunnerTests/FWFWebViewHostApiTests.m

@@ -346,6 +346,22 @@ - (void)testSetAllowsBackForwardNavigationGestures {
   XCTAssertNil(error);
 }
 
+- (void)testSetAllowsLinkPreview {
+  FWFWebView *mockWebView = OCMClassMock([FWFWebView class]);
+
+  FWFInstanceManager *instanceManager = [[FWFInstanceManager alloc] init];
+  [instanceManager addDartCreatedInstance:mockWebView withIdentifier:0];
+
+  FWFWebViewHostApiImpl *hostAPI = [[FWFWebViewHostApiImpl alloc]
+      initWithBinaryMessenger:OCMProtocolMock(@protocol(FlutterBinaryMessenger))
+              instanceManager:instanceManager];
+
+  FlutterError *error;
+  [hostAPI setAllowsLinkPreviewForWebViewWithIdentifier:@0 isAllowed:@NO error:&error];
+  OCMVerify([mockWebView setAllowsLinkPreview:NO]);
+  XCTAssertNil(error);
+}
+
 - (void)testEvaluateJavaScript {
   FWFWebView *mockWebView = OCMClassMock([FWFWebView class]);
 

packages/webview_flutter/webview_flutter_wkwebview/example/lib/web_view.dart

@@ -66,6 +66,7 @@ class WebView extends StatefulWidget {
     this.onWebResourceError,
     this.debuggingEnabled = false,
     this.gestureNavigationEnabled = false,
+    this.allowsLinkPreview = true,
     this.userAgent,
     this.zoomEnabled = true,
     this.initialMediaPlaybackPolicy =
@@ -206,6 +207,13 @@ class WebView extends StatefulWidget {
   /// By default `gestureNavigationEnabled` is false.
   final bool gestureNavigationEnabled;
 
+  /// Whether pressing a link displays a preview of the destination for the link.
+  ///
+  /// Not supported on all platforms.
+  ///
+  /// By default `allowsLinkPreview` is true, to match the default on iOS.
+  final bool allowsLinkPreview;
+
   /// The value used for the HTTP User-Agent: request header.
   ///
   /// When null the platform's webview default is used for the User-Agent header.
@@ -622,6 +630,7 @@ WebSettings _webSettingsFromWidget(WebView widget) {
     hasProgressTracking: widget.onProgress != null,
     debuggingEnabled: widget.debuggingEnabled,
     gestureNavigationEnabled: widget.gestureNavigationEnabled,
+    allowsLinkPreview: widget.allowsLinkPreview,
     allowsInlineMediaPlayback: widget.allowsInlineMediaPlayback,
     userAgent: WebSetting<String?>.of(widget.userAgent),
     zoomEnabled: widget.zoomEnabled,

packages/webview_flutter/webview_flutter_wkwebview/example/pubspec.yaml

@@ -19,6 +19,11 @@ dependencies:
     # the parent directory to use the current plugin's version.
     path: ../
 
+# FOR TESTING ONLY. DO NOT MERGE.
+dependency_overrides:
+  webview_flutter_platform_interface:
+    path: ../../webview_flutter_platform_interface
+
 dev_dependencies:
   espresso: ^0.1.0+2
   flutter_driver:

packages/webview_flutter/webview_flutter_wkwebview/ios/Classes/FWFGeneratedWebKitApis.h

@@ -1,7 +1,7 @@
 // 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.
-// Autogenerated from Pigeon (v3.1.5), do not edit directly.
+// Autogenerated from Pigeon (v3.2.6), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 #import <Foundation/Foundation.h>
 @protocol FlutterBinaryMessenger;
@@ -506,6 +506,9 @@ NSObject<FlutterMessageCodec> *FWFWKWebViewHostApiGetCodec(void);
 - (void)setAllowsBackForwardForWebViewWithIdentifier:(NSNumber *)identifier
                                            isAllowed:(NSNumber *)allow
                                                error:(FlutterError *_Nullable *_Nonnull)error;
+- (void)setAllowsLinkPreviewForWebViewWithIdentifier:(NSNumber *)identifier
+                                           isAllowed:(NSNumber *)allow
+                                               error:(FlutterError *_Nullable *_Nonnull)error;
 - (void)setUserAgentForWebViewWithIdentifier:(NSNumber *)identifier
                                    userAgent:(nullable NSString *)userAgent
                                        error:(FlutterError *_Nullable *_Nonnull)error;

packages/webview_flutter/webview_flutter_wkwebview/ios/Classes/FWFGeneratedWebKitApis.m

@@ -1,7 +1,7 @@
 // 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.
-// Autogenerated from Pigeon (v3.1.5), do not edit directly.
+// Autogenerated from Pigeon (v3.2.6), do not edit directly.
 // See also: https://pub.dev/packages/pigeon
 #import "FWFGeneratedWebKitApis.h"
 #import <Flutter/Flutter.h>
@@ -2502,6 +2502,31 @@ void FWFWKWebViewHostApiSetup(id<FlutterBinaryMessenger> binaryMessenger,
       [channel setMessageHandler:nil];
     }
   }
+  {
+    FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc]
+           initWithName:@"dev.flutter.pigeon.WKWebViewHostApi.setAllowsLinkPreview"
+        binaryMessenger:binaryMessenger
+                  codec:FWFWKWebViewHostApiGetCodec()];
+    if (api) {
+      NSCAssert([api respondsToSelector:@selector
+                     (setAllowsLinkPreviewForWebViewWithIdentifier:isAllowed:error:)],
+                @"FWFWKWebViewHostApi api (%@) doesn't respond to "
+                @"@selector(setAllowsLinkPreviewForWebViewWithIdentifier:isAllowed:error:)",
+                api);
+      [channel setMessageHandler:^(id _Nullable message, FlutterReply callback) {
+        NSArray *args = message;
+        NSNumber *arg_identifier = GetNullableObjectAtIndex(args, 0);
+        NSNumber *arg_allow = GetNullableObjectAtIndex(args, 1);
+        FlutterError *error;
+        [api setAllowsLinkPreviewForWebViewWithIdentifier:arg_identifier
+                                                isAllowed:arg_allow
+                                                    error:&error];
+        callback(wrapResult(nil, error));
+      }];
+    } else {
+      [channel setMessageHandler:nil];
+    }
+  }
   {
     FlutterBasicMessageChannel *channel = [[FlutterBasicMessageChannel alloc]
            initWithName:@"dev.flutter.pigeon.WKWebViewHostApi.setCustomUserAgent"

packages/webview_flutter/webview_flutter_wkwebview/ios/Classes/FWFWebViewHostApi.m

@@ -262,6 +262,14 @@ - (void)reloadWebViewWithIdentifier:(nonnull NSNumber *)identifier
   [[self webViewForIdentifier:identifier] setAllowsBackForwardNavigationGestures:allow.boolValue];
 }
 
+- (void)
+    setAllowsLinkPreviewForWebViewWithIdentifier:(nonnull NSNumber *)identifier
+                                       isAllowed:(nonnull NSNumber *)allow
+                                           error:(FlutterError *_Nullable __autoreleasing *_Nonnull)
+                                                     error {
+  [[self webViewForIdentifier:identifier] setAllowsLinkPreview:allow.boolValue];
+}
+
 - (void)
     setNavigationDelegateForWebViewWithIdentifier:(nonnull NSNumber *)identifier
                                delegateIdentifier:(nullable NSNumber *)navigationDelegateIdentifier
@@ -287,4 +295,5 @@ - (void)setUIDelegateForWebViewWithIdentifier:(nonnull NSNumber *)identifier
                             error:(FlutterError *_Nullable __autoreleasing *_Nonnull)error {
   return [[self webViewForIdentifier:identifier] title];
 }
+
 @end