webviewx 0.2.2 webviewx: ^0.2.2 copied to clipboard
A feature-rich cross-platform webview using webview_flutter for mobile and iframe for web. JS interop-ready.
This package has been archived and will not be maintained anymore. There are several reasons for why I had to make this decision.
This package was initially built as a proof of concept of how would a crossplatform webview work and look like. It was supposed to be used for loading static documents, for creating WYSIWYG editors, or things alike. And it worked (and still works!) fine for that purpose, but it still feels a bit clucky since not every feature can be implemented on all platforms. Like I said, a proof of concept.
But then I wanted to make the web version similar to the mobile version and that was the moment I made the big mistake of allowing the package to bypass websites' iframe policies using *PUBLIC* third party cors proxy servers.
After that, people started to use this package to load their auth forms/bank/paypal payment pages, etc. through *PUBLIC* proxies, which is very unsafe. I tried to explain in the issues that this is not a good idea, but issues regarding auth and similar topics kept popping up.
I should have done this a while ago, but I have to admit that lately I have been rather busy with other projects and didn't have much time for OSS.
Thank you everyone.
Getting started #
- Basic usage
- Limitations and notes
- Known issues and TODOs
Basic usage #
1. Create a
WebViewXController inside your stateful widget #
late WebViewXController webviewController;
2. Add the WebViewX widget inside the build method, and set the
onWebViewCreated callback in order to retrieve the controller when the webview is initialized #
WebViewX( initialContent: '<h2> Hello, world! </h2>', initialSourceType: SourceType.HTML, onWebViewCreated: (controller) => webviewController = controller, ... ... other options );
Important ! #
If you need to add other widgets on top of the webview (e.g. inside a Stack widget), you MUST wrap those widgets with a WebViewAware widget. This does nothing on mobile, but on web it allows widgets on top to intercept gestures. Otherwise, those widgets may not be clickable and/or the iframe will behave weird (unexpected refresh/reload - this is a well known issue).
Also, if you add widgets on top of the webview, wrap them and then you notice that the iframe still reloads unexpectedly, you should check if there are other widgets that sit on top without being noticed, or try to wrap InkWell, GestureRecognizer or Button widgets to see which one causes the problem.
3. Interact with the controller (run the example app to check out some use cases) #
webviewController.loadContent( 'https://flutter.dev', SourceType.url, ); webviewController.goBack(); webviewController.goForward(); ... ...
Note: For more detailed information about things such as
EmbeddedJsContent, please visit each own's
.dart file from the
Widget properties #
||Initial webview content|
||Initial webview content type (
||Callback that gets executed when the webview has initialized|
||Boolean value that specifies if the widget should ignore all gestures right after it is initialized|
||This specifies if media content should be allowed to autoplay when initialized (i.e when the page is loaded)|
||Callback that gets executed when a page starts loading (e.g. after you change the content)|
||Callback that gets executed when a page finishes loading|
||Callback that, if not null, gets executed when the user clicks something in the webview (on Web it only works for
||Callback that gets executed when there is an error when loading resources ( issues on web )|
||This is an object that contains web-specific options. Theese are not available on mobile (yet)|
||This is an object that contains mobile-specific options. Theese are not available on web (yet)|
Controller properties #
|Load URL that allows iframe embedding||webviewController.
|Load URL that doesnt allow iframe embedding||webviewController.
|Load URL that doesnt allow iframe embedding, with headers||webviewController.
|Load HTML from string||webviewController.
|Load HTML from assets||webviewController.
|Check if you can go back in history||webviewController.
|Go back in history||webviewController.
|Check if you can go forward in history||webviewController.
|Go forward in history||webviewController.
|Reload current content||webviewController.
|Check if all gestures are ignored||webviewController.
|Set ignore all gestures||webviewController.
|Call a JS method||webviewController.
|Retrieve webview's content||webviewController.
|Get scroll position on X axis||webviewController.
|Get scroll position on Y axis||webviewController.
|Scrolls exactly to the position
|Retrieves the inner page title||webviewController.
Limitations and notes #
While this package aims to put together the best of both worlds, there are differences between web and mobile.
Running and building
First, this package was being developed while the default
html. Now(Flutter 2, Dart 2.12), the default renderer is
From my experience, this package does behave a little bit weird on canvaskit, so you should use the
To do this, you have to run your ordinary
flutter run -d chromecommand with the
--web-renderer htmlextra argument, like this:
flutter run -d chrome --web-renderer html
for running and
flutter build web --web-renderer html
Diferences between Web and Mobile behaviour:
About content loading on Web
To make the web version (iframe) work as it is, I had to use some of the code from x-frame bypass in order to make a request to a CORS proxy, which removes the headers that block iframe embeddings.
This might seem like a hack, and it really is, but I couldn't find any other way to make the iframe behave similar to the mobile webview (which is some kind of an actual browser, that's why everything works there by default).
About Web navigation
On web, the history navigation stack is built from scratch because I couldn't handle iframe's internal history the right way.
Known issues and TODOs #
[ x ] On web, user-agent and headers only work when using
SourceType.urlBypass, and they only have effect the first time being used (
[ x ] On web, it should be possible to send any errors caught when loading an
urlBypassto a dart callback, which will then be sent through the
onWebResourceErrorcallback, just like on the mobile version (
[ x ] On web, it should be possible to add a custom proxy list without the js null-checking mess (
[ ? ] Eventually (if possible), most if not all properties from
MobileSpecificParamsshould merge and theese two objects may disappear
[ x ] On mobile, the controller's value's source type becomes out of sync when moving back and forth in history. This happens because the url change is not yet intercepted and set the model accordingly (shouldn't be hard to fix).
On mobile, the controller's callJsMethod doesnt throw an error if the operation failed. Instead it only shows the error in console.
List open, there may be others
This package wouldn't be possible without the following:
- webview_flutter for the mobile version
- easy_web_view for ideas and starting point for the web version
- pointer_interceptor for fixing iframe issues when other widgets are on top of it (see above)
- x-frame-bypass for allowing the iframe to bypass websites' X-Frame-Options: deny/same-origin headers, thus allowing us to load any webpage (just like on mobile)
- https://cors.bridged.cc/ for the free CORS proxy
- https://api.codetabs.com/ for the free CORS proxy
- And last but not least, http://deversoft.ro (the company I work for) for motivating me throughout the development process