v0.4.0

Author: pichillilorenzo

.idea/workspace.xml

@@ -1,3 +1,13 @@
+## 0.4.0
+
+- removed `target` parameter to `InAppBrowser.open()` method. To open the url on the system browser, use the `openWithSystemBrowser: true` option
+- fixes for the `_ChannelManager` private class
+- fixed `EXC_BAD_INSTRUCTION` onLoadStart in Swift
+- added `openWithSystemBrowser` and `isLocalFile` options
+- added `InAppBrowser.openWithSystemBrowser` method
+- added `InAppBrowser.openOnLocalhost` method
+- added `InAppBrowser.loadFile` method
+
 ## 0.3.2
 
 - fixed WebView.storyboard path for iOS

CHANGELOG.md

@@ -56,13 +56,13 @@ class MyInAppBrowser extends InAppBrowser {
     await this.injectScriptCode("console.log({'testObject': 5});"); // the message will be: [object Object]
     await this.injectScriptCode("console.log('testObjectStringify', JSON.stringify({'testObject': 5}));"); // the message will be: testObjectStringify {"testObject": 5}
     await this.injectScriptCode("console.error('testError', false);"); // the message will be: testError false
-    
+
     // add jquery library and custom javascript
     await this.injectScriptFile("https://code.jquery.com/jquery-3.3.1.min.js");
     this.injectScriptCode("""
       \$( "body" ).html( "Next Step..." )
     """);
-    
+
     // add custom css
     this.injectStyleCode("""
     body {
@@ -81,7 +81,7 @@ class MyInAppBrowser extends InAppBrowser {
   void onExit() {
     print("\n\nBrowser closed!\n\n");
   }
-  
+
   @override
   void shouldOverrideUrlLoading(String url) {
     print("\n\n override $url\n\n");
@@ -136,8 +136,8 @@ class _MyAppState extends State<MyApp> {
           title: const Text('Flutter InAppBrowser Plugin example app'),
         ),
         body: new Center(
-          child: new RaisedButton(onPressed: () {
-            inAppBrowser.open(url: "https://flutter.io/", options: {
+          child: new RaisedButton(onPressed: () async {
+            await inAppBrowser.open(url: "https://flutter.io/", options: {
                "useShouldOverrideUrlLoading": true,
                "useOnLoadResource": true
              });
@@ -155,8 +155,10 @@ class _MyAppState extends State<MyApp> {
 
 Opens a URL in a new InAppBrowser instance or the system browser.
 
+**NOTE**: If you open the given `url` with the system browser (`openWithSystemBrowser: true`), you wont be able to use the `InAppBrowser` methods!
+
 ```dart
-inAppBrowser.open({String url = "about:blank", Map<String, String> headers = const {}, String target = "_self", Map<String, dynamic> options = const {}});
+inAppBrowser.open({String url = "about:blank", Map<String, String> headers = const {}, Map<String, dynamic> options = const {}});
 ```
 
 Opens an `url` in a new `InAppBrowser` instance or the system browser.
@@ -165,17 +167,13 @@ Opens an `url` in a new `InAppBrowser` instance or the system browser.
 
 - `headers`: The additional headers to be used in the HTTP request for this URL, specified as a map from name to value.
 
-- `target`: The target in which to load the `url`, an optional parameter that defaults to `_self`.
-
-  - `_self`: Opens in the `InAppBrowser`.
-  - `_blank`: Opens in the `InAppBrowser`.
-  - `_system`: Opens in the system's web browser.
-
 - `options`: Options for the `InAppBrowser`.
 
   All platforms support:
   - __useShouldOverrideUrlLoading__: Set to `true` to be able to listen at the `shouldOverrideUrlLoading` event. The default value is `false`.
   - __useOnLoadResource__: Set to `true` to be able to listen at the `onLoadResource()` event. The default value is `false`.
+  - __openWithSystemBrowser__: Set to `true` to open the given `url` with the system browser. The default value is `false`.
+  - __isLocalFile__: Set to `true` if the `url` is pointing to a local file (the file must be addded in the `assets` section of your `pubspec.yaml`. See `loadFile()` explanation). The default value is `false`.
   - __clearCache__: Set to `true` to have all the browser's cache cleared before the new window is opened. The default value is `false`.
   - __userAgent___: Set the custom WebView's user-agent.
   - __javaScriptEnabled__: Set to `true` to enable JavaScript. The default value is `true`.
@@ -185,9 +183,9 @@ Opens an `url` in a new `InAppBrowser` instance or the system browser.
   - __toolbarTopBackgroundColor__: Set the custom background color of the toolbat at the top.
   - __hideUrlBar__: Set to `true` to hide the url bar on the toolbar at the top. The default value is `false`.
   - __mediaPlaybackRequiresUserGesture__: Set to `true` to prevent HTML5 audio or video from autoplaying. The default value is `true`.
-  
+
   **Android** supports these additional options:
-  
+
   - __hideTitleBar__: Set to `true` if you want the title should be displayed. The default value is `false`.
   - __closeOnCannotGoBack__: Set to `false` to not close the InAppBrowser when the user click on the back button and the WebView cannot go back to the history. The default value is `true`.
   - __clearSessionCache__: Set to `true` to have the session cookie cache cleared before the new window is opened.
@@ -200,14 +198,14 @@ Opens an `url` in a new `InAppBrowser` instance or the system browser.
   - __progressBar__: Set to `false` to hide the progress bar at the bottom of the toolbar at the top. The default value is `true`.
 
   **iOS** supports these additional options:
- 
+
   - __disallowOverScroll__: Set to `true` to disable the bouncing of the WebView when the scrolling has reached an edge of the content. The default value is `false`.
   - __toolbarBottom__: Set to `false` to hide the toolbar at the bottom of the WebView. The default value is `true`.
   - __toolbarBottomBackgroundColor__: Set the custom background color of the toolbat at the bottom.
   - __toolbarBottomTranslucent__: Set to `true` to set the toolbar at the bottom translucent. The default value is `true`.
   - __closeButtonCaption__: Set the custom text for the close button.
   - __closeButtonColor__: Set the custom color for the close button.
-  - __presentationStyle__: Set the custom modal presentation style when presenting the WebView. The default value is `0 //fullscreen`. See [UIModalPresentationStyle](https://developer.apple.com/documentation/uikit/uimodalpresentationstyle) for all the available styles. 
+  - __presentationStyle__: Set the custom modal presentation style when presenting the WebView. The default value is `0 //fullscreen`. See [UIModalPresentationStyle](https://developer.apple.com/documentation/uikit/uimodalpresentationstyle) for all the available styles.
   - __transitionStyle__: Set to the custom transition style when presenting the WebView. The default value is `0 //crossDissolve`. See [UIModalTransitionStyle](https://developer.apple.com/documentation/uikit/uimodaltransitionStyle) for all the available styles.
   - __enableViewportScale__: Set to `true` to allow a viewport meta tag to either disable or restrict the range of user scaling. The default value is `false`.
   - __suppressesIncrementalRendering__: Set to `true` if you want the WebView suppresses content rendering until it is fully loaded into memory.. The default value is `false`.
@@ -218,7 +216,7 @@ Opens an `url` in a new `InAppBrowser` instance or the system browser.
   - __allowsInlineMediaPlayback__: Set to `true` to allow HTML5 media playback to appear inline within the screen layout, using browser-supplied controls rather than native controls. For this to work, add the `webkit-playsinline` attribute to any `<video>` elements. The default value is `false`.
   - __allowsPictureInPictureMediaPlayback__: Set to `true` to allow HTML5 videos play picture-in-picture. The default value is `true`.
   - __spinner__: Set to `false` to hide the spinner when the WebView is loading a page. The default value is `true`.
-  
+
 Example:
 ```dart
 inAppBrowser.open('https://flutter.io/', options: {
@@ -231,39 +229,66 @@ inAppBrowser.open('https://flutter.io/', options: {
   "toolbarBottomTranslucent": false,
   "allowsLinkPreview": false
 });
-``` 
+```
+
+#### static Future\<void\> InAppBrowser.openWithSystemBrowser
+
+This is a static method that opens an `url` in the system browser.
+This has the same behaviour of an `InAppBrowser` instance calling the `open()` method with option `openWithSystemBrowser: true`.
+
+```dart
+InAppBrowser.openWithSystemBrowser(String url);
+```
+
+#### Future\<void\> InAppBrowser.openOnLocalhost
+
+Serve the `assetFilePath` from Flutter assets on http://localhost:`port`/. It is similar to `InAppBrowser.open()` with option `isLocalFile: true`, but it starts a server.
+
+**NOTE for iOS**: For the iOS Platform, you need to add the `NSAllowsLocalNetworking` key with `true` in the `Info.plist` file (See [ATS Configuration Basics](https://developer.apple.com/library/archive/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html#//apple_ref/doc/uid/TP40009251-SW35):
+```xml
+<key>NSAppTransportSecurity</key>
+<dict>
+    <key>NSAllowsLocalNetworking</key>
+    <true/>
+</dict>
+```
+The `NSAllowsLocalNetworking` key is available since **iOS 10**.
+
+```dart
+inAppBrowser.openOnLocalhost(String assetFilePath, {int port = 8080, Map<String, String> headers = const {}, Map<String, dynamic> options = const {}});
+```
 
 #### Events
 
 Event fires when the `InAppBrowser` starts to load an `url`.
 ```dart
   @override
   void onLoadStart(String url) {
-  
+
   }
 ```
 
 Event fires when the `InAppBrowser` finishes loading an `url`.
 ```dart
   @override
   void onLoadStop(String url) {
-  
+
   }
 ```
 
 Event fires when the `InAppBrowser` encounters an error loading an `url`.
 ```dart
   @override
   void onLoadError(String url, String code, String message) {
-  
+
   }
 ```
 
 Event fires when the `InAppBrowser` window is closed.
 ```dart
   @override
   void onExit() {
-  
+
   }
 ```
 
@@ -305,105 +330,141 @@ Loads the given `url` with optional `headers` specified as a map from name to va
 inAppBrowser.loadUrl(String url, {Map<String, String> headers = const {}});
 ```
 
+#### Future\<void\> InAppBrowser.loadFile
+
+Loads the given `assetFilePath` with optional `headers` specified as a map from name to value.
+
+To be able to load your local files (assets, js, css, etc.), you need to add them in the `assets` section of the `pubspec.yaml` file, otherwise they cannot be found!
+
+Example of a `pubspec.yaml` file:
+```yaml
+...
+
+# The following section is specific to Flutter.
+flutter:
+
+  # The following line ensures that the Material Icons font is
+  # included with your application, so that you can use the icons in
+  # the material Icons class.
+  uses-material-design: true
+
+  assets:
+    - assets/index.html
+    - assets/css/
+    - assets/images/
+
+...
+```
+Example of a `main.dart` file:
+```dart
+...
+inAppBrowser.loadFile("assets/index.html");
+...
+```
+
+```dart
+inAppBrowser.loadFile(String assetFilePath, {Map<String, String> headers = const {}});
+```
+
 #### Future\<void\> InAppBrowser.show
 
 Displays an `InAppBrowser` window that was opened hidden. Calling this has no effect if the `InAppBrowser` was already visible.
 
 ```dart
 inAppBrowser.show();
-``` 
+```
 
 #### Future\<void\> InAppBrowser.hide
 
 Hides the `InAppBrowser` window. Calling this has no effect if the `InAppBrowser` was already hidden.
 
 ```dart
 inAppBrowser.hide();
-``` 
+```
 
 #### Future\<void\> InAppBrowser.close
 
 Closes the `InAppBrowser` window.
 
 ```dart
 inAppBrowser.close();
-``` 
+```
 
 #### Future\<void\> InAppBrowser.reload
 
 Reloads the `InAppBrowser` window.
 
 ```dart
 inAppBrowser.reload();
-``` 
+```
 
 #### Future\<void\> InAppBrowser.goBack
 
 Goes back in the history of the `InAppBrowser` window.
 
 ```dart
 inAppBrowser.goBack();
-``` 
+```
 
 #### Future\<void\> InAppBrowser.goForward
 
 Goes forward in the history of the `InAppBrowser` window.
 
 ```dart
 inAppBrowser.goForward();
-``` 
+```
 
 #### Future\<bool\> InAppBrowser.isLoading
 
 Check if the Web View of the `InAppBrowser` instance is in a loading state.
 
 ```dart
 inAppBrowser.isLoading();
-``` 
+```
 
 #### Future\<void\> InAppBrowser.stopLoading
 
 Stops the Web View of the `InAppBrowser` instance from loading.
 
 ```dart
 inAppBrowser.stopLoading();
-``` 
+```
 
 #### Future\<bool\> InAppBrowser.isHidden
 
 Check if the Web View of the `InAppBrowser` instance is hidden.
 
 ```dart
 inAppBrowser.isHidden();
-``` 
+```
 
 #### Future\<String\> InAppBrowser.injectScriptCode
 
-Injects JavaScript code into the `InAppBrowser` window and returns the result of the evaluation. (Only available when the target is set to `_blank` or to `_self`)
+Injects JavaScript code into the `InAppBrowser` window and returns the result of the evaluation.
 
 ```dart
 inAppBrowser.injectScriptCode(String source);
-``` 
+```
 
 #### Future\<void\> InAppBrowser.injectScriptFile
 
-Injects a JavaScript file into the `InAppBrowser` window. (Only available when the target is set to `_blank` or to `_self`)
+Injects a JavaScript file into the `InAppBrowser` window.
 
 ```dart
 inAppBrowser.injectScriptFile(String urlFile);
-``` 
+```
 
 #### Future\<void\> InAppBrowser.injectStyleCode
 
-Injects CSS into the `InAppBrowser` window. (Only available when the target is set to `_blank` or to `_self`)
+Injects CSS into the `InAppBrowser` window.
 
 ```dart
 inAppBrowser.injectStyleCode(String source);
-``` 
+```
 
 #### Future\<void\> InAppBrowser.injectStyleFile
 
-Injects a CSS file into the `InAppBrowser` window. (Only available when the target is set to `_blank` or to `_self`)
+Injects a CSS file into the `InAppBrowser` window.
 
 ```dart
 inAppBrowser.injectStyleFile(String urlFile);
@@ -462,13 +523,13 @@ class MyInAppBrowser extends InAppBrowser {
   void onExit() {
     print("\n\nBrowser closed!\n\n");
   }
-  
+
 }
 
 MyInAppBrowser inAppBrowserFallback = new MyInAppBrowser();
 
 class MyChromeSafariBrowser extends ChromeSafariBrowser {
-  
+
   MyChromeSafariBrowser(browserFallback) : super(browserFallback);
 
   @override
@@ -579,23 +640,23 @@ Event fires when the `ChromeSafariBrowser` is opened.
 ```dart
   @override
   void onOpened() {
-  
+
   }
 ```
 
 Event fires when the `ChromeSafariBrowser` is loaded.
 ```dart
   @override
   void onLoaded() {
-  
+
   }
 ```
 
 Event fires when the `ChromeSafariBrowser` is closed.
 ```dart
   @override
   void onClosed() {
-  
+
   }
 ```