[webview_flutter] Add interface methods to load local files and HTML strings. #4446

mvanbeusekom · 2021-10-22T15:34:42Z

Adds methods to the webview_flutter_platform_interface package to support loading content from local files and HTML string directly.

Related to issues:

If you had to change anything in the flutter/tests repo, include a link to the migration guide as per the breaking change policy.

Pre-launch Checklist

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Adds methods to the webview_flutter_platform_interface to support loading content from Flutter asset defined in the pubspec.yaml of directly from HTML string.

stuartmorgan · 2021-10-27T14:51:59Z

...lutter/webview_flutter_platform_interface/lib/src/method_channel/webview_method_channel.dart

+  Future<void> loadFlutterAsset(String assetName) async {
+    assert(assetName != null);
+    return _channel.invokeMethod<void>('loadFlutterAsset', assetName);
+  }


You've listed issues for both assets and arbitrary local files in the PR description; why are we restricting to assets here?

It's not clear to me that we should actually support assets on a per-plugin basis, in fact, since there are other cases where someone may want asset paths (e.g., FFI). It might make more sense to just support file paths, and then have a dedicated plugin (or maybe a function in path_provider) to get asset paths.

As far as I know, it is not possible to load files in the WKWebView control that live outside the application bundle (due to security reasons). By only allowing loading of Flutter assets you force developers to add their HTML files as part of the iOS bundle ensuring that the file is always available and can be loaded.

This might be a bit restrictive to other platforms however I think it will cover most use cases where people wish to load local files. At least that was my reasoning.

As far as I know, it is not possible to load files in the WKWebView control that live outside the application bundle (due to security reasons).

Do you have a source for that? It's not a documented restriction of the file-loading API.

This might be a bit restrictive to other platforms however I think it will cover most use cases where people wish to load local files. At least that was my reasoning.

One of the issues you linked is explicitly about a use case where assets wouldn't work; I don't think we have any data on how common one or the other use case is.

No I don't have any documentation to back that up. And there are indeed samples that allow you to load information from for example the Documents directory. My bad.

I will update the interface to accept an absolute file path instead.

Done. I those to accept only the absolute file path as that seems to be the easiest way to work cross platform.

On Android the WebView.loadUrl method requires the path to be prefixed with file:// (which we can take care of internally).

The [WKWebView loadFileURL:] only accepts an instance of the NSURL class which can easily be created from the absolute path using the [NSURL fileURLWithPath:] method.

stuartmorgan · 2021-10-27T14:52:37Z

...lutter/webview_flutter_platform_interface/lib/src/method_channel/webview_method_channel.dart

+  }
+
+  @override
+  Future<void> loadHtml(


How about loadHtmlString; we expect all of the mechanism for loading to provide HTML so this seems confusingly vague.

stuartmorgan

LGTM

packages/webview_flutter/webview_flutter_platform_interface/CHANGELOG.md

fluttergithubbot · 2021-10-27T17:53:08Z

This pull request is not suitable for automatic merging in its current state.

The status or check suite android-platform_tests has failed. Please fix the issues identified (or deflake) before re-applying this label.

…nd HTML strings. (flutter/plugins#4446)

* master: [webview_flutter] Deprecate evaluateJavascript in favour of runJavaScript and runJavaScriptForResult. (flutter#4403) [webview_flutter] Add interface methods to load local files and HTML strings. (flutter#4446) [ci] add pedantic dep to new in_app_purchase pkgs (flutter#4471) [ci] Remove unused dep from file_selector. (flutter#4468) [ci] update build_runner dep in android_intent and file_selector example (flutter#4467) [webview_flutter] Add platform interface method `loadRequest`. (flutter#4450) Remove -Werror from deprecated plugin Android builds (flutter#4466) [webview_flutter] Update webview packages for Android and iOS to implement `runJavascript` and `runJavascriptReturningResult`. (flutter#4402) [camera] Fix CamcorderProfile Usages (flutter#4423) [google_sign_in] Use a transparent image as a placeholder for the `GoogleUserCircleAvatar` (flutter#4391) [in_app_purchase]IAP/platform interface add cancel status (flutter#4093) [image_picker] doc:readme image picker misprints (flutter#4421) Support Hybrid Composition through the GoogleMaps Widget (flutter#4082) [path_provider] started supporting background platform channels (flutter#4443) [device_info] started using Background Platform Channels (flutter#4456) # Conflicts: # packages/webview_flutter/webview_flutter/CHANGELOG.md # packages/webview_flutter/webview_flutter/pubspec.yaml

…strings. (flutter#4446) * Add methods to load HTML and Flutter assets. Adds methods to the webview_flutter_platform_interface to support loading content from Flutter asset defined in the pubspec.yaml of directly from HTML string. * Renamed loadHtml to loadHtmlString * Support loading arbitrary files instead of only Flutter assets * Update changelog description * Fix formatting * Fix formatting

Add methods to load HTML and Flutter assets.

4b7a63f

Adds methods to the webview_flutter_platform_interface to support loading content from Flutter asset defined in the pubspec.yaml of directly from HTML string.

google-cla bot added the cla: yes label Oct 22, 2021

github-actions bot added the p: webview_flutter Edits files for a webview_flutter plugin label Oct 22, 2021

mvanbeusekom requested review from stuartmorgan and bparrishMines October 26, 2021 07:30

stuartmorgan suggested changes Oct 27, 2021

View reviewed changes

mvanbeusekom added 2 commits October 27, 2021 17:09

Renamed loadHtml to loadHtmlString

3151008

Support loading arbitrary files instead of only Flutter assets

0f28905

mvanbeusekom force-pushed the feature/webview_load_asset branch from 9b08218 to 0f28905 Compare October 27, 2021 16:15

mvanbeusekom requested a review from stuartmorgan October 27, 2021 16:15

stuartmorgan approved these changes Oct 27, 2021

View reviewed changes

packages/webview_flutter/webview_flutter_platform_interface/CHANGELOG.md Outdated Show resolved Hide resolved

Update changelog description

7a0c69a

mvanbeusekom changed the title ~~[webview_flutter] Add interface methods to load HTML and Flutter assets.~~ [webview_flutter] Add interface methods to load local files and HTML strings. Oct 27, 2021

mvanbeusekom added the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label Oct 27, 2021

fluttergithubbot removed the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label Oct 27, 2021

Merge branch 'master' into feature/webview_load_asset

c126eb6

stuartmorgan mentioned this pull request Nov 1, 2021

[webview_flutter] Expose loadData function for webviews #4462

Closed

11 tasks

Rebase with master

7a59328

mvanbeusekom added the waiting for tree to go green (Use "autosubmit") This PR is approved and tested, but waiting for the tree to be green to land. label Nov 4, 2021

github-actions bot added the platform-ios label Nov 4, 2021

Fix formatting

b2efaa8

mvanbeusekom force-pushed the feature/webview_load_asset branch from 38c0578 to d905be9 Compare November 4, 2021 14:16

Fix formatting

0f70b11

mvanbeusekom force-pushed the feature/webview_load_asset branch from d905be9 to 0f70b11 Compare November 4, 2021 14:26

github-actions bot removed the platform-ios label Nov 4, 2021

mvanbeusekom merged commit e39a584 into flutter:master Nov 4, 2021

mvanbeusekom deleted the feature/webview_load_asset branch November 4, 2021 15:04

engine-flutter-autoroll mentioned this pull request Nov 4, 2021

Roll Plugins from 2e102b8a8c41 to e39a584ab08e (1 revision) flutter/flutter#93060

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Nov 4, 2021

e39a584 [webview_flutter] Add interface methods to load local files a…

4694659

…nd HTML strings. (flutter/plugins#4446)

Wian-TMC mentioned this pull request Nov 5, 2021

[webview_flutter] Cannot access webview changes brought by pull request #4446 flutter/flutter#93139

Closed

mvanbeusekom mentioned this pull request Nov 8, 2021

[webview_flutter] Implementations of loadFile and loadHtmlString for WKWebView #4486

Merged

11 tasks

This was referenced Nov 16, 2021

[webview_flutter] Fix issue where local and asset HTML files cannot be loaded #3693

Closed

[webview_flutter] local html and baseUrl support #2830

Closed

mvanbeusekom mentioned this pull request Nov 25, 2021

[webview_flutter] Android implementation of loadFile and loadHtmlString methods #4544

Merged

11 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[webview_flutter] Add interface methods to load local files and HTML strings. #4446

[webview_flutter] Add interface methods to load local files and HTML strings. #4446

mvanbeusekom commented Oct 22, 2021 •

edited

Loading

stuartmorgan Oct 27, 2021

mvanbeusekom Oct 27, 2021

stuartmorgan Oct 27, 2021

mvanbeusekom Oct 27, 2021

mvanbeusekom Oct 27, 2021 •

edited

Loading

stuartmorgan Oct 27, 2021

mvanbeusekom Oct 27, 2021

stuartmorgan left a comment

fluttergithubbot commented Oct 27, 2021

[webview_flutter] Add interface methods to load local files and HTML strings. #4446

[webview_flutter] Add interface methods to load local files and HTML strings. #4446

Conversation

mvanbeusekom commented Oct 22, 2021 • edited Loading

Pre-launch Checklist

stuartmorgan Oct 27, 2021

Choose a reason for hiding this comment

mvanbeusekom Oct 27, 2021

Choose a reason for hiding this comment

stuartmorgan Oct 27, 2021

Choose a reason for hiding this comment

mvanbeusekom Oct 27, 2021

Choose a reason for hiding this comment

mvanbeusekom Oct 27, 2021 • edited Loading

Choose a reason for hiding this comment

stuartmorgan Oct 27, 2021

Choose a reason for hiding this comment

mvanbeusekom Oct 27, 2021

Choose a reason for hiding this comment

stuartmorgan left a comment

Choose a reason for hiding this comment

fluttergithubbot commented Oct 27, 2021

mvanbeusekom commented Oct 22, 2021 •

edited

Loading

mvanbeusekom Oct 27, 2021 •

edited

Loading