[webview] Add macOS support in implementation package #6221

stuartmorgan-g · 2024-02-28T21:06:46Z

Adds initial support for macOS.

Known limitations:

Scroll APIs are not supported, and currently throw unimplemented. Longer term we could consider JS polyfills, but we'd probably want to make them opt-in since injecting JS into every page has some risks.
Setting the background color doesn't work since the view structure is different on macOS. We may be able to use a layer-backed view to support this in the future.

Since many use cases don't require these features, my preference is to land this without that support, rather than blocking on having full parity, and then the specific features can be added later based on community interest (demand and/or contributions).

This requires 3.24, as 3.22 does not yet have gesture support for macOS platform views, and pushing this to users without gesture support would be very confusing.

Part of flutter/flutter#41725

stuartmorgan-g · 2024-02-28T21:08:53Z

packages/webview_flutter/webview_flutter_wkwebview/lib/src/ui_kit/ui_kit.dart

@bparrishMines I'm curious what you think of this approach to handle the fact that WKWebView has a different base class on iOS vs macOS.

I like this approach for sharing code between the platforms. Especially the part of creating a platform agnostic WKWebView class. I can also see this working if we need to add the NSView class for macOS. Although I'm not sure how this translates for the Pigeon wrapper generator since the Dart classes would become completely generated.

stuartmorgan-g · 2024-02-28T21:10:11Z

packages/webview_flutter/webview_flutter_wkwebview/lib/src/webkit_proxy.dart

-  const WebKitProxy({
-    this.createWebView = WKWebView.new,
+  WebKitProxy({
+    WebViewConstructor? createWebView,


@bparrishMines Unfortunately I had to make this non-const because of the Platform switch. Better ideas welcome!

You should be able to set this with a constant Function. Either by putting (Platform.isIOS ? WKWebViewIOS.new : WKWebViewMacOS.new); in a static method or a top-level function.

I've also have been waiting for this feature! : dart-lang/language#1048

Thanks for the tip! I've re-added the consts I removed.

Unfortunately I had to duplicate all the arguments, because I couldn't make a static function that returned Platform.isIOS ? WKWebViewIOS.new : WKWebViewMacOS.new and then call that because it still didn't want me calling the function in the const constructor, so I had to instead make it a wrapper that calls the right constructor each time, passing all the args through. (If I missed a way to make that work please let me know!)

stuartmorgan-g · 2024-02-28T21:11:02Z

packages/webview_flutter/webview_flutter_wkwebview/lib/src/web_kit/web_kit.dart

-  Future<String?> getCustomUserAgent() {
-    return _webViewApi.getCustomUserAgentForInstances(this);
+/// The iOS version of a WKWebView.
+class WKWebViewIOS extends WKWebView implements UIView {


@bparrishMines This is the other half of how I'm handling the different parenting: the non-abstract classes are these subclasses which are different for the two platforms.

stuartmorgan-g · 2024-08-07T16:20:21Z

This is blocked on Flutter main reporting a version number higher than 3.24 (and that change rolling into this repo).

igor-lukyanov · 2024-08-14T06:18:46Z

@stuartmorgan Does this mean that the branch will be merged into a future version of Flutter, not 3.24? We're looking forward to using macos webview in one of our projects, so I'm trying to understand the future of it to adjust our own expectations or start looking for a workaround. Thank you very much.

stuartmorgan-g · 2024-08-14T09:36:48Z

Does this mean that the branch will be merged into a future version of Flutter, not 3.24?

webview_flutter is a package that's published to pub.dev, not a part of the Flutter SDK; it won't be merged into any version of Flutter.

alterhuman · 2024-08-15T18:09:01Z

Does this mean that the branch will be merged into a future version of Flutter, not 3.24?

webview_flutter is a package that's published to pub.dev, not a part of the Flutter SDK; it won't be merged into any version of Flutter.

@stuartmorgan they mean when will the package webview_flutter be updated with macOS support. I have the same question to prioritise feature development order in my flutter app.

stuartmorgan-g · 2024-08-15T18:22:02Z

@stuartmorgan they mean when will the package webview_flutter be updated with macOS support.

I'm not going to assume that I know that someone means something very different from what they said, so I answered the question they actually asked.

I have the same question to prioritise feature development order in my flutter app.

It will land when it's no longer blocked; see my recent comment.

wanjm · 2024-08-17T00:29:32Z

This is blocked on Flutter main reporting a version number higher than 3.24 (and that change rolling into this repo).

what do you expected the version number to be on the branch main? @stuartmorgan

…r/packages#6221)

flutter/packages@7c1a05c...4d2d2e3 2024-08-20 [email protected] [webview] Add macOS support in implementation package (flutter/packages#6221) 2024-08-19 [email protected] Roll Flutter from a0c0453 to 6a28048 (22 revisions) (flutter/packages#7449) 2024-08-19 [email protected] [ci] Remove scorecard action (flutter/packages#7450) 2024-08-19 [email protected] [camerax] Re-land SurfaceProducer migration with fix for camera preview rotation (flutter/packages#6856) 2024-08-19 49699333+dependabot[bot]@users.noreply.github.com [camera]: Bump com.google.guava:guava from 33.2.1-android to 33.3.0-android in /packages/camera/camera_android_camerax/android (flutter/packages#7441) 2024-08-19 49699333+dependabot[bot]@users.noreply.github.com [sign_in]: Bump com.google.guava:guava from 33.2.1-android to 33.3.0-android in /packages/google_sign_in/google_sign_in_android/android (flutter/packages#7442) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

Bump Xcode analyze minimum check version iOS 13 -> iOS 14 and macOS 12.3 -> macOS 13. - Hit StoreKit2 deprecations. Exclude `in_app_purchase_storekit` to work around StoreKit 1 deprecation warnings. Added a TODO to remove the exclusion when StoreKit2 is adopted (this should happen in the next few weeks) flutter/flutter#116383. - Hit flutter/flutter#153587, fixed in #7513 - Hit flutter/flutter#125901 which was `#pragma`'d out in #6221 See related flutter/plugins#5778 and flutter/flutter#102835

flutter/packages@7c1a05c...4d2d2e3 2024-08-20 [email protected] [webview] Add macOS support in implementation package (flutter/packages#6221) 2024-08-19 [email protected] Roll Flutter from a0c0453 to 6a28048 (22 revisions) (flutter/packages#7449) 2024-08-19 [email protected] [ci] Remove scorecard action (flutter/packages#7450) 2024-08-19 [email protected] [camerax] Re-land SurfaceProducer migration with fix for camera preview rotation (flutter/packages#6856) 2024-08-19 49699333+dependabot[bot]@users.noreply.github.com [camera]: Bump com.google.guava:guava from 33.2.1-android to 33.3.0-android in /packages/camera/camera_android_camerax/android (flutter/packages#7441) 2024-08-19 49699333+dependabot[bot]@users.noreply.github.com [sign_in]: Bump com.google.guava:guava from 33.2.1-android to 33.3.0-android in /packages/google_sign_in/google_sign_in_android/android (flutter/packages#7442) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages-flutter-autoroll Please CC [email protected],[email protected] on the revert to ensure that a human is aware of the problem. To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://issues.skia.org/issues/new?component=1389291&template=1850622 Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

stuartmorgan-g added 23 commits April 11, 2023 15:25

Add macOS support to example app

4903531

darwinify

2d412c0

Manually change includes; needs Pigeon fix

2f64c9d

Add missing entitlements

f96790c

Automatic changes from running

ce8c088

Get minimal PoC running

e3e5949

Add another TODO with issue reference

c5cd904

Merge branch 'main' into webview-macos

363a6d5

Remove the args hack

ee1f657

Update minimum version

18985c5

Update availability annotations

1912347

Merge branch 'main' into webview-macos

c70fb10

Remove the publish workaround

e99093d

Remove obsolete stub

3969dcc

Enable valuePublishedByPlugin codepath

6f703af

Comment some ifdefs

10df466

Change the way UIView removal works

29c5a6e

Use AppKitView

4c1ff63

Merge branch 'main' into webview-macos

56a8e5d

Merge branch 'main' into webview-macos

6f41e08

Resolve UIView issue

3c98078

Add back background color on iOS

aa15792

Merge branch 'main' into webview-macos

b530bf9

stuartmorgan-g requested a review from hellohuanlin as a code owner February 28, 2024 21:06

github-actions bot added platform-ios platform-macos p: webview_flutter labels Feb 28, 2024

stuartmorgan-g commented Feb 28, 2024

View reviewed changes

stuartmorgan-g force-pushed the webview-macos branch from f2854bf to ad794b4 Compare August 7, 2024 14:42

github-actions bot removed p: pointer_interceptor p: flutter_adaptive_scaffold p: camera p: file_selector p: google_maps_flutter p: image_picker platform-web p: video_player p: shared_preferences labels Aug 7, 2024

stuartmorgan-g removed request for ditman, gspencergoog and tarrinneal August 7, 2024 14:44

stuartmorgan-g added 2 commits August 19, 2024 11:09

Merge branch 'main' into webview-macos

df24e12

Merge branch 'main' into webview-macos

68d4f1d

stuartmorgan-g added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 20, 2024

auto-submit bot merged commit 4d2d2e3 into flutter:main Aug 20, 2024
76 checks passed

engine-flutter-autoroll mentioned this pull request Aug 20, 2024

Roll Packages from 7c1a05c8b122 to 4d2d2e38a536 (6 revisions) flutter/flutter#153763

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Aug 20, 2024

4d2d2e3 [webview] Add macOS support in implementation package (flutte…

1a34a58

…r/packages#6221)

This was referenced Aug 26, 2024

[webview_flutter_wkwebview] -[WKPreferences javaScriptEnabled] is deprecated in iOS 14 flutter/flutter#125901

Closed

Increase deprecation check minimum to iOS 14 and macOS 13 #7431

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[webview] Add macOS support in implementation package #6221

[webview] Add macOS support in implementation package #6221

stuartmorgan-g commented Feb 28, 2024 •

edited

Loading

stuartmorgan-g Feb 28, 2024

bparrishMines Mar 4, 2024

stuartmorgan-g Feb 28, 2024

bparrishMines Mar 4, 2024

stuartmorgan-g Apr 29, 2024

stuartmorgan-g Feb 28, 2024

stuartmorgan-g commented Aug 7, 2024

igor-lukyanov commented Aug 14, 2024 •

edited

Loading

stuartmorgan-g commented Aug 14, 2024

alterhuman commented Aug 15, 2024

stuartmorgan-g commented Aug 15, 2024

wanjm commented Aug 17, 2024 •

edited

Loading

[webview] Add macOS support in implementation package #6221

[webview] Add macOS support in implementation package #6221

Conversation

stuartmorgan-g commented Feb 28, 2024 • edited Loading

stuartmorgan-g Feb 28, 2024

Choose a reason for hiding this comment

bparrishMines Mar 4, 2024

Choose a reason for hiding this comment

stuartmorgan-g Feb 28, 2024

Choose a reason for hiding this comment

bparrishMines Mar 4, 2024

Choose a reason for hiding this comment

stuartmorgan-g Apr 29, 2024

Choose a reason for hiding this comment

stuartmorgan-g Feb 28, 2024

Choose a reason for hiding this comment

stuartmorgan-g commented Aug 7, 2024

igor-lukyanov commented Aug 14, 2024 • edited Loading

stuartmorgan-g commented Aug 14, 2024

alterhuman commented Aug 15, 2024

stuartmorgan-g commented Aug 15, 2024

wanjm commented Aug 17, 2024 • edited Loading

stuartmorgan-g commented Feb 28, 2024 •

edited

Loading

igor-lukyanov commented Aug 14, 2024 •

edited

Loading

wanjm commented Aug 17, 2024 •

edited

Loading