Browse Source

docs: add remote removal to E14 breaking changes (#30771)

* docs: add remote removal to E14 breaking changes

* docs: trigger lint check

Co-authored-by: Keeley Hammond <[email protected]>
trop[bot] 3 years ago
parent
commit
663a260976
1 changed files with 21 additions and 2 deletions
  1. 21 2
      docs/breaking-changes.md

+ 21 - 2
docs/breaking-changes.md

@@ -26,6 +26,25 @@ for more details.
 
 ## Planned Breaking API Changes (14.0)
 
+### Removed: `remote` module
+
+The `remote` module was deprecated in Electron 12, and will be removed in
+Electron 14. It is replaced by the
+[`@electron/remote`](https://github.com/electron/remote) module.
+
+```js
+// Deprecated in Electron 12:
+const { BrowserWindow } = require('electron').remote
+```
+
+```js
+// Replace with:
+const { BrowserWindow } = require('@electron/remote')
+
+// In the main process:
+require('@electron/remote/main').initialize()
+```
+
 ### Removed: `app.allowRendererProcessReuse`
 
 The `app.allowRendererProcessReuse` property will be removed as part of our plan to
@@ -49,8 +68,8 @@ If you were using this parameter to set the title of a window, you can instead u
 
 ### Removed: `worldSafeExecuteJavaScript`
 
-In Electron 14, `worldSafeExecuteJavaScript` will be removed.  There is no alternative, please
-ensure your code works with this property enabled.  It has been enabled by default since Electron
+In Electron 14, `worldSafeExecuteJavaScript` will be removed. There is no alternative, please
+ensure your code works with this property enabled. It has been enabled by default since Electron
 12.
 
 You will be affected by this change if you use either `webFrame.executeJavaScript` or `webFrame.executeJavaScriptInIsolatedWorld`. You will need to ensure that values returned by either of those methods are supported by the [Context Bridge API](api/context-bridge.md#parameter--error--return-type-support) as these methods use the same value passing semantics.