gmschurch_flutter_webview_plugin 0.3.11+3

  • Readme
  • Changelog
  • Example
  • Installing
  • new64

Flutter Community: flutter_webview_plugin

Flutter WebView Plugin #

pub package

Plugin that allows Flutter to communicate with a native WebView.

Warning: The webview is not integrated in the widget tree, it is a native view on top of the flutter view. You won't be able see snackbars, dialogs, or other flutter widgets that would overlap with the region of the screen taken up by the webview.

The getSafeAcceptedType() function is available only for minimum SDK of 21. eval() function only supports SDK of 19 or greater for evaluating Javascript.

Getting Started #

For help getting started with Flutter, view our online documentation.


In order for plugin to work correctly, you need to add new key to ios/Runner/Info.plist


NSAllowsArbitraryLoadsInWebContent is for iOS 10+ and NSAllowsArbitraryLoads for iOS 9.

How it works #

Launch WebView Fullscreen with Flutter navigation

new MaterialApp(
      routes: {
        "/": (_) => new WebviewScaffold(
          url: "",
          appBar: new AppBar(
            title: new Text("Widget webview"),

Optional parameters hidden and initialChild are available so that you can show something else while waiting for the page to load. If you set hidden to true it will show a default CircularProgressIndicator. If you additionally specify a Widget for initialChild you can have it display whatever you like till page-load.

e.g. The following will show a read screen with the text 'waiting.....'.

return new MaterialApp(
  title: 'Flutter WebView Demo',
  theme: new ThemeData(
  routes: {
    '/': (_) => const MyHomePage(title: 'Flutter WebView Demo'),
    '/widget': (_) => new WebviewScaffold(
      url: selectedUrl,
      appBar: new AppBar(
        title: const Text('Widget webview'),
      withZoom: true,
      withLocalStorage: true,
      hidden: true,
      initialChild: Container(
        color: Colors.redAccent,
        child: const Center(
          child: Text('Waiting.....'),

FlutterWebviewPlugin provide a singleton instance linked to one unique webview, so you can take control of the webview from anywhere in the app

listen for events

final flutterWebviewPlugin = new FlutterWebviewPlugin();

flutterWebviewPlugin.onUrlChanged.listen((String url) {


Listen for scroll event in webview

final flutterWebviewPlugin = new FlutterWebviewPlugin();
flutterWebviewPlugin.onScrollYChanged.listen((double offsetY) { // latest offset value in vertical scroll
  // compare vertical scroll changes here with old value

flutterWebviewPlugin.onScrollXChanged.listen((double offsetX) { // latest offset value in horizontal scroll
  // compare horizontal scroll changes here with old value

Note: Do note there is a slight difference is scroll distance between ios and android. Android scroll value difference tends to be larger than ios devices.

Hidden WebView

final flutterWebviewPlugin = new FlutterWebviewPlugin();

flutterWebviewPlugin.launch(url, hidden: true);

Close launched WebView


Webview inside custom Rectangle

final flutterWebviewPlugin = new FlutterWebviewPlugin();

  fullScreen: false,
  rect: new Rect.fromLTWH(

Injecting custom code into the webview

Use flutterWebviewPlugin.evalJavaScript(String code). This function must be run after the page has finished loading (i.e. listen to onStateChanged for events where state is finishLoad).

If you have a large amount of JavaScript to embed, use an asset file. Add the asset file to pubspec.yaml, then call the function like:

Future<String> loadJS(String name) async {
  var givenJS = rootBundle.loadString('assets/$name.js');
  return givenJS.then((String js) {
    flutterWebViewPlugin.onStateChanged.listen((viewState) async {
      if (viewState.type == WebViewState.finishLoad) {

Accessing local files in the file system #

Set the withLocalUrl option to true in the launch function or in the Webview scaffold to enable support for local URLs.

Note that, on iOS, the localUrlScope option also needs to be set to a path to a directory. All files inside this folder (or subfolder) will be allowed access. If ommited, only the local file being opened will have access allowed, resulting in no subresources being loaded. This option is ignored on Android.

Ignoring SSL Errors #

Set the ignoreSSLErrors option to true to display content from servers with certificates usually not trusted by the Webview like self-signed certificates.

Warning: Don't use this in production.

Note that on iOS, you need to add new key to ios/Runner/Info.plist


NSAllowsArbitraryLoadsInWebContent is for iOS 10+ and NSAllowsArbitraryLoads for iOS 9. Otherwise you'll still not be able to display content from pages with untrusted certificates.

You can test your ignorance if ssl certificates is working e.g. through

Webview Events #

  • Stream<Null> onDestroy
  • Stream<String> onUrlChanged
  • Stream<WebViewStateChanged> onStateChanged
  • Stream<double> onScrollXChanged
  • Stream<double> onScrollYChanged
  • Stream<String> onError

Don't forget to dispose webview flutterWebviewPlugin.dispose()

Webview Functions #

Future<Null> launch(String url, {
    Map<String, String> headers: null,
    Set<JavascriptChannel> javascriptChannels: null,
    bool withJavascript: true,
    bool clearCache: false,
    bool clearCookies: false,
    bool hidden: false,
    bool enableAppScheme: true,
    Rect rect: null,
    String userAgent: null,
    bool withZoom: false,
    bool displayZoomControls: false,
    bool withLocalStorage: true,
    bool withLocalUrl: true,
    String localUrlScope: null,
    bool withOverviewMode: false,
    bool scrollBar: true,
    bool supportMultipleWindows: false,
    bool appCacheEnabled: false,
    bool allowFileURLs: false,
    bool useWideViewPort: false,
    String invalidUrlRegex: null,
    bool geolocationEnabled: false,
    bool debuggingEnabled: false,
    bool ignoreSSLErrors: false,
Future<String> evalJavascript(String code);
Future<Map<String, dynamic>> getCookies();
Future<Null> cleanCookies();
Future<Null> resize(Rect rect);
Future<Null> show();
Future<Null> hide();
Future<Null> reloadUrl(String url);
Future<Null> close();
Future<Null> reload();
Future<Null> goBack();
Future<Null> goForward();
Future<Null> stopLoading();
Future<bool> canGoBack();
Future<bool> canGoForward();

0.3.11+3 #

  • bug fix at podspec iOS

0.3.11+2 #

  • update README

0.3.11+1 #

  • link with jpg, png, pdf, doc, docx extension open default browser

0.3.10+1 #

  • fixed android build

0.3.10 #

  • add mediaPlaybackRequiresUserGesture parameter
  • Add ignore ssl error parameter

0.3.9+1 #

  • Fixed error methods on iOS

0.3.9 #

  • Fixed error methods on iOS
  • fixed build
  • fixed ios clean cookies
  • 4 Make plugin work in headless mode when extending FlutterApplication
  • added canGoBack and canGoForward methods

0.3.8 #

  • Fix iOS local URL support (fixes #114)
  • bugfix: Added google() repository to allprojects to satisfy androidx build rules
  • fixed min sdk for android

0.3.7 #

  • Added reloading url with headers
  • Added support for reloading url with headers

0.3.6 #

  • Allow web contents debugging in Chrome
  • Android: allow geolocation and file chooser simultaneously
  • Add min sdk requirement and descriptions
  • fix bug android webview httperror exception
  • Exposes displayZoomControls, withOverviewMode and useWideViewPort settings for Android WebView

0.3.5 #

  • Ability to choose from camera or gallery when using
  • Support for webview’s estimated loading progress #255
  • Fix back button handler to be compatible with the WillPopScope widget

0.3.4 #

  • WebView always hidden on iOS

0.3.3 #

  • BREAKING CHANGE - AndroidX support

0.3.2 #

  • enable Javascript in iOS, support abort loading specific URLs
  • add resizeToAvoidBottomInset to WebviewScaffold; #301

0.3.1 #

  • Add support for geolocation Android
  • fix No269: Can't load target="_blank" links on iOS
  • fix: reloadUrl will not return Future
  • Fix height of keyboard
  • Fix Hide/Show WebView
  • hotfix widget back to initialChild after webview is tapped on Android

0.3.0 #

  • Fixes rect capture issue. Ensures WebView remains in the correct place on screen even when keyboard appears.
  • Fixed iOS crash issue with Flutter >= 0.10.2.
  • Added new clearCookies feature.
  • Added support for hidden and initialChild feature to show page loading view.
  • Added supportMultipleWindows: enables Multiple Window Support on Android.
  • Added appCacheEnabled: enables Application Caches API on Android.
  • Added allowFileURLs: allows file:// local file URLs.
  • iOS Now supports: reload, goBack, and goForward.
  • iOS Bug fix didFailNavigation #77
  • Updated Android compileSdkVersion to 27 matching offical Flutter plugins.
  • Fixed Android reloadUrl so settings are not cleared.
  • Enabled compatible Mixed Content Mode on Android.

0.2.1 #

  • Added webview scrolling listener
  • Added stopLoading() method

0.2.0 #

  • update sdk
  • prevent negative webview height in scaffold
  • handle type error in getCookies
  • Support file upload via WebView on Android
  • fix WebviewScaffold crash on iOS
  • Scrollbar functionality to Web view
  • Add support of HTTP errors
  • Add headers when loading url

0.1.6 #

  • fix onStateChanged
  • Taking safe areas into account for bottom bars
  • iOS
    • withLocalUrl option for iOS > 9.0
  • Android
    • add reload, goBack and foForward function

0.1.5 #

  • iOS use WKWebView instead of UIWebView

0.1.4 #

  • support localstorage for ANDROID

0.1.3 #

  • support zoom in webview

0.1.2 #

  • support bottomNavigationBar and persistentFooterButtons on webview scaffold

0.1.1 #

  • support back button navigation for Android
    • if cannot go back, it will trigger onDestroy
  • support preview dart2

0.1.0+1 #

  • fix Android close webview

0.1.0 #

  • iOS && Android:

    • get cookies
    • eval javascript
    • user agent setting
    • state change event
    • embed in rectangle or fullscreen if null
    • hidden webview
  • Android

    • adding Activity in manifest is not needed anymore
  • Add WebviewScaffold

0.0.9 #

  • Android: remove the need to use FlutterActivity as base activity

0.0.5 #

  • fix "onDestroy" event for iOS #4
  • fix fullscreen mode for iOS #5

0.0.4 #

  • IOS implementation
  • Update to last version of Flutter

0.0.3 #

  • Documentation

0.0.2 #

  • Initial version for Android


flutter_webview_plugin_example #

Demonstrates how to use the flutter_webview_plugin plugin.

Getting Started #

For help getting started with Flutter, view our online documentation.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:

  gmschurch_flutter_webview_plugin: ^0.3.11+3

2. Install it

You can install packages from the command line:

with Flutter:

$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:

import 'package:gmschurch_flutter_webview_plugin/gmschurch_flutter_webview_plugin.dart';
Describes how popular the package is relative to other packages. [more]
Code health derived from static analysis. [more]
Reflects how tidy and up-to-date the package is. [more]
Weighted score of the above. [more]
Learn more about scoring.

We analyzed this package on Feb 26, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.7.1
  • pana: 0.13.5
  • Flutter: 1.12.13+hotfix.8


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.11 1.14.12
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
mockito ^4.1.0