Browse Source

chore: add deprecation notice for webPrefences defaults (#15045)

Samuel Attard 6 years ago
parent
commit
33abd736e9
1 changed files with 12 additions and 0 deletions
  1. 12 0
      docs/api/breaking-changes.md

+ 12 - 0
docs/api/breaking-changes.md

@@ -6,6 +6,18 @@ Breaking changes will be documented here, and deprecation warnings added to JS c
 
 The `FIXME` string is used in code comments to denote things that should be fixed for future releases. See https://github.com/electron/electron/search?q=fixme
 
+# Planned Breaking API Changes (5.0)
+
+## `new BrowserWindow({ webPreferences })`
+
+The following `webPreferences` option default values are deprecated in favor of the new defaults listed below.
+
+| Property | Deprecated Default | New Default |
+|----------|--------------------|-------------|
+| `contextIsolation` | `false` | `true` |
+| `nodeIntegration` | `true` | `false` |
+| `webviewTag` | `nodeIntegration` if set else `true` | `false` |
+
 
 # Planned Breaking API Changes (4.0)