webview_flutter 3.0.4 icon indicating copy to clipboard operation
webview_flutter: ^3.0.4 copied to clipboard

A Flutter plugin that provides a WebView widget on Android and iOS.

WebView for Flutter #

pub package

A Flutter plugin that provides a WebView widget.

On iOS the WebView widget is backed by a WKWebView; On Android the WebView widget is backed by a WebView.

AndroidiOS
SupportSDK 19+ or 20+9.0+

Usage #

Add webview_flutter as a dependency in your pubspec.yaml file. If you are targeting Android, make sure to read the Android Platform Views section below to choose the platform view mode that best suits your needs.

You can now include a WebView widget in your widget tree. See the WebView widget's Dartdoc for more details on how to use the widget.

Android Platform Views #

This plugin uses Platform Views to embed the Android’s webview within the Flutter app. It supports two modes: hybrid composition (the current default) and virtual display.

Here are some points to consider when choosing between the two:

  • Hybrid composition has built-in keyboard support while virtual display has multiple keyboard issues.
  • Hybrid composition requires Android SDK 19+ while virtual display requires Android SDK 20+.
  • Hybrid composition and virtual display have different performance tradeoffs.

Using Hybrid Composition #

The mode is currently enabled by default. You should however make sure to set the correct minSdkVersion in android/app/build.gradle if it was previously lower than 19:

android {
    defaultConfig {
        minSdkVersion 19
    }
}

Using Virtual displays #

  1. Set the correct minSdkVersion in android/app/build.gradle (if it was previously lower than 20):

     android {
         defaultConfig {
             minSdkVersion 20
         }
     }
    
  2. Set WebView.platform = AndroidWebView(); in initState(). For example:

     import 'dart:io';
    
     import 'package:webview_flutter/webview_flutter.dart';
    
     class WebViewExample extends StatefulWidget {
       @override
       WebViewExampleState createState() => WebViewExampleState();
     }
    
     class WebViewExampleState extends State<WebViewExample> {
       @override
       void initState() {
         super.initState();
         // Enable virtual display.
         if (Platform.isAndroid) WebView.platform = AndroidWebView();
       }
    
       @override
       Widget build(BuildContext context) {
         return WebView(
           initialUrl: 'https://flutter.dev',
         );
       }
     }
    

Enable Material Components for Android #

To use Material Components when the user interacts with input elements in the WebView, follow the steps described in the Enabling Material Components instructions.

Setting custom headers on POST requests #

Currently, setting custom headers when making a post request with the WebViewController's loadRequest method is not supported on Android. If you require this functionality, a workaround is to make the request manually, and then load the response data using loadHTMLString instead.