feat: Expose ability to enable browser extensions in WebView2 (#1356)

SpikeHD · web-flow · commit b863d38ff705 · 2024-09-08T04:55:29.000+03:00
* feat: with_browser_extensions_enabled

* fix: typo

* fix: add file in .changes
diff --git a/.changes/change-pr-1356.md b/.changes/change-pr-1356.md
@@ -0,0 +1,5 @@
+---
+"wry": patch
+---
+
+Expose ability to enable browser extensions in WebView2
diff --git a/src/lib.rs b/src/lib.rs
@@ -1091,6 +1091,7 @@ pub(crate) struct PlatformSpecificWebViewAttributes {
   theme: Option<Theme>,
   use_https: bool,
   scroll_bar_style: ScrollBarStyle,
+  browser_extensions_enabled: bool,
 }
 
 #[cfg(windows)]
@@ -1102,6 +1103,7 @@ impl Default for PlatformSpecificWebViewAttributes {
       theme: None,
       use_https: false, // To match macOS & Linux behavior in the context of mixed content.
       scroll_bar_style: ScrollBarStyle::default(),
+      browser_extensions_enabled: false,
     }
   }
 }
@@ -1153,6 +1155,14 @@ pub trait WebViewBuilderExtWindows {
   /// Requires WebView2 Runtime version 125.0.2535.41 or higher, does nothing on older versions,
   /// see https://learn.microsoft.com/en-us/microsoft-edge/webview2/release-notes/?tabs=dotnetcsharp#10253541
   fn with_scroll_bar_style(self, style: ScrollBarStyle) -> Self;
+
+  /// Determines whether the ability to install and enable extensions is enabled.
+  ///
+  /// By default, extensions are disabled.
+  ///
+  /// Requires WebView2 Runtime version 1.0.2210.55 or higher, does nothing on older versions,
+  /// see https://learn.microsoft.com/en-us/microsoft-edge/webview2/release-notes/archive?tabs=dotnetcsharp#10221055
+  fn with_browser_extensions_enabled(self, enabled: bool) -> Self;
 }
 
 #[cfg(windows)]
@@ -1181,6 +1191,11 @@ impl WebViewBuilderExtWindows for WebViewBuilder<'_> {
     self.platform_specific.scroll_bar_style = style;
     self
   }
+
+  fn with_browser_extensions_enabled(mut self, enabled: bool) -> Self {
+    self.platform_specific.browser_extensions_enabled = enabled;
+    self
+  }
 }
 
 #[cfg(target_os = "android")]
diff --git a/src/webview2/mod.rs b/src/webview2/mod.rs
@@ -293,6 +293,7 @@ impl InnerWebView {
         let options = CoreWebView2EnvironmentOptions::default();
 
         options.set_additional_browser_arguments(additional_browser_args);
+        options.set_are_browser_extensions_enabled(pl_attrs.browser_extensions_enabled);
 
         // Get user's system language
         let lcid = GetUserDefaultUILanguage();

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"wry": patch
 +---
++
 +Expose ability to enable browser extensions in WebView2
Original file line number	Diff line number	Diff line change
`@@ -1091,6 +1091,7 @@ pub(crate) struct PlatformSpecificWebViewAttributes {`
`1091`	`1091`	`theme: Option<Theme>,`
`1092`	`1092`	`use_https: bool,`
`1093`	`1093`	`scroll_bar_style: ScrollBarStyle,`
	`1094`	`+ browser_extensions_enabled: bool,`
`1094`	`1095`	`}`
`1095`	`1096`
`1096`	`1097`	`#[cfg(windows)]`
`@@ -1102,6 +1103,7 @@ impl Default for PlatformSpecificWebViewAttributes {`
`1102`	`1103`	`theme: None,`
`1103`	`1104`	`use_https: false, // To match macOS & Linux behavior in the context of mixed content.`
`1104`	`1105`	`scroll_bar_style: ScrollBarStyle::default(),`
	`1106`	`+ browser_extensions_enabled: false,`
`1105`	`1107`	`}`
`1106`	`1108`	`}`
`1107`	`1109`	`}`
`@@ -1153,6 +1155,14 @@ pub trait WebViewBuilderExtWindows {`
`1153`	`1155`	`/// Requires WebView2 Runtime version 125.0.2535.41 or higher, does nothing on older versions,`
`1154`	`1156`	`/// see https://learn.microsoft.com/en-us/microsoft-edge/webview2/release-notes/?tabs=dotnetcsharp#10253541`
`1155`	`1157`	`fn with_scroll_bar_style(self, style: ScrollBarStyle) -> Self;`
	`1158`	`+`
	`1159`	`+ /// Determines whether the ability to install and enable extensions is enabled.`
	`1160`	`+ ///`
	`1161`	`+ /// By default, extensions are disabled.`
	`1162`	`+ ///`
	`1163`	`+ /// Requires WebView2 Runtime version 1.0.2210.55 or higher, does nothing on older versions,`
	`1164`	`+ /// see https://learn.microsoft.com/en-us/microsoft-edge/webview2/release-notes/archive?tabs=dotnetcsharp#10221055`
	`1165`	`+ fn with_browser_extensions_enabled(self, enabled: bool) -> Self;`
`1156`	`1166`	`}`
`1157`	`1167`
`1158`	`1168`	`#[cfg(windows)]`
`@@ -1181,6 +1191,11 @@ impl WebViewBuilderExtWindows for WebViewBuilder<'_> {`
`1181`	`1191`	`self.platform_specific.scroll_bar_style = style;`
`1182`	`1192`	`self`
`1183`	`1193`	`}`
	`1194`	`+`
	`1195`	`+ fn with_browser_extensions_enabled(mut self, enabled: bool) -> Self {`
	`1196`	`+ self.platform_specific.browser_extensions_enabled = enabled;`
	`1197`	`+ self`
	`1198`	`+ }`
`1184`	`1199`	`}`
`1185`	`1200`
`1186`	`1201`	`#[cfg(target_os = "android")]`