interactive_webview 0.1.2

  • Readme
  • Changelog
  • Example
  • Installing
  • 92

pub package

interactive_webview #

Plugin that allow Flutter to communicate with a native WebView.

Warning: This is not a display WebView. This plugin is designed to make communication between Flutter and WebView javascript. You can call a Javascript function; in the other hand, you can send messgage (postMessage) from Javascript to Flutter

  • Android: using JavascriptInterface
  • iOS: using WKUserContentController

Getting Started #

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

How it works #

InteractiveWebView provide a singleton instance linked to one unique webview, so you can take control of the webview from anywhere in the app. You don't need to care where is the webview. It is hidden and automatically added to the keyWindow (iOS) and decorView (Android)

Load HTML string with/without a base url

InteractiveWebView allow you to load an HTML string with different base url

final _webView = new InteractiveWebView();

_webView.loadHTML("<html><head></head><script> src=''></script><body></body></html>", baseUrl: "");

by using base url, you can do some hacking work on Javascript such as embedding iframe and AJAX request from Javascript. Normally you cannot do these things if your base url is different from url you are requesting

Load url

final _webView = new InteractiveWebView();


Listen for events

final _webView = new InteractiveWebView();

_webView.stateChanged.listen((state) {
  // state.type: enum (didStatrt and didFinish)
  // state.url

_webView.didReceiveMessage.listen((message) {
  // (should be a Map/List/String)

Call Javascript function

final _webView = new InteractiveWebView();

_webView.evalJavascript("<your javascript function>");

Set restricted schemes

Sometimes you want the webview to restrict from loading specific urls/schemes. You can archieve that by using:

final _webView = new InteractiveWebView();

_webView.setOptions(restrictedSchemes: <String>[""]); // will not allow to load in webview

How to post message from Javascript #

As mentioned above, you can post message from Javascript to Flutter.

Both iOS and Android defined a message handler called 'native':

  • iOS: you can access this handler by using webkit.messageHandlers.native
  • Android: you can access this handler by using window.native

So you only need to check which one is available in the webview, for example:

const nativeCommunicator = typeof webkit !== 'undefined' ? webkit.messageHandlers.native : window.native;

Then you can post message to Flutter

Warning: postMessage accepts String value only. So if you want to send an object/array, you need to using JSON.stringify to convert it to JSON string. InteractiveWebView will convert it back to Map/List respectively.

// send an array data
const array = [{name: "Hello"}, 1, true, "from", "WebView!!!"];

// send and object data
const obj = {action: "my_action", text: "Hello from WebView!!!", number: 1, bool: false};

// send a text data
const text = "Hello from WebView!!!";

To listen to post message from Flutter, you can use didReceiveMessage, see Listen for events

0.1.0 #

  • Create and publish plugin

0.1.1+2 #

  • Update API
  • Add example

0.1.1+3 #

  • Fixed iOS: WKWebView not calling didFinish

0.1.2 #

  • iOS: Upgrade to to Swift 5
  • Android:
    • Upgrade build grade and kotlin
    • AndroidX support


import 'package:flutter/material.dart';

import 'package:flutter/services.dart';
import 'package:interactive_webview/interactive_webview.dart';

void main() => runApp(new MyApp());

class MyApp extends StatefulWidget {
  _MyAppState createState() => new _MyAppState();

class _MyAppState extends State<MyApp> {

  final _webView = InteractiveWebView();

  void initState() {

  _webViewHandler() async {
    _webView.didReceiveMessage.listen((message) {

    _webView.stateChanged.listen((state) {
      print("stateChanged ${state.type} ${state.url}");

    final html = await rootBundle.loadString("assets/index.html", cache: false);
    _webView.loadHTML(html, baseUrl: "");

  Widget build(BuildContext context) {
    return new MaterialApp(
      home: new Scaffold(
        appBar: new AppBar(
          title: const Text('Plugin example app'),
        body: new Center(
          child: new RaisedButton(onPressed: () {
            final text = "Hello from Native!!!";
          }, child: Text("Send to WebView"))

Use this package as a library

1. Depend on it

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

  interactive_webview: ^0.1.2

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:interactive_webview/interactive_webview.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 Mar 31, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

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

Health suggestions

Format lib/generated/i18n.dart.

Run flutter format to format lib/generated/i18n.dart.

Format lib/interactive_webview.dart.

Run flutter format to format lib/interactive_webview.dart.


Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev <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