[webview_flutter] Add a getTitle method to WebViewController (#1979)

amirh · web-flow · commit 59eeaa85c1fe · 2019-08-15T16:44:27.000-07:00
Allows inspecting the title of the currently loaded page.
diff --git a/packages/webview_flutter/CHANGELOG.md b/packages/webview_flutter/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.3.12
+
+* Added a getTitle getter to WebViewController.
+
 ## 0.3.11+6
 
 * Calling destroy on Android webview when flutter webview is getting disposed.
diff --git a/packages/webview_flutter/android/src/main/java/io/flutter/plugins/webviewflutter/FlutterWebView.java b/packages/webview_flutter/android/src/main/java/io/flutter/plugins/webviewflutter/FlutterWebView.java
@@ -130,6 +130,9 @@ public void onMethodCall(MethodCall methodCall, Result result) {
       case "clearCache":
         clearCache(result);
         break;
+      case "getTitle":
+        getTitle(result);
+        break;
       default:
         result.notImplemented();
     }
@@ -222,6 +225,10 @@ private void clearCache(Result result) {
     result.success(null);
   }
 
+  private void getTitle(Result result) {
+    result.success(webView.getTitle());
+  }
+
   private void applySettings(Map<String, Object> settings) {
     for (String key : settings.keySet()) {
       switch (key) {
diff --git a/packages/webview_flutter/example/test_driver/webview.dart b/packages/webview_flutter/example/test_driver/webview.dart
@@ -369,6 +369,43 @@ void main() {
       expect(isPaused, _webviewBool(false));
     });
   });
+
+  test('getTitle', () async {
+    final String getTitleTest = '''
+        <!DOCTYPE html><html>
+        <head><title>Some title</title>
+        </head>
+        <body>
+        </body>
+        </html>
+      ''';
+    final String getTitleTestBase64 =
+        base64Encode(const Utf8Encoder().convert(getTitleTest));
+    final Completer<void> pageLoaded = Completer<void>();
+    final Completer<WebViewController> controllerCompleter =
+        Completer<WebViewController>();
+
+    await pumpWidget(
+      Directionality(
+        textDirection: TextDirection.ltr,
+        child: WebView(
+          initialUrl: 'data:text/html;charset=utf-8;base64,$getTitleTestBase64',
+          onWebViewCreated: (WebViewController controller) {
+            controllerCompleter.complete(controller);
+          },
+          onPageFinished: (String url) {
+            pageLoaded.complete(null);
+          },
+        ),
+      ),
+    );
+
+    final WebViewController controller = await controllerCompleter.future;
+    await pageLoaded.future;
+
+    final String title = await controller.getTitle();
+    expect(title, 'Some title');
+  });
 }
 
 Future<void> pumpWidget(Widget widget) {
diff --git a/packages/webview_flutter/ios/Classes/FlutterWebView.m b/packages/webview_flutter/ios/Classes/FlutterWebView.m
@@ -118,6 +118,8 @@ - (void)onMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
     [self onRemoveJavaScriptChannels:call result:result];
   } else if ([[call method] isEqualToString:@"clearCache"]) {
     [self clearCache:result];
+  } else if ([[call method] isEqualToString:@"getTitle"]) {
+    [self onGetTitle:result];
   } else {
     result(FlutterMethodNotImplemented);
   }
@@ -238,6 +240,11 @@ - (void)clearCache:(FlutterResult)result {
   }
 }
 
+- (void)onGetTitle:(FlutterResult)result {
+  NSString* title = _webView.title;
+  result(title);
+}
+
 // Returns nil when successful, or an error message when one or more keys are unknown.
 - (NSString*)applySettings:(NSDictionary<NSString*, id>*)settings {
   NSMutableArray<NSString*>* unknownKeys = [[NSMutableArray alloc] init];
diff --git a/packages/webview_flutter/lib/platform_interface.dart b/packages/webview_flutter/lib/platform_interface.dart
@@ -152,6 +152,12 @@ abstract class WebViewPlatformController {
     throw UnimplementedError(
         "WebView removeJavascriptChannels is not implemented on the current platform");
   }
+
+  /// Returns the title of the currently loaded page.
+  Future<String> getTitle() {
+    throw UnimplementedError(
+        "WebView getTitle is not implemented on the current platform");
+  }
 }
 
 /// Settings for configuring a WebViewPlatform.
diff --git a/packages/webview_flutter/lib/src/webview_method_channel.dart b/packages/webview_flutter/lib/src/webview_method_channel.dart
@@ -103,6 +103,9 @@ class MethodChannelWebViewPlatform implements WebViewPlatformController {
         'removeJavascriptChannels', javascriptChannelNames.toList());
   }
 
+  @override
+  Future<String> getTitle() => _channel.invokeMethod<String>("getTitle");
+
   /// Method channel implementation for [WebViewPlatform.clearCookies].
   static Future<bool> clearCookies() {
     return _cookieManagerChannel
diff --git a/packages/webview_flutter/lib/webview_flutter.dart b/packages/webview_flutter/lib/webview_flutter.dart
@@ -600,6 +600,11 @@ class WebViewController {
     // ignore: strong_mode_implicit_dynamic_method
     return _webViewPlatformController.evaluateJavascript(javascriptString);
   }
+
+  /// Returns the title of the currently loaded page.
+  Future<String> getTitle() {
+    return _webViewPlatformController.getTitle();
+  }
 }
 
 /// Manages cookies pertaining to all [WebView]s.
diff --git a/packages/webview_flutter/pubspec.yaml b/packages/webview_flutter/pubspec.yaml
@@ -1,6 +1,6 @@
 name: webview_flutter
 description: A Flutter plugin that provides a WebView widget on Android and iOS.
-version: 0.3.11+6
+version: 0.3.12
 author: Flutter Team <flutter-dev@googlegroups.com>
 homepage: https://github.com/flutter/plugins/tree/master/packages/webview_flutter
 

Original file line number	Diff line number	Diff line change
`@@ -118,6 +118,8 @@ - (void)onMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {`
`118`	`118`	`[self onRemoveJavaScriptChannels:call result:result];`
`119`	`119`	`} else if ([[call method] isEqualToString:@"clearCache"]) {`
`120`	`120`	`[self clearCache:result];`
	`121`	`+ } else if ([[call method] isEqualToString:@"getTitle"]) {`
	`122`	`+ [self onGetTitle:result];`
`121`	`123`	`} else {`
`122`	`124`	`result(FlutterMethodNotImplemented);`
`123`	`125`	`}`
`@@ -238,6 +240,11 @@ - (void)clearCache:(FlutterResult)result {`
`238`	`240`	`}`
`239`	`241`	`}`
`240`	`242`
	`243`	`+- (void)onGetTitle:(FlutterResult)result {`
	`244`	`+ NSString* title = _webView.title;`
	`245`	`+ result(title);`
	`246`	`+}`
	`247`	`+`
`241`	`248`	`// Returns nil when successful, or an error message when one or more keys are unknown.`
`242`	`249`	`- (NSString)applySettings:(NSDictionary<NSString, id>*)settings {`
`243`	`250`	`NSMutableArray<NSString> unknownKeys = [[NSMutableArray alloc] init];`
Original file line number	Diff line number	Diff line change
`@@ -152,6 +152,12 @@ abstract class WebViewPlatformController {`
`152`	`152`	`throw UnimplementedError(`
`153`	`153`	`"WebView removeJavascriptChannels is not implemented on the current platform");`
`154`	`154`	`}`
	`155`	`+`
	`156`	`+ /// Returns the title of the currently loaded page.`
	`157`	`+ Future<String> getTitle() {`
	`158`	`+ throw UnimplementedError(`
	`159`	`+ "WebView getTitle is not implemented on the current platform");`
	`160`	`+ }`
`155`	`161`	`}`
`156`	`162`
`157`	`163`	`/// Settings for configuring a WebViewPlatform.`
Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,9 @@ class MethodChannelWebViewPlatform implements WebViewPlatformController {`
`103`	`103`	`'removeJavascriptChannels', javascriptChannelNames.toList());`
`104`	`104`	`}`
`105`	`105`
	`106`	`+ @override`
	`107`	`+ Future<String> getTitle() => _channel.invokeMethod<String>("getTitle");`
	`108`	`+`
`106`	`109`	`/// Method channel implementation for [WebViewPlatform.clearCookies].`
`107`	`110`	`static Future<bool> clearCookies() {`
`108`	`111`	`return _cookieManagerChannel`
Original file line number	Diff line number	Diff line change
`@@ -600,6 +600,11 @@ class WebViewController {`
`600`	`600`	`// ignore: strong_mode_implicit_dynamic_method`
`601`	`601`	`return _webViewPlatformController.evaluateJavascript(javascriptString);`
`602`	`602`	`}`
	`603`	`+`
	`604`	`+ /// Returns the title of the currently loaded page.`
	`605`	`+ Future<String> getTitle() {`
	`606`	`+ return _webViewPlatformController.getTitle();`
	`607`	`+ }`
`603`	`608`	`}`
`604`	`609`
`605`	`610`	`/// Manages cookies pertaining to all [WebView]s.`