added ScreenshotConfiguration class and screenshotConfiguration optional...

added ScreenshotConfiguration class and screenshotConfiguration optional argument to takeScreenshot WebView method

CHANGELOG.md

@@ -5,12 +5,14 @@
 - Added `allowUniversalAccessFromFileURLs` and `allowFileAccessFromFileURLs` WebView options also for iOS (also thanks to [liranhao](https://github.com/liranhao))
 - Added limited cookies support on iOS below 11.0 using JavaScript
 - Added `IOSCookieManager` class and `CookieManager.instance().ios.getAllCookies` iOS-specific method
-- Added `UserScript`, `UserScriptInjectionTime`, `ContentWorld`, `AndroidWebViewFeature`, `AndroidServiceWorkerController`, `AndroidServiceWorkerClient` classes
+- Added `UserScript`, `UserScriptInjectionTime`, `ContentWorld`, `AndroidWebViewFeature`, `AndroidServiceWorkerController`, `AndroidServiceWorkerClient`, `ScreenshotConfiguration` classes
 - Added `initialUserScripts` WebView option
 - Added `addUserScript`, `addUserScripts`, `removeUserScript`, `removeUserScripts`, `removeAllUserScripts`, `callAsyncJavaScript` WebView methods
 - Added `contentWorld` argument to `evaluateJavascript` WebView method
 - Added `isDirectionalLockEnabled`, `mediaType`, `pageZoom`, `limitsNavigationsToAppBoundDomains` iOS-specific webview options
 - Added `handlesURLScheme` iOS-specific webview method
+- Added `iosAnimated` optional argument to `zoomBy` WebView method
+- Added `screenshotConfiguration` optional argument to `takeScreenshot` WebView method
 - Updated integration tests
 - Merge "Upgraded appcompat to 1.2.0-rc-02" [#465](https://github.com/pichillilorenzo/flutter_inappwebview/pull/465) (thanks to [andreidiaconu](https://github.com/andreidiaconu))
 - Merge "Added missing field 'headers' which returned by WebResourceResponse.toMap()" [#490](https://github.com/pichillilorenzo/flutter_inappwebview/pull/490) (thanks to [Doflatango](https://github.com/Doflatango))
@@ -41,7 +43,7 @@
 - Removed `debuggingEnabled` WebView option; on Android you should use now the `AndroidInAppWebViewController.setWebContentsDebuggingEnabled(bool debuggingEnabled)` static method; on iOS, debugging is always enabled
 - `allowUniversalAccessFromFileURLs` and `allowFileAccessFromFileURLs` WebView options moved from Android-specific options to cross-platform options
 - Added `callAsyncJavaScript` name to the list of javaScriptHandlerForbiddenNames
-- Added `iosAnimated` optional argument to `zoomBy` WebView method
+- Changed `zoomBy` WebView method signature
 
 ## 4.0.0+4
 

android/src/main/java/com/pichillilorenzo/flutter_inappwebview/InAppWebView/InAppWebView.java

@@ -1132,7 +1132,7 @@ final public class InAppWebView extends InputAwareWebView {
     WebStorage.getInstance().deleteAllData();
   }
 
-  public void takeScreenshot(final MethodChannel.Result result) {
+  public void takeScreenshot(final Map<String, Object> screenshotConfiguration, final MethodChannel.Result result) {
     headlessHandler.post(new Runnable() {
       @Override
       public void run() {
@@ -1156,29 +1156,59 @@ final public class InAppWebView extends InputAwareWebView {
             scrollOffset = 0;
           }
 
-          Bitmap resized = Bitmap.createBitmap(
-                  b, 0, scrollOffset, b.getWidth(), measuredHeight);
+          int rectX = 0;
+          int rectY = scrollOffset;
+          int rectWidth = b.getWidth();
+          int rectHeight = measuredHeight;
+
+          Bitmap resized = Bitmap.createBitmap(b, rectX, rectY, rectWidth, rectHeight);
+
+          Map<String, Double> rect = (Map<String, Double>) screenshotConfiguration.get("rect");
+          if (rect != null) {
+            rectX = (int) Math.floor(rect.get("x") * scale + 0.5);
+            rectY = (int) Math.floor(rect.get("y") * scale + 0.5);
+            rectWidth = Math.min(resized.getWidth(), (int) Math.floor(rect.get("width") * scale + 0.5));
+            rectHeight = Math.min(resized.getHeight(), (int) Math.floor(rect.get("height") * scale + 0.5));
+            resized = Bitmap.createBitmap(
+                    b,
+                    rectX,
+                    rectY,
+                    rectWidth,
+                    rectHeight);
+          }
+
+          Double snapshotWidth = (Double) screenshotConfiguration.get("snapshotWidth");
+          if (snapshotWidth != null) {
+            int dstWidth = (int) Math.floor(snapshotWidth * scale + 0.5);
+            float ratioBitmap = (float) resized.getWidth() / (float) resized.getHeight();
+            int dstHeight = (int) ((float) dstWidth / ratioBitmap);
+            resized = Bitmap.createScaledBitmap(resized, dstWidth, dstHeight, true);
+          }
 
           ByteArrayOutputStream byteArrayOutputStream = new ByteArrayOutputStream();
 
-          resized.compress(Bitmap.CompressFormat.PNG, 100, byteArrayOutputStream);
+          Bitmap.CompressFormat compressFormat = Bitmap.CompressFormat.PNG;
+          try {
+            compressFormat = Bitmap.CompressFormat.valueOf((String) screenshotConfiguration.get("compressFormat"));
+          } catch (IllegalArgumentException e) {
+            e.printStackTrace();
+          }
+
+          resized.compress(
+                  compressFormat,
+                  (Integer) screenshotConfiguration.get("quality"),
+                  byteArrayOutputStream);
+
           try {
             byteArrayOutputStream.close();
           } catch (IOException e) {
             e.printStackTrace();
-            String errorMessage = e.getMessage();
-            if (errorMessage != null) {
-              Log.e(LOG_TAG, errorMessage);
-            }
           }
           resized.recycle();
           result.success(byteArrayOutputStream.toByteArray());
 
         } catch (IllegalArgumentException e) {
-          String errorMessage = e.getMessage();
-          if (errorMessage != null) {
-            Log.e(LOG_TAG, errorMessage);
-          }
+          e.printStackTrace();
           result.success(null);
         }
       }

android/src/main/java/com/pichillilorenzo/flutter_inappwebview/InAppWebViewMethodHandler.java

@@ -140,8 +140,10 @@ public class InAppWebViewMethodHandler implements MethodChannel.MethodCallHandle
         result.success((webView != null) && webView.isLoading());
         break;
       case "takeScreenshot":
-        if (webView != null)
-          webView.takeScreenshot(result);
+        if (webView != null) {
+          Map<String, Object> screenshotConfiguration = (Map<String, Object>) call.argument("screenshotConfiguration");
+          webView.takeScreenshot(screenshotConfiguration, result);
+        }
         else
           result.success(null);
         break;

example/.flutter-plugins-dependencies

-{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"device_info","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/device_info-2.0.0-nullsafety.2/","dependencies":[]},{"name":"flutter_downloader","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/flutter_downloader-1.5.2/","dependencies":[]},{"name":"flutter_inappwebview","path":"/Users/lorenzopichilli/Desktop/flutter_inappwebview/","dependencies":["device_info"]},{"name":"integration_test","path":"/Users/lorenzopichilli/flutter/.pub-cache/git/plugins-16f3281b04b0db12e609352b1c9544901392e428/packages/integration_test/","dependencies":[]},{"name":"path_provider","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/path_provider-1.6.27/","dependencies":[]},{"name":"permission_handler","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/permission_handler-5.0.1+1/","dependencies":[]},{"name":"url_launcher","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/url_launcher-6.0.0-nullsafety.4/","dependencies":[]}],"android":[{"name":"device_info","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/device_info-2.0.0-nullsafety.2/","dependencies":[]},{"name":"flutter_downloader","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/flutter_downloader-1.5.2/","dependencies":[]},{"name":"flutter_inappwebview","path":"/Users/lorenzopichilli/Desktop/flutter_inappwebview/","dependencies":["device_info"]},{"name":"integration_test","path":"/Users/lorenzopichilli/flutter/.pub-cache/git/plugins-16f3281b04b0db12e609352b1c9544901392e428/packages/integration_test/","dependencies":[]},{"name":"path_provider","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/path_provider-1.6.27/","dependencies":[]},{"name":"permission_handler","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/permission_handler-5.0.1+1/","dependencies":[]},{"name":"url_launcher","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/url_launcher-6.0.0-nullsafety.4/","dependencies":[]}],"macos":[{"name":"path_provider_macos","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/path_provider_macos-0.0.4+8/","dependencies":[]},{"name":"url_launcher_macos","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/url_launcher_macos-0.1.0-nullsafety.2/","dependencies":[]}],"linux":[{"name":"path_provider_linux","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/path_provider_linux-0.0.1+2/","dependencies":[]},{"name":"url_launcher_linux","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/url_launcher_linux-0.1.0-nullsafety.3/","dependencies":[]}],"windows":[{"name":"path_provider_windows","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/path_provider_windows-0.0.4+3/","dependencies":[]},{"name":"url_launcher_windows","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/url_launcher_windows-0.1.0-nullsafety.2/","dependencies":[]}],"web":[]},"dependencyGraph":[{"name":"device_info","dependencies":[]},{"name":"flutter_downloader","dependencies":[]},{"name":"flutter_inappwebview","dependencies":["device_info"]},{"name":"integration_test","dependencies":[]},{"name":"path_provider","dependencies":["path_provider_macos","path_provider_linux","path_provider_windows"]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_macos","dependencies":[]},{"name":"path_provider_windows","dependencies":[]},{"name":"permission_handler","dependencies":[]},{"name":"url_launcher","dependencies":["url_launcher_linux","url_launcher_macos","url_launcher_windows"]},{"name":"url_launcher_linux","dependencies":[]},{"name":"url_launcher_macos","dependencies":[]},{"name":"url_launcher_windows","dependencies":[]}],"date_created":"2021-02-07 16:14:15.833284","version":"1.26.0-18.0.pre.90"}
+{"info":"This is a generated file; do not edit or check into version control.","plugins":{"ios":[{"name":"device_info","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/device_info-2.0.0-nullsafety.2/","dependencies":[]},{"name":"flutter_downloader","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/flutter_downloader-1.5.2/","dependencies":[]},{"name":"flutter_inappwebview","path":"/Users/lorenzopichilli/Desktop/flutter_inappwebview/","dependencies":["device_info"]},{"name":"integration_test","path":"/Users/lorenzopichilli/flutter/.pub-cache/git/plugins-16f3281b04b0db12e609352b1c9544901392e428/packages/integration_test/","dependencies":[]},{"name":"path_provider","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/path_provider-1.6.27/","dependencies":[]},{"name":"permission_handler","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/permission_handler-5.0.1+1/","dependencies":[]},{"name":"url_launcher","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/url_launcher-6.0.0-nullsafety.4/","dependencies":[]}],"android":[{"name":"device_info","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/device_info-2.0.0-nullsafety.2/","dependencies":[]},{"name":"flutter_downloader","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/flutter_downloader-1.5.2/","dependencies":[]},{"name":"flutter_inappwebview","path":"/Users/lorenzopichilli/Desktop/flutter_inappwebview/","dependencies":["device_info"]},{"name":"integration_test","path":"/Users/lorenzopichilli/flutter/.pub-cache/git/plugins-16f3281b04b0db12e609352b1c9544901392e428/packages/integration_test/","dependencies":[]},{"name":"path_provider","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/path_provider-1.6.27/","dependencies":[]},{"name":"permission_handler","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/permission_handler-5.0.1+1/","dependencies":[]},{"name":"url_launcher","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/url_launcher-6.0.0-nullsafety.4/","dependencies":[]}],"macos":[{"name":"path_provider_macos","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/path_provider_macos-0.0.4+8/","dependencies":[]},{"name":"url_launcher_macos","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/url_launcher_macos-0.1.0-nullsafety.2/","dependencies":[]}],"linux":[{"name":"path_provider_linux","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/path_provider_linux-0.0.1+2/","dependencies":[]},{"name":"url_launcher_linux","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/url_launcher_linux-0.1.0-nullsafety.3/","dependencies":[]}],"windows":[{"name":"path_provider_windows","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/path_provider_windows-0.0.4+3/","dependencies":[]},{"name":"url_launcher_windows","path":"/Users/lorenzopichilli/flutter/.pub-cache/hosted/pub.dartlang.org/url_launcher_windows-0.1.0-nullsafety.2/","dependencies":[]}],"web":[]},"dependencyGraph":[{"name":"device_info","dependencies":[]},{"name":"flutter_downloader","dependencies":[]},{"name":"flutter_inappwebview","dependencies":["device_info"]},{"name":"integration_test","dependencies":[]},{"name":"path_provider","dependencies":["path_provider_macos","path_provider_linux","path_provider_windows"]},{"name":"path_provider_linux","dependencies":[]},{"name":"path_provider_macos","dependencies":[]},{"name":"path_provider_windows","dependencies":[]},{"name":"permission_handler","dependencies":[]},{"name":"url_launcher","dependencies":["url_launcher_linux","url_launcher_macos","url_launcher_windows"]},{"name":"url_launcher_linux","dependencies":[]},{"name":"url_launcher_macos","dependencies":[]},{"name":"url_launcher_windows","dependencies":[]}],"date_created":"2021-02-08 01:11:20.039088","version":"1.26.0-18.0.pre.90"}
\ No newline at end of file

example/ios/Flutter/Flutter.podspec

-#
-# NOTE: This podspec is NOT to be published. It is only used as a local source!
-#       This is a generated file; do not edit or check into version control.
-#
-
-Pod::Spec.new do |s|
-  s.name             = 'Flutter'
-  s.version          = '1.0.0'
-  s.summary          = 'High-performance, high-fidelity mobile apps.'
-  s.homepage         = 'https://flutter.io'
-  s.license          = { :type => 'MIT' }
-  s.author           = { 'Flutter Dev Team' => 'flutter-dev@googlegroups.com' }
-  s.source           = { :git => 'https://github.com/flutter/engine', :tag => s.version.to_s }
-  s.ios.deployment_target = '8.0'
-  # Framework linking is handled by Flutter tooling, not CocoaPods.
-  # Add a placeholder to satisfy `s.dependency 'Flutter'` plugin podspecs.
-  s.vendored_frameworks = 'path/to/nothing'
-end

example/ios/Flutter/flutter_export_environment.sh

@@ -2,13 +2,12 @@
 # This is a generated file; do not edit or check into version control.
 export "FLUTTER_ROOT=/Users/lorenzopichilli/flutter"
 export "FLUTTER_APPLICATION_PATH=/Users/lorenzopichilli/Desktop/flutter_inappwebview/example"
-export "FLUTTER_TARGET=/Users/lorenzopichilli/Desktop/flutter_inappwebview/example/lib/main.dart"
+export "FLUTTER_TARGET=lib/main.dart"
 export "FLUTTER_BUILD_DIR=build"
 export "SYMROOT=${SOURCE_ROOT}/../build/ios"
 export "FLUTTER_BUILD_NAME=1.0.0"
 export "FLUTTER_BUILD_NUMBER=1"
-export "DART_DEFINES=flutter.inspector.structuredErrors%3Dtrue,FLUTTER_WEB_AUTO_DETECT%3Dtrue"
 export "DART_OBFUSCATION=false"
-export "TRACK_WIDGET_CREATION=true"
+export "TRACK_WIDGET_CREATION=false"
 export "TREE_SHAKE_ICONS=false"
-export "PACKAGE_CONFIG=/Users/lorenzopichilli/Desktop/flutter_inappwebview/example/.dart_tool/package_config.json"
+export "PACKAGE_CONFIG=.packages"

example/lib/in_app_webiew_example.screen.dart

@@ -14,6 +14,8 @@ class InAppWebViewExampleScreen extends StatefulWidget {
 }
 
 class _InAppWebViewExampleScreenState extends State<InAppWebViewExampleScreen> {
+  final GlobalKey webViewKey = GlobalKey();
+
   InAppWebViewController? webView;
   late ContextMenu contextMenu;
   String url = "";
@@ -80,6 +82,7 @@ class _InAppWebViewExampleScreenState extends State<InAppWebViewExampleScreen> {
                   decoration:
                   BoxDecoration(border: Border.all(color: Colors.blueAccent)),
                   child: InAppWebView(
+                    key: webViewKey,
                     // contextMenu: contextMenu,
                     initialUrl: "https://flutter.dev",
                     // initialFile: "assets/index.html",
@@ -135,6 +138,8 @@ class _InAppWebViewExampleScreenState extends State<InAppWebViewExampleScreen> {
                       setState(() {
                         this.url = url ?? '';
                       });
+                      // RenderObject renderBox = webViewKey.currentContext!.findRenderObject()!;
+                      // print(renderBox.paintBounds.size);
                     },
                     onProgressChanged: (controller, progress) {
                       setState(() {

ios/Classes/InAppWebView.swift

@@ -1700,12 +1700,40 @@ public class InAppWebView: WKWebView, UIScrollViewDelegate, WKUIDelegate, WKNavi
             : currentIndex + steps >= 0
     }
     
-    public func takeScreenshot (completionHandler: @escaping (_ screenshot: Data?) -> Void) {
+    public func takeScreenshot (with: [String: Any?]?, completionHandler: @escaping (_ screenshot: Data?) -> Void) {
         if #available(iOS 11.0, *) {
-            takeSnapshot(with: nil, completionHandler: {(image, error) -> Void in
+            var snapshotConfiguration: WKSnapshotConfiguration? = nil
+            if let with = with {
+                snapshotConfiguration = WKSnapshotConfiguration()
+                if let rect = with["rect"] as? [String: Double] {
+                    snapshotConfiguration!.rect = CGRect(x: rect["x"]!, y: rect["y"]!, width: rect["width"]!, height: rect["height"]!)
+                }
+                if let snapshotWidth = with["snapshotWidth"] as? Double {
+                    snapshotConfiguration!.snapshotWidth = NSNumber(value: snapshotWidth)
+                }
+                if #available(iOS 13.0, *), let afterScreenUpdates = with["iosAfterScreenUpdates"] as? Bool {
+                    snapshotConfiguration!.afterScreenUpdates = afterScreenUpdates
+                }
+            }
+            takeSnapshot(with: snapshotConfiguration, completionHandler: {(image, error) -> Void in
                 var imageData: Data? = nil
                 if let screenshot = image {
-                    imageData = screenshot.pngData()!
+                    if let with = with {
+                        switch with["compressFormat"] as! String {
+                        case "JPEG":
+                            let quality = Float(with["quality"] as! Int) / 100
+                            imageData = screenshot.jpegData(compressionQuality: CGFloat(quality))!
+                            break
+                        case "PNG":
+                            imageData = screenshot.pngData()!
+                            break
+                        default:
+                            imageData = screenshot.pngData()!
+                        }
+                    }
+                    else {
+                        imageData = screenshot.pngData()!
+                    }
                 }
                 completionHandler(imageData)
             })

ios/Classes/InAppWebViewMethodHandler.swift

@@ -129,7 +129,8 @@ class InAppWebViewMethodHandler: FlutterMethodCallDelegate {
                 break
             case "takeScreenshot":
                 if webView != nil {
-                    webView!.takeScreenshot(completionHandler: { (screenshot) -> Void in
+                    let screenshotConfiguration = arguments!["screenshotConfiguration"] as? [String: Any?]
+                    webView!.takeScreenshot(with: screenshotConfiguration, completionHandler: { (screenshot) -> Void in
                         result(screenshot)
                     })
                 }

lib/src/in_app_webview_controller.dart

@@ -1504,13 +1504,16 @@ class InAppWebViewController {
     return this.javaScriptHandlersMap.remove(handlerName);
   }
 
-  ///Takes a screenshot (in PNG format) of the WebView's visible viewport and returns a `Uint8List`. Returns `null` if it wasn't be able to take it.
+  ///Takes a screenshot (in PNG format) of the WebView's visible viewport and returns a [Uint8List]. Returns `null` if it wasn't be able to take it.
+  ///
+  ///[screenshotConfiguration] represents the configuration data to use when generating an image from a web view’s contents.
   ///
   ///**NOTE for iOS**: available from iOS 11.0+.
   ///
   ///**Official iOS API**: https://developer.apple.com/documentation/webkit/wkwebview/2873260-takesnapshot
-  Future<Uint8List?> takeScreenshot() async {
+  Future<Uint8List?> takeScreenshot({ScreenshotConfiguration? screenshotConfiguration}) async {
     Map<String, dynamic> args = <String, dynamic>{};
+    args.putIfAbsent('screenshotConfiguration', () => screenshotConfiguration?.toMap());
     return await _channel.invokeMethod('takeScreenshot', args);
   }
 
@@ -1716,7 +1719,8 @@ class InAppWebViewController {
   ///
   ///[zoomFactor] represents the zoom factor to apply. On Android, the zoom factor will be clamped to the Webview's zoom limits and, also, this value must be in the range 0.01 (excluded) to 100.0 (included).
   ///
-  ///[iosAnimated] `true` to animate the transition to the new scale, `false` to make the transition immediate. Available only on iOS.
+  ///[iosAnimated] `true` to animate the transition to the new scale, `false` to make the transition immediate.
+  ///**NOTE**: available only on iOS.
   ///
   ///**NOTE**: available on Android 21+.
   ///
@@ -1748,7 +1752,8 @@ class InAppWebViewController {
   ///Gets the selected text.
   ///
   ///**NOTE**: This method is implemented with using JavaScript.
-  ///Available only on Android 19+.
+  ///
+  ///**NOTE for Android**: available only on Android 19+.
   Future<String?> getSelectedText() async {
     Map<String, dynamic> args = <String, dynamic>{};
     return await _channel.invokeMethod('getSelectedText', args);