74 lines
5.8 KiB
Markdown
Executable File
74 lines
5.8 KiB
Markdown
Executable File
# Flutter InAppWebView Plugin [](https://twitter.com/intent/tweet?text=Flutter%20InAppBrowser%20plugin!&url=https://github.com/pichillilorenzo/flutter_inappwebview&hashtags=flutter,flutterio,dart,dartlang,webview) [](https://www.facebook.com/sharer/sharer.php?u=https%3A//github.com/pichillilorenzo/flutter_inappwebview)
|
|
|
|
[](https://pub.dartlang.org/packages/flutter_inappwebview)
|
|
[](https://pub.dev/packages/flutter_inappwebview/score)
|
|
[](https://pub.dev/packages/flutter_inappwebview/score)
|
|
[](https://pub.dev/packages/flutter_inappwebview/score)
|
|
[](https://stackoverflow.com/questions/tagged/flutter-inappwebview)
|
|
[](/LICENSE)
|
|
|
|
[](https://inappwebview.dev/donate/)
|
|
[](https://github.com/pichillilorenzo/flutter_inappwebview/graphs/contributors)
|
|
[](https://github.com/pichillilorenzo/flutter_inappwebview)
|
|
[](https://github.com/pichillilorenzo/flutter_inappwebview)
|
|
|
|
|
|
|
|
|
|
A Flutter plugin that allows you to add an inline webview, to use an headless webview, and to open an in-app browser window.
|
|
|
|
## Articles/Resources
|
|
|
|
- [Official documentation: inappwebview.dev/docs](https://inappwebview.dev/docs/)
|
|
- Read the online [API Reference](https://pub.dartlang.org/documentation/flutter_inappwebview/latest/) to get the **full API documentation**.
|
|
- [Official blog: inappwebview.dev/blog](https://inappwebview.dev/blog/)
|
|
- Find open source projects on the [Official Showcase page: inappwebview.dev/showcase](https://inappwebview.dev/showcase/)
|
|
- Check the [example/integration_test/webview_flutter_test.dart](https://github.com/pichillilorenzo/flutter_inappwebview/blob/master/example/integration_test/webview_flutter_test.dart) file for other code examples
|
|
- [Flutter Browser App](https://github.com/pichillilorenzo/flutter_browser_app): A Full-Featured Mobile Browser App (such as the Google Chrome mobile browser) created using Flutter and the features offered by the flutter_inappwebview plugin
|
|
|
|
## Showcase - Who use it
|
|
|
|
Check the [Showcase](https://inappwebview.dev/showcase/) page to see an open list of Apps built with **Flutter** and **Flutter InAppWebView**.
|
|
|
|
#### Are you using the **Flutter InAppWebView** plugin and would you like to add your App there?
|
|
|
|
Send a submission request to the [Submit App](https://inappwebview.dev/submit-app/) page!
|
|
|
|
## Requirements
|
|
|
|
- Dart sdk: ">=2.14.0 <3.0.0"
|
|
- Flutter: ">=2.5.0"
|
|
- Android: `minSdkVersion 17` and add support for `androidx` (see [AndroidX Migration](https://flutter.dev/docs/development/androidx-migration) to migrate an existing app)
|
|
- iOS: `--ios-language swift`, Xcode version `>= 12`
|
|
|
|
## Installation
|
|
|
|
Add `flutter_inappwebview` as a [dependency in your pubspec.yaml file](https://flutter.io/using-packages/).
|
|
|
|
### Installation - Web support
|
|
|
|
To make it work properly on the Web platformm, you need to add the `web_support.js` file inside the `<head>` of your `web/index.html` file:
|
|
|
|
```html
|
|
<head>
|
|
<!-- ... -->
|
|
<script src="/packages/flutter_inappwebview/assets/web/web_support.js" defer></script>
|
|
<!-- ... -->
|
|
</head>
|
|
```
|
|
|
|
## Main Classes Overview
|
|
|
|
* [InAppWebView](https://inappwebview.dev/docs/in-app-webview/basic-usage/): Flutter Widget for adding an inline native WebView integrated into the flutter widget tree.
|
|
* [ContextMenu](https://inappwebview.dev/docs/context-menu/basic-usage/): This class represents the WebView context menu.
|
|
* [HeadlessInAppWebView](https://inappwebview.dev/docs/headless-in-app-webview/basic-usage/): Class that represents a WebView in headless mode. It can be used to run a WebView in background without attaching an InAppWebView to the widget tree.
|
|
* [InAppBrowser](https://inappwebview.dev/docs/in-app-browser/basic-usage/): In-App Browser using native WebView.
|
|
* [ChromeSafariBrowser](https://inappwebview.dev/docs/chrome-safari-browser/basic-usage/): In-App Browser using Chrome Custom Tabs on Android / SFSafariViewController on iOS.
|
|
* [InAppLocalhostServer](https://inappwebview.dev/docs/in-app-localhost-server/basic-usage/): This class allows you to create a simple server on http://localhost:[port]/. The default port value is 8080.
|
|
* [CookieManager](https://inappwebview.dev/docs/cookie-manager/basic-usage/): This class implements a singleton object (shared instance) which manages the cookies used by WebView instances.
|
|
* [HttpAuthCredentialDatabase](https://inappwebview.dev/docs/http-auth-credential-database/basic-usage/): This class implements a singleton object (shared instance) that manages the shared HTTP auth credentials cache.
|
|
* [WebStorageManager](https://inappwebview.dev/docs/web-storage-manager/basic-usage/): This class implements a singleton object (shared instance) which manages the web storage used by WebView instances.
|
|
|
|
## Support
|
|
|
|
Did you find this plugin useful? Please consider to [make a donation](https://inappwebview.dev/donate/) to help improve it! |