From e21c70a9e09b6ae939e15a0d2353f4fe375872e5 Mon Sep 17 00:00:00 2001 From: "trop[bot]" <37223003+trop[bot]@users.noreply.github.com> Date: Sun, 26 May 2024 21:48:31 +0200 Subject: [PATCH] fix: fixed the type of `WebviewTag.webpreferences` (#42279) fix: fixed the type of WebviewTag.webpreferences Co-authored-by: trop[bot] <37223003+trop[bot]@users.noreply.github.com> Co-authored-by: EvolutionX <85353424+EvolutionX-10@users.noreply.github.com> --- docs/api/structures/web-preferences.md | 1 + docs/api/webview-tag.md | 4 +--- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/api/structures/web-preferences.md b/docs/api/structures/web-preferences.md index 9c6a3ecc8fc8..044cd2b2270b 100644 --- a/docs/api/structures/web-preferences.md +++ b/docs/api/structures/web-preferences.md @@ -143,6 +143,7 @@ contain the layout of the document—without requiring scrolling. Enabling this will cause the `preferred-size-changed` event to be emitted on the `WebContents` when the preferred size changes. Default is `false`. +* `transparent` boolean (optional) - Whether to enable background transparency for the guest page. Default is `true`. **Note:** The guest page's text and background colors are derived from the [color scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme) of its root element. When transparency is enabled, the text color will still change accordingly but the background will remain transparent. [chrome-content-scripts]: https://developer.chrome.com/extensions/content_scripts#execution-environment [runtime-enabled-features]: https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/platform/runtime_enabled_features.json5 diff --git a/docs/api/webview-tag.md b/docs/api/webview-tag.md index 99e740eb39a9..14103680f7f4 100644 --- a/docs/api/webview-tag.md +++ b/docs/api/webview-tag.md @@ -221,9 +221,7 @@ windows. Popups are disabled by default. ``` A `string` which is a comma separated list of strings which specifies the web preferences to be set on the webview. -The full list of supported preference strings can be found in [BrowserWindow](browser-window.md#new-browserwindowoptions). In addition, webview supports the following preferences: - -* `transparent` boolean (optional) - Whether to enable background transparency for the guest page. Default is `true`. **Note:** The guest page's text and background colors are derived from the [color scheme](https://developer.mozilla.org/en-US/docs/Web/CSS/color-scheme) of its root element. When transparency is enabled, the text color will still change accordingly but the background will remain transparent. +The full list of supported preference strings can be found in [BrowserWindow](browser-window.md#new-browserwindowoptions). The string follows the same format as the features string in `window.open`. A name by itself is given a `true` boolean value.