@overwolf/ow-electron 37.7.0 → 37.10.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/checksums.json +10 -10
- package/electron-api.json +371 -322
- package/electron.d.ts +61 -3
- package/ow-electron.d.ts +1 -1
- package/package.json +3 -3
package/electron-api.json
CHANGED
|
@@ -4,8 +4,8 @@
|
|
|
4
4
|
"description": "> Control your application's event lifecycle.\n\nProcess: Main\n\nThe following example shows how to quit the application when the last window is closed:",
|
|
5
5
|
"slug": "app",
|
|
6
6
|
"websiteUrl": "https://electronjs.org/docs/api/app",
|
|
7
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
8
|
-
"version": "37.
|
|
7
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/app.md",
|
|
8
|
+
"version": "37.10.3",
|
|
9
9
|
"type": "Module",
|
|
10
10
|
"process": {
|
|
11
11
|
"main": true,
|
|
@@ -1166,6 +1166,18 @@
|
|
|
1166
1166
|
"additionalTags": [],
|
|
1167
1167
|
"urlFragment": "#appdisablehardwareacceleration"
|
|
1168
1168
|
},
|
|
1169
|
+
{
|
|
1170
|
+
"name": "isHardwareAccelerationEnabled",
|
|
1171
|
+
"signature": "()",
|
|
1172
|
+
"description": "whether hardware acceleration is currently disabled.\n\n> [!NOTE] This information is only usable after the `gpu-info-update` event is emitted.",
|
|
1173
|
+
"parameters": [],
|
|
1174
|
+
"returns": {
|
|
1175
|
+
"collection": false,
|
|
1176
|
+
"type": "boolean"
|
|
1177
|
+
},
|
|
1178
|
+
"additionalTags": [],
|
|
1179
|
+
"urlFragment": "#appishardwareaccelerationenabled"
|
|
1180
|
+
},
|
|
1169
1181
|
{
|
|
1170
1182
|
"name": "disableDomainBlockingFor3DAPIs",
|
|
1171
1183
|
"signature": "()",
|
|
@@ -1637,7 +1649,7 @@
|
|
|
1637
1649
|
{
|
|
1638
1650
|
"name": "setAccessibilitySupportEnabled",
|
|
1639
1651
|
"signature": "(enabled)",
|
|
1640
|
-
"description": "Manually enables Chrome's accessibility support, allowing to expose accessibility switch to users in application settings. See Chromium's accessibility docs for more details. Disabled by default.\n\nThis API must be called after the `ready` event is emitted.\n\n> [!NOTE] Rendering accessibility tree can significantly affect the performance of your app. It should not be enabled by default.",
|
|
1652
|
+
"description": "Manually enables Chrome's accessibility support, allowing to expose accessibility switch to users in application settings. See Chromium's accessibility docs for more details. Disabled by default.\n\nThis API must be called after the `ready` event is emitted.\n\n> [!NOTE] Rendering accessibility tree can significantly affect the performance of your app. It should not be enabled by default. Calling this method will enable the following accessibility support features: `nativeAPIs`, `webContents`, `inlineTextBoxes`, and `extendedProperties`.",
|
|
1641
1653
|
"parameters": [
|
|
1642
1654
|
{
|
|
1643
1655
|
"name": "enabled",
|
|
@@ -1654,6 +1666,43 @@
|
|
|
1654
1666
|
],
|
|
1655
1667
|
"urlFragment": "#appsetaccessibilitysupportenabledenabled-macos-windows"
|
|
1656
1668
|
},
|
|
1669
|
+
{
|
|
1670
|
+
"name": "getAccessibilitySupportFeatures",
|
|
1671
|
+
"signature": "()",
|
|
1672
|
+
"description": "Array of strings naming currently enabled accessibility support components. Possible values:\n\n* `nativeAPIs` - Native OS accessibility APIs integration enabled.\n* `webContents` - Web contents accessibility tree exposure enabled.\n* `inlineTextBoxes` - Inline text boxes (character bounding boxes) enabled.\n* `extendedProperties` - Extended accessibility properties enabled.\n* `screenReader` - Screen reader specific mode enabled.\n* `html` - HTML accessibility tree construction enabled.\n* `labelImages` - Accessibility support for automatic image annotations.\n* `pdfPrinting` - Accessibility support for PDF printing enabled.\n\nNotes:\n\n* The array may be empty if no accessibility modes are active.\n* Use `app.isAccessibilitySupportEnabled()` for the legacy boolean check; prefer this method for granular diagnostics or telemetry.\n\nExample:",
|
|
1673
|
+
"parameters": [],
|
|
1674
|
+
"returns": {
|
|
1675
|
+
"collection": true,
|
|
1676
|
+
"type": "String",
|
|
1677
|
+
"possibleValues": null
|
|
1678
|
+
},
|
|
1679
|
+
"additionalTags": [
|
|
1680
|
+
"os_macos",
|
|
1681
|
+
"os_windows"
|
|
1682
|
+
],
|
|
1683
|
+
"urlFragment": "#appgetaccessibilitysupportfeatures-macos-windows"
|
|
1684
|
+
},
|
|
1685
|
+
{
|
|
1686
|
+
"name": "setAccessibilitySupportFeatures",
|
|
1687
|
+
"signature": "(features)",
|
|
1688
|
+
"description": "Possible values are:\n\n* `nativeAPIs` - Native OS accessibility APIs integration enabled.\n* `webContents` - Web contents accessibility tree exposure enabled.\n* `inlineTextBoxes` - Inline text boxes (character bounding boxes) enabled.\n* `extendedProperties` - Extended accessibility properties enabled.\n* `screenReader` - Screen reader specific mode enabled.\n* `html` - HTML accessibility tree construction enabled.\n* `labelImages` - Accessibility support for automatic image annotations.\n* `pdfPrinting` - Accessibility support for PDF printing enabled.\n\nTo disable all supported features, pass an empty array `[]`.\n\nExample:",
|
|
1689
|
+
"parameters": [
|
|
1690
|
+
{
|
|
1691
|
+
"name": "features",
|
|
1692
|
+
"description": "An array of the accessibility features to enable.",
|
|
1693
|
+
"required": true,
|
|
1694
|
+
"collection": true,
|
|
1695
|
+
"type": "String",
|
|
1696
|
+
"possibleValues": null
|
|
1697
|
+
}
|
|
1698
|
+
],
|
|
1699
|
+
"returns": null,
|
|
1700
|
+
"additionalTags": [
|
|
1701
|
+
"os_macos",
|
|
1702
|
+
"os_windows"
|
|
1703
|
+
],
|
|
1704
|
+
"urlFragment": "#appsetaccessibilitysupportfeaturesfeatures-macos-windows"
|
|
1705
|
+
},
|
|
1657
1706
|
{
|
|
1658
1707
|
"name": "showAboutPanel",
|
|
1659
1708
|
"signature": "()",
|
|
@@ -3223,8 +3272,8 @@
|
|
|
3223
3272
|
"description": "> Enable apps to automatically update themselves.\n\nProcess: Main\n\n**See also: A detailed guide about how to implement updates in your application.**\n\n`autoUpdater` is an EventEmitter.\n\n### Platform Notices\n\nCurrently, only macOS and Windows are supported. There is no built-in support for auto-updater on Linux, so it is recommended to use the distribution's package manager to update your app.\n\nIn addition, there are some subtle differences on each platform:\n\n### macOS\n\nOn macOS, the `autoUpdater` module is built upon Squirrel.Mac, meaning you don't need any special setup to make it work. For server-side requirements, you can read Server Support. Note that App Transport Security (ATS) applies to all requests made as part of the update process. Apps that need to disable ATS can add the `NSAllowsArbitraryLoads` key to their app's plist.\n\n> [!IMPORTANT] Your application must be signed for automatic updates on macOS. This is a requirement of `Squirrel.Mac`.\n\n### Windows\n\nOn Windows, you have to install your app into a user's machine before you can use the `autoUpdater`, so it is recommended that you use electron-winstaller or Electron Forge's Squirrel.Windows maker to generate a Windows installer.\n\nApps built with Squirrel.Windows will trigger custom launch events that must be handled by your Electron application to ensure proper setup and teardown.\n\nSquirrel.Windows apps will launch with the `--squirrel-firstrun` argument immediately after installation. During this time, Squirrel.Windows will obtain a file lock on your app, and `autoUpdater` requests will fail until the lock is released. In practice, this means that you won't be able to check for updates on first launch for the first few seconds. You can work around this by not checking for updates when `process.argv` contains the `--squirrel-firstrun` flag or by setting a 10-second timeout on your update checks (see electron/electron#7155 for more information).\n\nThe installer generated with Squirrel.Windows will create a shortcut icon with an Application User Model ID in the format of `com.squirrel.PACKAGE_ID.YOUR_EXE_WITHOUT_DOT_EXE`, examples are `com.squirrel.slack.Slack` and `com.squirrel.code.Code`. You have to use the same ID for your app with `app.setAppUserModelId` API, otherwise Windows will not be able to pin your app properly in task bar.",
|
|
3224
3273
|
"slug": "auto-updater",
|
|
3225
3274
|
"websiteUrl": "https://electronjs.org/docs/api/auto-updater",
|
|
3226
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
3227
|
-
"version": "37.
|
|
3275
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/auto-updater.md",
|
|
3276
|
+
"version": "37.10.3",
|
|
3228
3277
|
"type": "Module",
|
|
3229
3278
|
"process": {
|
|
3230
3279
|
"main": true,
|
|
@@ -3440,8 +3489,8 @@
|
|
|
3440
3489
|
"description": "> Create and control windows.\n\nProcess: Main\n\n> [!NOTE] `BaseWindow` provides a flexible way to compose multiple web views in a single window. For windows with only a single, full-size web view, the `BrowserWindow` class may be a simpler option.\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Parent and child windows\n\nBy using `parent` option, you can create child windows:\n\n```\nconst { BaseWindow } = require('electron')\n\nconst parent = new BaseWindow()\nconst child = new BaseWindow({ parent })\n```\n\nThe `child` window will always show on top of the `parent` window.\n\n### Modal windows\n\nA modal window is a child window that disables parent window. To create a modal window, you have to set both the `parent` and `modal` options:\n\n```\nconst { BaseWindow } = require('electron')\n\nconst parent = new BaseWindow()\nconst child = new BaseWindow({ parent, modal: true })\n```\n\n### Platform notices\n\n* On macOS modal windows will be displayed as sheets attached to the parent window.\n* On macOS the child windows will keep the relative position to parent window when parent window moves, while on Windows and Linux child windows will not move.\n* On Linux the type of modal windows will be changed to `dialog`.\n* On Linux many desktop environments do not support hiding a modal window.\n\n### Resource management\n\nWhen you add a `WebContentsView` to a `BaseWindow` and the `BaseWindow` is closed, the `webContents` of the `WebContentsView` are not destroyed automatically.\n\nIt is your responsibility to close the `webContents` when you no longer need them, e.g. when the `BaseWindow` is closed:\n\n```\nconst { BaseWindow, WebContentsView } = require('electron')\n\nconst win = new BaseWindow({ width: 800, height: 600 })\n\nconst view = new WebContentsView()\nwin.contentView.addChildView(view)\n\nwin.on('closed', () => {\n view.webContents.close()\n})\n```\n\nUnlike with a `BrowserWindow`, if you don't explicitly close the `webContents`, you'll encounter memory leaks.\n\n### Class: BaseWindow\n\n> Create and control windows.\n\nProcess: Main\n\n`BaseWindow` is an EventEmitter.\n\nIt creates a new `BaseWindow` with native properties as set by the `options`.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
3441
3490
|
"slug": "base-window",
|
|
3442
3491
|
"websiteUrl": "https://electronjs.org/docs/api/base-window",
|
|
3443
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
3444
|
-
"version": "37.
|
|
3492
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/base-window.md",
|
|
3493
|
+
"version": "37.10.3",
|
|
3445
3494
|
"type": "Class",
|
|
3446
3495
|
"process": {
|
|
3447
3496
|
"main": true,
|
|
@@ -6719,8 +6768,8 @@
|
|
|
6719
6768
|
"description": "> [!NOTE] The `BrowserView` class is deprecated, and replaced by the new `WebContentsView` class.\n\nA `BrowserView` can be used to embed additional web content into a `BrowserWindow`. It is like a child window, except that it is positioned relative to its owning window. It is meant to be an alternative to the `webview` tag.\n\n### Class: BrowserView\n\n> Create and control views.\n\n> [!NOTE] The `BrowserView` class is deprecated, and replaced by the new `WebContentsView` class.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.\n\n### Example\n\n```\n// In the main process.\nconst { app, BrowserView, BrowserWindow } = require('electron')\n\napp.whenReady().then(() => {\n const win = new BrowserWindow({ width: 800, height: 600 })\n\n const view = new BrowserView()\n win.setBrowserView(view)\n view.setBounds({ x: 0, y: 0, width: 300, height: 300 })\n view.webContents.loadURL('https://electronjs.org')\n})\n```",
|
|
6720
6769
|
"slug": "browser-view",
|
|
6721
6770
|
"websiteUrl": "https://electronjs.org/docs/api/browser-view",
|
|
6722
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
6723
|
-
"version": "37.
|
|
6771
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/browser-view.md",
|
|
6772
|
+
"version": "37.10.3",
|
|
6724
6773
|
"type": "Class",
|
|
6725
6774
|
"process": {
|
|
6726
6775
|
"main": true,
|
|
@@ -6887,8 +6936,8 @@
|
|
|
6887
6936
|
"description": "> Create and control browser windows.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Window customization\n\nThe `BrowserWindow` class exposes various ways to modify the look and behavior of your app's windows. For more details, see the Window Customization tutorial.\n\n### Showing the window gracefully\n\nWhen loading a page in the window directly, users may see the page load incrementally, which is not a good experience for a native app. To make the window display without a visual flash, there are two solutions for different situations.\n\n### Using the `ready-to-show` event\n\nWhile loading the page, the `ready-to-show` event will be emitted when the renderer process has rendered the page for the first time if the window has not been shown yet. Showing the window after this event will have no visual flash:\n\n```\nconst { BrowserWindow } = require('electron')\nconst win = new BrowserWindow({ show: false })\nwin.once('ready-to-show', () => {\n win.show()\n})\n```\n\nThis event is usually emitted after the `did-finish-load` event, but for pages with many remote resources, it may be emitted before the `did-finish-load` event.\n\nPlease note that using this event implies that the renderer will be considered \"visible\" and paint even though `show` is false. This event will never fire if you use `paintWhenInitiallyHidden: false`\n\n### Setting the `backgroundColor` property\n\nFor a complex app, the `ready-to-show` event could be emitted too late, making the app feel slow. In this case, it is recommended to show the window immediately, and use a `backgroundColor` close to your app's background:\n\n```\nconst { BrowserWindow } = require('electron')\n\nconst win = new BrowserWindow({ backgroundColor: '#2e2c29' })\nwin.loadURL('https://github.com')\n```\n\nNote that even for apps that use `ready-to-show` event, it is still recommended to set `backgroundColor` to make the app feel more native.\n\nSome examples of valid `backgroundColor` values include:\n\n```\nconst win = new BrowserWindow()\nwin.setBackgroundColor('hsl(230, 100%, 50%)')\nwin.setBackgroundColor('rgb(255, 145, 145)')\nwin.setBackgroundColor('#ff00a3')\nwin.setBackgroundColor('blueviolet')\n```\n\nFor more information about these color types see valid options in win.setBackgroundColor.\n\n### Parent and child windows\n\nBy using `parent` option, you can create child windows:\n\n```\nconst { BrowserWindow } = require('electron')\n\nconst top = new BrowserWindow()\nconst child = new BrowserWindow({ parent: top })\nchild.show()\ntop.show()\n```\n\nThe `child` window will always show on top of the `top` window.\n\n### Modal windows\n\nA modal window is a child window that disables parent window. To create a modal window, you have to set both the `parent` and `modal` options:\n\n```\nconst { BrowserWindow } = require('electron')\n\nconst top = new BrowserWindow()\nconst child = new BrowserWindow({ parent: top, modal: true, show: false })\nchild.loadURL('https://github.com')\nchild.once('ready-to-show', () => {\n child.show()\n})\n```\n\n### Page visibility\n\nThe Page Visibility API works as follows:\n\n* On all platforms, the visibility state tracks whether the window is hidden/minimized or not.\n* Additionally, on macOS, the visibility state also tracks the window occlusion state. If the window is occluded (i.e. fully covered) by another window, the visibility state will be `hidden`. On other platforms, the visibility state will be `hidden` only when the window is minimized or explicitly hidden with `win.hide()`.\n* If a `BrowserWindow` is created with `show: false`, the initial visibility state will be `visible` despite the window actually being hidden.\n* If `backgroundThrottling` is disabled, the visibility state will remain `visible` even if the window is minimized, occluded, or hidden.\n\nIt is recommended that you pause expensive operations when the visibility state is `hidden` in order to minimize power consumption.\n\n### Platform notices\n\n* On macOS modal windows will be displayed as sheets attached to the parent window.\n* On macOS the child windows will keep the relative position to parent window when parent window moves, while on Windows and Linux child windows will not move.\n* On Linux the type of modal windows will be changed to `dialog`.\n* On Linux many desktop environments do not support hiding a modal window.\n\n### Class: BrowserWindow extends `BaseWindow`\n\n> Create and control browser windows.\n\nProcess: Main\n\n`BrowserWindow` is an EventEmitter.\n\nIt creates a new `BrowserWindow` with native properties as set by the `options`.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
6888
6937
|
"slug": "browser-window",
|
|
6889
6938
|
"websiteUrl": "https://electronjs.org/docs/api/browser-window",
|
|
6890
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
6891
|
-
"version": "37.
|
|
6939
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/browser-window.md",
|
|
6940
|
+
"version": "37.10.3",
|
|
6892
6941
|
"type": "Class",
|
|
6893
6942
|
"process": {
|
|
6894
6943
|
"main": true,
|
|
@@ -10655,8 +10704,8 @@
|
|
|
10655
10704
|
"description": "> Make HTTP/HTTPS requests.\n\nProcess: Main, Utility\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._\n\n`ClientRequest` implements the Writable Stream interface and is therefore an EventEmitter.",
|
|
10656
10705
|
"slug": "client-request",
|
|
10657
10706
|
"websiteUrl": "https://electronjs.org/docs/api/client-request",
|
|
10658
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
10659
|
-
"version": "37.
|
|
10707
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/client-request.md",
|
|
10708
|
+
"version": "37.10.3",
|
|
10660
10709
|
"type": "Class",
|
|
10661
10710
|
"process": {
|
|
10662
10711
|
"main": true,
|
|
@@ -11429,8 +11478,8 @@
|
|
|
11429
11478
|
"description": "> Perform copy and paste operations on the system clipboard.\n\nProcess: Main, Renderer (non-sandboxed only)\n\nOn Linux, there is also a `selection` clipboard. To manipulate it you need to pass `selection` to each method:",
|
|
11430
11479
|
"slug": "clipboard",
|
|
11431
11480
|
"websiteUrl": "https://electronjs.org/docs/api/clipboard",
|
|
11432
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
11433
|
-
"version": "37.
|
|
11481
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/clipboard.md",
|
|
11482
|
+
"version": "37.10.3",
|
|
11434
11483
|
"type": "Module",
|
|
11435
11484
|
"process": {
|
|
11436
11485
|
"main": true,
|
|
@@ -12096,8 +12145,8 @@
|
|
|
12096
12145
|
"description": "",
|
|
12097
12146
|
"slug": "command-line",
|
|
12098
12147
|
"websiteUrl": "https://electronjs.org/docs/api/command-line",
|
|
12099
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
12100
|
-
"version": "37.
|
|
12148
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/command-line.md",
|
|
12149
|
+
"version": "37.10.3",
|
|
12101
12150
|
"type": "Class",
|
|
12102
12151
|
"process": {
|
|
12103
12152
|
"main": true,
|
|
@@ -12224,8 +12273,8 @@
|
|
|
12224
12273
|
"description": "> Collect tracing data from Chromium to find performance bottlenecks and slow operations.\n\nProcess: Main\n\nThis module does not include a web interface. To view recorded traces, use trace viewer, available at `chrome://tracing` in Chrome.\n\n> [!NOTE] You should not use this module until the `ready` event of the app module is emitted.",
|
|
12225
12274
|
"slug": "content-tracing",
|
|
12226
12275
|
"websiteUrl": "https://electronjs.org/docs/api/content-tracing",
|
|
12227
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
12228
|
-
"version": "37.
|
|
12276
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/content-tracing.md",
|
|
12277
|
+
"version": "37.10.3",
|
|
12229
12278
|
"type": "Module",
|
|
12230
12279
|
"process": {
|
|
12231
12280
|
"main": true,
|
|
@@ -12362,8 +12411,8 @@
|
|
|
12362
12411
|
"description": "> Create a safe, bi-directional, synchronous bridge across isolated contexts\n\nProcess: Renderer\n\nAn example of exposing an API to a renderer from an isolated preload script is given below:\n\n```\n// Preload (Isolated World)\nconst { contextBridge, ipcRenderer } = require('electron')\n\ncontextBridge.exposeInMainWorld(\n 'electron',\n {\n doThing: () => ipcRenderer.send('do-a-thing')\n }\n)\n```\n\n### Glossary\n\n\n\n### Main World\n\nThe \"Main World\" is the JavaScript context that your main renderer code runs in. By default, the page you load in your renderer executes code in this world.\n\n### Isolated World\n\nWhen `contextIsolation` is enabled in your `webPreferences` (this is the default behavior since Electron 12.0.0), your `preload` scripts run in an \"Isolated World\". You can read more about context isolation and what it affects in the security docs.",
|
|
12363
12412
|
"slug": "context-bridge",
|
|
12364
12413
|
"websiteUrl": "https://electronjs.org/docs/api/context-bridge",
|
|
12365
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
12366
|
-
"version": "37.
|
|
12414
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/context-bridge.md",
|
|
12415
|
+
"version": "37.10.3",
|
|
12367
12416
|
"type": "Module",
|
|
12368
12417
|
"process": {
|
|
12369
12418
|
"main": false,
|
|
@@ -12479,8 +12528,8 @@
|
|
|
12479
12528
|
"description": "",
|
|
12480
12529
|
"slug": "cookies",
|
|
12481
12530
|
"websiteUrl": "https://electronjs.org/docs/api/cookies",
|
|
12482
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
12483
|
-
"version": "37.
|
|
12531
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/cookies.md",
|
|
12532
|
+
"version": "37.10.3",
|
|
12484
12533
|
"type": "Class",
|
|
12485
12534
|
"process": {
|
|
12486
12535
|
"main": true,
|
|
@@ -12829,8 +12878,8 @@
|
|
|
12829
12878
|
"description": "> Submit crash reports to a remote server.\n\nProcess: Main, Renderer\n\nThe following is an example of setting up Electron to automatically submit crash reports to a remote server:\n\n```\nconst { crashReporter } = require('electron')\n\ncrashReporter.start({ submitURL: 'https://your-domain.com/url-to-submit' })\n```\n\nFor setting up a server to accept and process crash reports, you can use following projects:\n\n* socorro\n* mini-breakpad-server\n\n> [!NOTE] Electron uses Crashpad, not Breakpad, to collect and upload crashes, but for the time being, the upload protocol is the same.\n\nOr use a 3rd party hosted solution:\n\n* Backtrace\n* Sentry\n* BugSplat\n* Bugsnag\n\nCrash reports are stored temporarily before being uploaded in a directory underneath the app's user data directory, called 'Crashpad'. You can override this directory by calling `app.setPath('crashDumps', '/path/to/crashes')` before starting the crash reporter.\n\nElectron uses crashpad to monitor and report crashes.",
|
|
12830
12879
|
"slug": "crash-reporter",
|
|
12831
12880
|
"websiteUrl": "https://electronjs.org/docs/api/crash-reporter",
|
|
12832
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
12833
|
-
"version": "37.
|
|
12881
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/crash-reporter.md",
|
|
12882
|
+
"version": "37.10.3",
|
|
12834
12883
|
"type": "Module",
|
|
12835
12884
|
"process": {
|
|
12836
12885
|
"main": true,
|
|
@@ -13102,8 +13151,8 @@
|
|
|
13102
13151
|
"description": "",
|
|
13103
13152
|
"slug": "debugger",
|
|
13104
13153
|
"websiteUrl": "https://electronjs.org/docs/api/debugger",
|
|
13105
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
13106
|
-
"version": "37.
|
|
13154
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/debugger.md",
|
|
13155
|
+
"version": "37.10.3",
|
|
13107
13156
|
"type": "Class",
|
|
13108
13157
|
"process": {
|
|
13109
13158
|
"main": true,
|
|
@@ -13274,8 +13323,8 @@
|
|
|
13274
13323
|
"description": "> Access information about media sources that can be used to capture audio and video from the desktop using the `navigator.mediaDevices.getUserMedia` API.\n\nProcess: Main\n\nThe following example shows how to capture video from a desktop window whose title is `Electron`:\n\n```\n// main.js\nconst { app, BrowserWindow, desktopCapturer, session } = require('electron')\n\napp.whenReady().then(() => {\n const mainWindow = new BrowserWindow()\n\n session.defaultSession.setDisplayMediaRequestHandler((request, callback) => {\n desktopCapturer.getSources({ types: ['screen'] }).then((sources) => {\n // Grant access to the first screen found.\n callback({ video: sources[0], audio: 'loopback' })\n })\n // If true, use the system picker if available.\n // Note: this is currently experimental. If the system picker\n // is available, it will be used and the media request handler\n // will not be invoked.\n }, { useSystemPicker: true })\n\n mainWindow.loadFile('index.html')\n})\n```\n\n```\n// renderer.js\nconst startButton = document.getElementById('startButton')\nconst stopButton = document.getElementById('stopButton')\nconst video = document.querySelector('video')\n\nstartButton.addEventListener('click', () => {\n navigator.mediaDevices.getDisplayMedia({\n audio: true,\n video: {\n width: 320,\n height: 240,\n frameRate: 30\n }\n }).then(stream => {\n video.srcObject = stream\n video.onloadedmetadata = (e) => video.play()\n }).catch(e => console.log(e))\n})\n\nstopButton.addEventListener('click', () => {\n video.pause()\n})\n```\n\n```\n<!-- index.html -->\n<html>\n<meta http-equiv=\"content-security-policy\" content=\"script-src 'self' 'unsafe-inline'\" />\n <body>\n <button id=\"startButton\" class=\"button\">Start</button>\n <button id=\"stopButton\" class=\"button\">Stop</button>\n <video width=\"320\" height=\"240\" autoplay></video>\n <script src=\"renderer.js\"></script>\n </body>\n</html>\n```\n\nSee `navigator.mediaDevices.getDisplayMedia` for more information.\n\n> [!NOTE] `navigator.mediaDevices.getDisplayMedia` does not permit the use of `deviceId` for selection of a source - see specification.",
|
|
13275
13324
|
"slug": "desktop-capturer",
|
|
13276
13325
|
"websiteUrl": "https://electronjs.org/docs/api/desktop-capturer",
|
|
13277
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
13278
|
-
"version": "37.
|
|
13326
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/desktop-capturer.md",
|
|
13327
|
+
"version": "37.10.3",
|
|
13279
13328
|
"type": "Module",
|
|
13280
13329
|
"process": {
|
|
13281
13330
|
"main": true,
|
|
@@ -13356,8 +13405,8 @@
|
|
|
13356
13405
|
"description": "> Display native system dialogs for opening and saving files, alerting, etc.\n\nProcess: Main\n\nAn example of showing a dialog to select multiple files:",
|
|
13357
13406
|
"slug": "dialog",
|
|
13358
13407
|
"websiteUrl": "https://electronjs.org/docs/api/dialog",
|
|
13359
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
13360
|
-
"version": "37.
|
|
13408
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/dialog.md",
|
|
13409
|
+
"version": "37.10.3",
|
|
13361
13410
|
"type": "Module",
|
|
13362
13411
|
"process": {
|
|
13363
13412
|
"main": true,
|
|
@@ -14439,8 +14488,8 @@
|
|
|
14439
14488
|
"description": "",
|
|
14440
14489
|
"slug": "dock",
|
|
14441
14490
|
"websiteUrl": "https://electronjs.org/docs/api/dock",
|
|
14442
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
14443
|
-
"version": "37.
|
|
14491
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/dock.md",
|
|
14492
|
+
"version": "37.10.3",
|
|
14444
14493
|
"type": "Class",
|
|
14445
14494
|
"process": {
|
|
14446
14495
|
"main": true,
|
|
@@ -14684,8 +14733,8 @@
|
|
|
14684
14733
|
"description": "",
|
|
14685
14734
|
"slug": "download-item",
|
|
14686
14735
|
"websiteUrl": "https://electronjs.org/docs/api/download-item",
|
|
14687
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
14688
|
-
"version": "37.
|
|
14736
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/download-item.md",
|
|
14737
|
+
"version": "37.10.3",
|
|
14689
14738
|
"type": "Class",
|
|
14690
14739
|
"process": {
|
|
14691
14740
|
"main": true,
|
|
@@ -15107,8 +15156,8 @@
|
|
|
15107
15156
|
"description": "",
|
|
15108
15157
|
"slug": "extensions-api",
|
|
15109
15158
|
"websiteUrl": "https://electronjs.org/docs/api/extensions-api",
|
|
15110
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
15111
|
-
"version": "37.
|
|
15159
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/extensions-api.md",
|
|
15160
|
+
"version": "37.10.3",
|
|
15112
15161
|
"type": "Class",
|
|
15113
15162
|
"process": {
|
|
15114
15163
|
"main": true,
|
|
@@ -15307,8 +15356,8 @@
|
|
|
15307
15356
|
"description": "> Detect keyboard events when the application does not have keyboard focus.\n\nProcess: Main\n\nThe `globalShortcut` module can register/unregister a global keyboard shortcut with the operating system so that you can customize the operations for various shortcuts.\n\n> [!NOTE] The shortcut is global; it will work even if the app does not have the keyboard focus. This module cannot be used before the `ready` event of the app module is emitted. Please also note that it is also possible to use Chromium's `GlobalShortcutsPortal` implementation, which allows apps to bind global shortcuts when running within a Wayland session.",
|
|
15308
15357
|
"slug": "global-shortcut",
|
|
15309
15358
|
"websiteUrl": "https://electronjs.org/docs/api/global-shortcut",
|
|
15310
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
15311
|
-
"version": "37.
|
|
15359
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/global-shortcut.md",
|
|
15360
|
+
"version": "37.10.3",
|
|
15312
15361
|
"type": "Module",
|
|
15313
15362
|
"process": {
|
|
15314
15363
|
"main": true,
|
|
@@ -15429,8 +15478,8 @@
|
|
|
15429
15478
|
"description": "> A View that displays an image.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\nUseful for showing splash screens that will be swapped for `WebContentsView`s when the content finishes loading.\n\nNote that `ImageView` is experimental and may be changed or removed in the future.\n\n### Class: ImageView extends `View`\n\n> A View that displays an image.\n\nProcess: Main\n\n`ImageView` inherits from `View`.\n\n`ImageView` is an EventEmitter.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
15430
15479
|
"slug": "image-view",
|
|
15431
15480
|
"websiteUrl": "https://electronjs.org/docs/api/image-view",
|
|
15432
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
15433
|
-
"version": "37.
|
|
15481
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/image-view.md",
|
|
15482
|
+
"version": "37.10.3",
|
|
15434
15483
|
"type": "Class",
|
|
15435
15484
|
"process": {
|
|
15436
15485
|
"main": true,
|
|
@@ -15474,8 +15523,8 @@
|
|
|
15474
15523
|
"description": "> In-app purchases on Mac App Store.\n\nProcess: Main",
|
|
15475
15524
|
"slug": "in-app-purchase",
|
|
15476
15525
|
"websiteUrl": "https://electronjs.org/docs/api/in-app-purchase",
|
|
15477
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
15478
|
-
"version": "37.
|
|
15526
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/in-app-purchase.md",
|
|
15527
|
+
"version": "37.10.3",
|
|
15479
15528
|
"type": "Module",
|
|
15480
15529
|
"process": {
|
|
15481
15530
|
"main": true,
|
|
@@ -15669,8 +15718,8 @@
|
|
|
15669
15718
|
"description": "",
|
|
15670
15719
|
"slug": "incoming-message",
|
|
15671
15720
|
"websiteUrl": "https://electronjs.org/docs/api/incoming-message",
|
|
15672
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
15673
|
-
"version": "37.
|
|
15721
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/incoming-message.md",
|
|
15722
|
+
"version": "37.10.3",
|
|
15674
15723
|
"type": "Class",
|
|
15675
15724
|
"process": {
|
|
15676
15725
|
"main": true,
|
|
@@ -15827,8 +15876,8 @@
|
|
|
15827
15876
|
"description": "",
|
|
15828
15877
|
"slug": "ipc-main-service-worker",
|
|
15829
15878
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-main-service-worker",
|
|
15830
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
15831
|
-
"version": "37.
|
|
15879
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/ipc-main-service-worker.md",
|
|
15880
|
+
"version": "37.10.3",
|
|
15832
15881
|
"type": "Class",
|
|
15833
15882
|
"process": {
|
|
15834
15883
|
"main": true,
|
|
@@ -16125,8 +16174,8 @@
|
|
|
16125
16174
|
"description": "\n\n### ipcMain\n\n> Communicate asynchronously from the main process to renderer processes.\n\nProcess: Main\n\nThe `ipcMain` module is an Event Emitter. When used in the main process, it handles asynchronous and synchronous messages sent from a renderer process (web page). Messages sent from a renderer will be emitted to this module.\n\nFor usage examples, check out the IPC tutorial.\n\n### Sending messages\n\nIt is also possible to send messages from the main process to the renderer process, see webContents.send for more information.\n\n* When sending a message, the event name is the `channel`.\n* To reply to a synchronous message, you need to set `event.returnValue`.\n* To send an asynchronous message back to the sender, you can use `event.reply(...)`. This helper method will automatically handle messages coming from frames that aren't the main frame (e.g. iframes) whereas `event.sender.send(...)` will always send to the main frame.",
|
|
16126
16175
|
"slug": "ipc-main",
|
|
16127
16176
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-main",
|
|
16128
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
16129
|
-
"version": "37.
|
|
16177
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/ipc-main.md",
|
|
16178
|
+
"version": "37.10.3",
|
|
16130
16179
|
"type": "Module",
|
|
16131
16180
|
"process": {
|
|
16132
16181
|
"main": true,
|
|
@@ -16504,8 +16553,8 @@
|
|
|
16504
16553
|
"description": "\n\n### ipcRenderer\n\n> Communicate asynchronously from a renderer process to the main process.\n\nProcess: Renderer\n\nThe `ipcRenderer` module is an EventEmitter. It provides a few methods so you can send synchronous and asynchronous messages from the render process (web page) to the main process. You can also receive replies from the main process.\n\nSee IPC tutorial for code examples.",
|
|
16505
16554
|
"slug": "ipc-renderer",
|
|
16506
16555
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-renderer",
|
|
16507
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
16508
|
-
"version": "37.
|
|
16556
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/ipc-renderer.md",
|
|
16557
|
+
"version": "37.10.3",
|
|
16509
16558
|
"type": "Module",
|
|
16510
16559
|
"process": {
|
|
16511
16560
|
"main": false,
|
|
@@ -16896,8 +16945,8 @@
|
|
|
16896
16945
|
"description": "\n\n### Class: MenuItem\n\n> Add items to native application menus and context menus.\n\nProcess: Main\n\nSee `Menu` for examples.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
16897
16946
|
"slug": "menu-item",
|
|
16898
16947
|
"websiteUrl": "https://electronjs.org/docs/api/menu-item",
|
|
16899
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
16900
|
-
"version": "37.
|
|
16948
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/menu-item.md",
|
|
16949
|
+
"version": "37.10.3",
|
|
16901
16950
|
"type": "Class",
|
|
16902
16951
|
"process": {
|
|
16903
16952
|
"main": true,
|
|
@@ -17811,8 +17860,8 @@
|
|
|
17811
17860
|
"description": "\n\n### Class: Menu\n\n> Create native application menus and context menus.\n\nProcess: Main\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
17812
17861
|
"slug": "menu",
|
|
17813
17862
|
"websiteUrl": "https://electronjs.org/docs/api/menu",
|
|
17814
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
17815
|
-
"version": "37.
|
|
17863
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/menu.md",
|
|
17864
|
+
"version": "37.10.3",
|
|
17816
17865
|
"type": "Class",
|
|
17817
17866
|
"process": {
|
|
17818
17867
|
"main": true,
|
|
@@ -18193,8 +18242,8 @@
|
|
|
18193
18242
|
"description": "",
|
|
18194
18243
|
"slug": "message-channel-main",
|
|
18195
18244
|
"websiteUrl": "https://electronjs.org/docs/api/message-channel-main",
|
|
18196
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
18197
|
-
"version": "37.
|
|
18245
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/message-channel-main.md",
|
|
18246
|
+
"version": "37.10.3",
|
|
18198
18247
|
"type": "Class",
|
|
18199
18248
|
"process": {
|
|
18200
18249
|
"main": true,
|
|
@@ -18234,8 +18283,8 @@
|
|
|
18234
18283
|
"description": "",
|
|
18235
18284
|
"slug": "message-port-main",
|
|
18236
18285
|
"websiteUrl": "https://electronjs.org/docs/api/message-port-main",
|
|
18237
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
18238
|
-
"version": "37.
|
|
18286
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/message-port-main.md",
|
|
18287
|
+
"version": "37.10.3",
|
|
18239
18288
|
"type": "Class",
|
|
18240
18289
|
"process": {
|
|
18241
18290
|
"main": true,
|
|
@@ -18341,8 +18390,8 @@
|
|
|
18341
18390
|
"description": "> Create tray, dock, and application icons using PNG or JPG files.\n\nProcess: Main, Renderer\n\nThe `nativeImage` module provides a unified interface for manipulating system images. These can be handy if you want to provide multiple scaled versions of the same icon or take advantage of macOS template images.\n\nElectron APIs that take image files accept either file paths or `NativeImage` instances. An empty and transparent image will be used when `null` is passed.\n\nFor example, when creating a Tray or setting a BrowserWindow's icon, you can either pass an image file path as a string:\n\n```\nconst { BrowserWindow, Tray } = require('electron')\n\nconst tray = new Tray('/Users/somebody/images/icon.png')\nconst win = new BrowserWindow({ icon: '/Users/somebody/images/window.png' })\n```\n\nor generate a `NativeImage` instance from the same file:\n\n### Supported Formats\n\nCurrently, `PNG` and `JPEG` image formats are supported across all platforms. `PNG` is recommended because of its support for transparency and lossless compression.\n\nOn Windows, you can also load `ICO` icons from file paths. For best visual quality, we recommend including at least the following sizes:\n\n* Small icon\n * 16x16 (100% DPI scale)\n * 20x20 (125% DPI scale)\n * 24x24 (150% DPI scale)\n * 32x32 (200% DPI scale)\n* Large icon\n * 32x32 (100% DPI scale)\n * 40x40 (125% DPI scale)\n * 48x48 (150% DPI scale)\n * 64x64 (200% DPI scale)\n * 256x256\n\nCheck the _Icon Scaling_ section in the Windows App Icon Construction reference.\n\n:::note\n\nEXIF metadata is currently not supported and will not be taken into account during image encoding and decoding.\n\n:::\n\n### High Resolution Image\n\nOn platforms that support high pixel density displays (such as Apple Retina), you can append `@2x` after image's base filename to mark it as a 2x scale high resolution image.\n\nFor example, if `icon.png` is a normal image that has standard resolution, then `icon@2x.png` will be treated as a high resolution image that has double Dots per Inch (DPI) density.\n\nIf you want to support displays with different DPI densities at the same time, you can put images with different sizes in the same folder and use the filename without DPI suffixes within Electron. For example:\n\n```\nimages/\n├── icon.png\n├── icon@2x.png\n└── icon@3x.png\n```\n\n```\nconst { Tray } = require('electron')\nconst appTray = new Tray('/Users/somebody/images/icon.png')\n```\n\nThe following suffixes for DPI are also supported:\n\n* `@1x`\n* `@1.25x`\n* `@1.33x`\n* `@1.4x`\n* `@1.5x`\n* `@1.8x`\n* `@2x`\n* `@2.5x`\n* `@3x`\n* `@4x`\n* `@5x`\n\n### Template Image _macOS_\n\nOn macOS, template images consist of black and an alpha channel. Template images are not intended to be used as standalone images and are usually mixed with other content to create the desired final appearance.\n\nThe most common case is to use template images for a menu bar (Tray) icon, so it can adapt to both light and dark menu bars.\n\nTo mark an image as a template image, its base filename should end with the word `Template` (e.g. `xxxTemplate.png`). You can also specify template images at different DPI densities (e.g. `xxxTemplate@2x.png`).",
|
|
18342
18391
|
"slug": "native-image",
|
|
18343
18392
|
"websiteUrl": "https://electronjs.org/docs/api/native-image",
|
|
18344
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
18345
|
-
"version": "37.
|
|
18393
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/native-image.md",
|
|
18394
|
+
"version": "37.10.3",
|
|
18346
18395
|
"type": "Module",
|
|
18347
18396
|
"process": {
|
|
18348
18397
|
"main": true,
|
|
@@ -18588,8 +18637,8 @@
|
|
|
18588
18637
|
"description": "",
|
|
18589
18638
|
"slug": "native-image",
|
|
18590
18639
|
"websiteUrl": "https://electronjs.org/docs/api/native-image",
|
|
18591
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
18592
|
-
"version": "37.
|
|
18640
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/native-image.md",
|
|
18641
|
+
"version": "37.10.3",
|
|
18593
18642
|
"type": "Class",
|
|
18594
18643
|
"process": {
|
|
18595
18644
|
"main": true,
|
|
@@ -19010,8 +19059,8 @@
|
|
|
19010
19059
|
"description": "> Read and respond to changes in Chromium's native color theme.\n\nProcess: Main",
|
|
19011
19060
|
"slug": "native-theme",
|
|
19012
19061
|
"websiteUrl": "https://electronjs.org/docs/api/native-theme",
|
|
19013
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
19014
|
-
"version": "37.
|
|
19062
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/native-theme.md",
|
|
19063
|
+
"version": "37.10.3",
|
|
19015
19064
|
"type": "Module",
|
|
19016
19065
|
"process": {
|
|
19017
19066
|
"main": true,
|
|
@@ -19134,8 +19183,8 @@
|
|
|
19134
19183
|
"description": "",
|
|
19135
19184
|
"slug": "navigation-history",
|
|
19136
19185
|
"websiteUrl": "https://electronjs.org/docs/api/navigation-history",
|
|
19137
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
19138
|
-
"version": "37.
|
|
19186
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/navigation-history.md",
|
|
19187
|
+
"version": "37.10.3",
|
|
19139
19188
|
"type": "Class",
|
|
19140
19189
|
"process": {
|
|
19141
19190
|
"main": true,
|
|
@@ -19382,8 +19431,8 @@
|
|
|
19382
19431
|
"description": "> Logging network events for a session.\n\nProcess: Main\n\n```\nconst { app, netLog } = require('electron')\n\napp.whenReady().then(async () => {\n await netLog.startLogging('/path/to/net-log')\n // After some network events\n const path = await netLog.stopLogging()\n console.log('Net-logs written to', path)\n})\n```\n\nSee `--log-net-log` to log network events throughout the app's lifecycle.\n\n> [!NOTE] All methods unless specified can only be used after the `ready` event of the `app` module gets emitted.",
|
|
19383
19432
|
"slug": "net-log",
|
|
19384
19433
|
"websiteUrl": "https://electronjs.org/docs/api/net-log",
|
|
19385
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
19386
|
-
"version": "37.
|
|
19434
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/net-log.md",
|
|
19435
|
+
"version": "37.10.3",
|
|
19387
19436
|
"type": "Module",
|
|
19388
19437
|
"process": {
|
|
19389
19438
|
"main": true,
|
|
@@ -19498,8 +19547,8 @@
|
|
|
19498
19547
|
"description": "> Issue HTTP/HTTPS requests using Chromium's native networking library\n\nProcess: Main, Utility\n\nThe `net` module is a client-side API for issuing HTTP(S) requests. It is similar to the HTTP and HTTPS modules of Node.js but uses Chromium's native networking library instead of the Node.js implementation, offering better support for web proxies. It also supports checking network status.\n\nThe following is a non-exhaustive list of why you may consider using the `net` module instead of the native Node.js modules:\n\n* Automatic management of system proxy configuration, support of the wpad protocol and proxy pac configuration files.\n* Automatic tunneling of HTTPS requests.\n* Support for authenticating proxies using basic, digest, NTLM, Kerberos or negotiate authentication schemes.\n* Support for traffic monitoring proxies: Fiddler-like proxies used for access control and monitoring.\n\nThe API components (including classes, methods, properties and event names) are similar to those used in Node.js.\n\nExample usage:\n\n```\nconst { app } = require('electron')\napp.whenReady().then(() => {\n const { net } = require('electron')\n const request = net.request('https://github.com')\n request.on('response', (response) => {\n console.log(`STATUS: ${response.statusCode}`)\n console.log(`HEADERS: ${JSON.stringify(response.headers)}`)\n response.on('data', (chunk) => {\n console.log(`BODY: ${chunk}`)\n })\n response.on('end', () => {\n console.log('No more data in response.')\n })\n })\n request.end()\n})\n```\n\nThe `net` API can be used only after the application emits the `ready` event. Trying to use the module before the `ready` event will throw an error.",
|
|
19499
19548
|
"slug": "net",
|
|
19500
19549
|
"websiteUrl": "https://electronjs.org/docs/api/net",
|
|
19501
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
19502
|
-
"version": "37.
|
|
19550
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/net.md",
|
|
19551
|
+
"version": "37.10.3",
|
|
19503
19552
|
"type": "Module",
|
|
19504
19553
|
"process": {
|
|
19505
19554
|
"main": true,
|
|
@@ -19739,8 +19788,8 @@
|
|
|
19739
19788
|
"description": "> Create OS desktop notifications\n\nProcess: Main\n\n> [!NOTE] If you want to show notifications from a renderer process you should use the web Notifications API\n\n### Class: Notification\n\n> Create OS desktop notifications\n\nProcess: Main\n\n`Notification` is an EventEmitter.\n\nIt creates a new `Notification` with native properties as set by the `options`.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.\n\n### Static Methods\n\nThe `Notification` class has the following static methods:\n\n### `Notification.isSupported()`\n\nReturns `boolean` - Whether or not desktop notifications are supported on the current system",
|
|
19740
19789
|
"slug": "notification",
|
|
19741
19790
|
"websiteUrl": "https://electronjs.org/docs/api/notification",
|
|
19742
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
19743
|
-
"version": "37.
|
|
19791
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/notification.md",
|
|
19792
|
+
"version": "37.10.3",
|
|
19744
19793
|
"type": "Class",
|
|
19745
19794
|
"process": {
|
|
19746
19795
|
"main": true,
|
|
@@ -20246,8 +20295,8 @@
|
|
|
20246
20295
|
"description": "> Interface for communication with parent process.\n\nProcess: Utility\n\n`parentPort` is an EventEmitter. _This object is not exported from the `'electron'` module. It is only available as a property of the process object in the Electron API._",
|
|
20247
20296
|
"slug": "parent-port",
|
|
20248
20297
|
"websiteUrl": "https://electronjs.org/docs/api/parent-port",
|
|
20249
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
20250
|
-
"version": "37.
|
|
20298
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/parent-port.md",
|
|
20299
|
+
"version": "37.10.3",
|
|
20251
20300
|
"type": "Module",
|
|
20252
20301
|
"process": {
|
|
20253
20302
|
"main": false,
|
|
@@ -20318,8 +20367,8 @@
|
|
|
20318
20367
|
"description": "> Monitor power state changes.\n\nProcess: Main",
|
|
20319
20368
|
"slug": "power-monitor",
|
|
20320
20369
|
"websiteUrl": "https://electronjs.org/docs/api/power-monitor",
|
|
20321
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
20322
|
-
"version": "37.
|
|
20370
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/power-monitor.md",
|
|
20371
|
+
"version": "37.10.3",
|
|
20323
20372
|
"type": "Module",
|
|
20324
20373
|
"process": {
|
|
20325
20374
|
"main": true,
|
|
@@ -20607,8 +20656,8 @@
|
|
|
20607
20656
|
"description": "> Block the system from entering low-power (sleep) mode.\n\nProcess: Main\n\nFor example:",
|
|
20608
20657
|
"slug": "power-save-blocker",
|
|
20609
20658
|
"websiteUrl": "https://electronjs.org/docs/api/power-save-blocker",
|
|
20610
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
20611
|
-
"version": "37.
|
|
20659
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/power-save-blocker.md",
|
|
20660
|
+
"version": "37.10.3",
|
|
20612
20661
|
"type": "Module",
|
|
20613
20662
|
"process": {
|
|
20614
20663
|
"main": true,
|
|
@@ -20697,8 +20746,8 @@
|
|
|
20697
20746
|
"description": "> Extensions to process object.\n\nProcess: Main, Renderer\n\nElectron's `process` object is extended from the Node.js `process` object. It adds the following events, properties, and methods:\n\n### Sandbox\n\nIn sandboxed renderers the `process` object contains only a subset of the APIs:\n\n* `crash()`\n* `hang()`\n* `getCreationTime()`\n* `getHeapStatistics()`\n* `getBlinkMemoryInfo()`\n* `getProcessMemoryInfo()`\n* `getSystemMemoryInfo()`\n* `getSystemVersion()`\n* `getCPUUsage()`\n* `uptime()`\n* `argv`\n* `execPath`\n* `env`\n* `pid`\n* `arch`\n* `platform`\n* `sandboxed`\n* `contextIsolated`\n* `type`\n* `version`\n* `versions`\n* `mas`\n* `windowsStore`\n* `contextId`",
|
|
20698
20747
|
"slug": "process",
|
|
20699
20748
|
"websiteUrl": "https://electronjs.org/docs/api/process",
|
|
20700
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
20701
|
-
"version": "37.
|
|
20749
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/process.md",
|
|
20750
|
+
"version": "37.10.3",
|
|
20702
20751
|
"type": "Module",
|
|
20703
20752
|
"process": {
|
|
20704
20753
|
"main": true,
|
|
@@ -21238,8 +21287,8 @@
|
|
|
21238
21287
|
"description": "> Register a custom protocol and intercept existing protocol requests.\n\nProcess: Main\n\nAn example of implementing a protocol that has the same effect as the `file://` protocol:\n\n```\nconst { app, protocol, net } = require('electron')\nconst path = require('node:path')\nconst url = require('node:url')\n\napp.whenReady().then(() => {\n protocol.handle('atom', (request) => {\n const filePath = request.url.slice('atom://'.length)\n return net.fetch(url.pathToFileURL(path.join(__dirname, filePath)).toString())\n })\n})\n```\n\n> [!NOTE] All methods unless specified can only be used after the `ready` event of the `app` module gets emitted.\n\n### Using `protocol` with a custom `partition` or `session`\n\nA protocol is registered to a specific Electron `session` object. If you don't specify a session, then your `protocol` will be applied to the default session that Electron uses. However, if you define a `partition` or `session` on your `browserWindow`'s `webPreferences`, then that window will use a different session and your custom protocol will not work if you just use `electron.protocol.XXX`.\n\nTo have your custom protocol work in combination with a custom session, you need to register it to that session explicitly.\n\n```\nconst { app, BrowserWindow, net, protocol, session } = require('electron')\nconst path = require('node:path')\nconst url = require('url')\n\napp.whenReady().then(() => {\n const partition = 'persist:example'\n const ses = session.fromPartition(partition)\n\n ses.protocol.handle('atom', (request) => {\n const filePath = request.url.slice('atom://'.length)\n return net.fetch(url.pathToFileURL(path.resolve(__dirname, filePath)).toString())\n })\n\n const mainWindow = new BrowserWindow({ webPreferences: { partition } })\n})\n```",
|
|
21239
21288
|
"slug": "protocol",
|
|
21240
21289
|
"websiteUrl": "https://electronjs.org/docs/api/protocol",
|
|
21241
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
21242
|
-
"version": "37.
|
|
21290
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/protocol.md",
|
|
21291
|
+
"version": "37.10.3",
|
|
21243
21292
|
"type": "Module",
|
|
21244
21293
|
"process": {
|
|
21245
21294
|
"main": true,
|
|
@@ -22105,8 +22154,8 @@
|
|
|
22105
22154
|
"description": "Process: Main\n\n> Register for and receive notifications from remote push notification services\n\nFor example, when registering for push notifications via Apple push notification services (APNS):",
|
|
22106
22155
|
"slug": "push-notifications",
|
|
22107
22156
|
"websiteUrl": "https://electronjs.org/docs/api/push-notifications",
|
|
22108
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
22109
|
-
"version": "37.
|
|
22157
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/push-notifications.md",
|
|
22158
|
+
"version": "37.10.3",
|
|
22110
22159
|
"type": "Module",
|
|
22111
22160
|
"process": {
|
|
22112
22161
|
"main": true,
|
|
@@ -22195,8 +22244,8 @@
|
|
|
22195
22244
|
"description": "> Allows access to simple encryption and decryption of strings for storage on the local machine.\n\nProcess: Main\n\nThis module adds extra protection to data being stored on disk by using OS-provided cryptography systems. Current security semantics for each platform are outlined below.\n\n* **macOS**: Encryption keys are stored for your app in Keychain Access in a way that prevents other applications from loading them without user override. Therefore, content is protected from other users and other apps running in the same userspace.\n* **Windows**: Encryption keys are generated via DPAPI. As per the Windows documentation: \"Typically, only a user with the same logon credential as the user who encrypted the data can typically decrypt the data\". Therefore, content is protected from other users on the same machine, but not from other apps running in the same userspace.\n* **Linux**: Encryption keys are generated and stored in a secret store that varies depending on your window manager and system setup. Options currently supported are `kwallet`, `kwallet5`, `kwallet6` and `gnome-libsecret`, but more may be available in future versions of Electron. As such, the security semantics of content protected via the `safeStorage` API vary between window managers and secret stores.\n * Note that not all Linux setups have an available secret store. If no secret store is available, items stored in using the `safeStorage` API will be unprotected as they are encrypted via hardcoded plaintext password. You can detect when this happens when `safeStorage.getSelectedStorageBackend()` returns `basic_text`.\n\nNote that on Mac, access to the system Keychain is required and these calls can block the current thread to collect user input. The same is true for Linux, if a password management tool is available.",
|
|
22196
22245
|
"slug": "safe-storage",
|
|
22197
22246
|
"websiteUrl": "https://electronjs.org/docs/api/safe-storage",
|
|
22198
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
22199
|
-
"version": "37.
|
|
22247
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/safe-storage.md",
|
|
22248
|
+
"version": "37.10.3",
|
|
22200
22249
|
"type": "Module",
|
|
22201
22250
|
"process": {
|
|
22202
22251
|
"main": true,
|
|
@@ -22326,8 +22375,8 @@
|
|
|
22326
22375
|
"description": "> Retrieve information about screen size, displays, cursor position, etc.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n`screen` is an EventEmitter.\n\n> [!NOTE] In the renderer / DevTools, `window.screen` is a reserved DOM property, so writing `let { screen } = require('electron')` will not work.\n\nAn example of creating a window that fills the whole screen:\n\n```\n// Retrieve information about screen size, displays, cursor position, etc.\n//\n// For more info, see:\n// https://www.electronjs.org/docs/latest/api/screen\n\nconst { app, BrowserWindow, screen } = require('electron/main')\n\nlet mainWindow = null\n\napp.whenReady().then(() => {\n // Create a window that fills the screen's available work area.\n const primaryDisplay = screen.getPrimaryDisplay()\n const { width, height } = primaryDisplay.workAreaSize\n\n mainWindow = new BrowserWindow({ width, height })\n mainWindow.loadURL('https://electronjs.org')\n})\n```\n\nAnother example of creating a window in the external display:\n\n```\nconst { app, BrowserWindow, screen } = require('electron')\n\nlet win\n\napp.whenReady().then(() => {\n const displays = screen.getAllDisplays()\n const externalDisplay = displays.find((display) => {\n return display.bounds.x !== 0 || display.bounds.y !== 0\n })\n\n if (externalDisplay) {\n win = new BrowserWindow({\n x: externalDisplay.bounds.x + 50,\n y: externalDisplay.bounds.y + 50\n })\n win.loadURL('https://github.com')\n }\n})\n```\n\n> [!NOTE] Screen coordinates used by this module are `Point` structures. There are two kinds of coordinates available to the process:\n\n* **Physical screen points** are raw hardware pixels on a display.\n* **Device-independent pixel (DIP) points** are virtualized screen points scaled based on the DPI (dots per inch) of the display.",
|
|
22327
22376
|
"slug": "screen",
|
|
22328
22377
|
"websiteUrl": "https://electronjs.org/docs/api/screen",
|
|
22329
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
22330
|
-
"version": "37.
|
|
22378
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/screen.md",
|
|
22379
|
+
"version": "37.10.3",
|
|
22331
22380
|
"type": "Module",
|
|
22332
22381
|
"process": {
|
|
22333
22382
|
"main": true,
|
|
@@ -22626,8 +22675,8 @@
|
|
|
22626
22675
|
"description": "",
|
|
22627
22676
|
"slug": "service-worker-main",
|
|
22628
22677
|
"websiteUrl": "https://electronjs.org/docs/api/service-worker-main",
|
|
22629
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
22630
|
-
"version": "37.
|
|
22678
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/service-worker-main.md",
|
|
22679
|
+
"version": "37.10.3",
|
|
22631
22680
|
"type": "Class",
|
|
22632
22681
|
"process": {
|
|
22633
22682
|
"main": true,
|
|
@@ -22767,8 +22816,8 @@
|
|
|
22767
22816
|
"description": "",
|
|
22768
22817
|
"slug": "service-workers",
|
|
22769
22818
|
"websiteUrl": "https://electronjs.org/docs/api/service-workers",
|
|
22770
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
22771
|
-
"version": "37.
|
|
22819
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/service-workers.md",
|
|
22820
|
+
"version": "37.10.3",
|
|
22772
22821
|
"type": "Class",
|
|
22773
22822
|
"process": {
|
|
22774
22823
|
"main": true,
|
|
@@ -23134,8 +23183,8 @@
|
|
|
23134
23183
|
"description": "> Manage browser sessions, cookies, cache, proxy settings, etc.\n\nProcess: Main\n\nThe `session` module can be used to create new `Session` objects.\n\nYou can also access the `session` of existing pages by using the `session` property of `WebContents`, or from the `session` module.",
|
|
23135
23184
|
"slug": "session",
|
|
23136
23185
|
"websiteUrl": "https://electronjs.org/docs/api/session",
|
|
23137
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
23138
|
-
"version": "37.
|
|
23186
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/session.md",
|
|
23187
|
+
"version": "37.10.3",
|
|
23139
23188
|
"type": "Module",
|
|
23140
23189
|
"process": {
|
|
23141
23190
|
"main": true,
|
|
@@ -23240,8 +23289,8 @@
|
|
|
23240
23289
|
"description": "",
|
|
23241
23290
|
"slug": "session",
|
|
23242
23291
|
"websiteUrl": "https://electronjs.org/docs/api/session",
|
|
23243
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
23244
|
-
"version": "37.
|
|
23292
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/session.md",
|
|
23293
|
+
"version": "37.10.3",
|
|
23245
23294
|
"type": "Class",
|
|
23246
23295
|
"process": {
|
|
23247
23296
|
"main": true,
|
|
@@ -26801,8 +26850,8 @@
|
|
|
26801
26850
|
"description": "The `ShareMenu` class creates Share Menu on macOS, which can be used to share information from the current context to apps, social media accounts, and other services.\n\nFor including the share menu as a submenu of other menus, please use the `shareMenu` role of `MenuItem`.\n\n### Class: ShareMenu\n\n> Create share menu on macOS.\n\nProcess: Main\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
26802
26851
|
"slug": "share-menu",
|
|
26803
26852
|
"websiteUrl": "https://electronjs.org/docs/api/share-menu",
|
|
26804
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
26805
|
-
"version": "37.
|
|
26853
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/share-menu.md",
|
|
26854
|
+
"version": "37.10.3",
|
|
26806
26855
|
"type": "Class",
|
|
26807
26856
|
"process": {
|
|
26808
26857
|
"main": true,
|
|
@@ -26869,8 +26918,8 @@
|
|
|
26869
26918
|
"description": "> Manage files and URLs using their default applications.\n\nProcess: Main, Renderer (non-sandboxed only)\n\nThe `shell` module provides functions related to desktop integration.\n\nAn example of opening a URL in the user's default browser:\n\n```\nconst { shell } = require('electron')\n\nshell.openExternal('https://github.com')\n```\n\n> [!WARNING] While the `shell` module can be used in the renderer process, it will not function in a sandboxed renderer.",
|
|
26870
26919
|
"slug": "shell",
|
|
26871
26920
|
"websiteUrl": "https://electronjs.org/docs/api/shell",
|
|
26872
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
26873
|
-
"version": "37.
|
|
26921
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/shell.md",
|
|
26922
|
+
"version": "37.10.3",
|
|
26874
26923
|
"type": "Module",
|
|
26875
26924
|
"process": {
|
|
26876
26925
|
"main": true,
|
|
@@ -27112,8 +27161,8 @@
|
|
|
27112
27161
|
"description": "> Get system preferences.\n\nProcess: Main, Utility",
|
|
27113
27162
|
"slug": "system-preferences",
|
|
27114
27163
|
"websiteUrl": "https://electronjs.org/docs/api/system-preferences",
|
|
27115
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
27116
|
-
"version": "37.
|
|
27164
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/system-preferences.md",
|
|
27165
|
+
"version": "37.10.3",
|
|
27117
27166
|
"type": "Module",
|
|
27118
27167
|
"process": {
|
|
27119
27168
|
"main": true,
|
|
@@ -28346,8 +28395,8 @@
|
|
|
28346
28395
|
"description": "> Create a button in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28347
28396
|
"slug": "touch-bar-button",
|
|
28348
28397
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-button",
|
|
28349
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28350
|
-
"version": "37.
|
|
28398
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/touch-bar-button.md",
|
|
28399
|
+
"version": "37.10.3",
|
|
28351
28400
|
"type": "Class",
|
|
28352
28401
|
"process": {
|
|
28353
28402
|
"main": true,
|
|
@@ -28538,8 +28587,8 @@
|
|
|
28538
28587
|
"description": "> Create a color picker in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28539
28588
|
"slug": "touch-bar-color-picker",
|
|
28540
28589
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-color-picker",
|
|
28541
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28542
|
-
"version": "37.
|
|
28590
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/touch-bar-color-picker.md",
|
|
28591
|
+
"version": "37.10.3",
|
|
28543
28592
|
"type": "Class",
|
|
28544
28593
|
"process": {
|
|
28545
28594
|
"main": true,
|
|
@@ -28631,8 +28680,8 @@
|
|
|
28631
28680
|
"description": "> Create a group in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28632
28681
|
"slug": "touch-bar-group",
|
|
28633
28682
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-group",
|
|
28634
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28635
|
-
"version": "37.
|
|
28683
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/touch-bar-group.md",
|
|
28684
|
+
"version": "37.10.3",
|
|
28636
28685
|
"type": "Class",
|
|
28637
28686
|
"process": {
|
|
28638
28687
|
"main": true,
|
|
@@ -28674,8 +28723,8 @@
|
|
|
28674
28723
|
"description": "> Create a label in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28675
28724
|
"slug": "touch-bar-label",
|
|
28676
28725
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-label",
|
|
28677
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28678
|
-
"version": "37.
|
|
28726
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/touch-bar-label.md",
|
|
28727
|
+
"version": "37.10.3",
|
|
28679
28728
|
"type": "Class",
|
|
28680
28729
|
"process": {
|
|
28681
28730
|
"main": true,
|
|
@@ -28767,8 +28816,8 @@
|
|
|
28767
28816
|
"description": "> Instantiates a special \"other items proxy\", which nests TouchBar elements inherited from Chromium at the space indicated by the proxy. By default, this proxy is added to each TouchBar at the end of the input. For more information, see the AppKit docs on NSTouchBarItemIdentifierOtherItemsProxy\n\n> [!NOTE] Only one instance of this class can be added per TouchBar.\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28768
28817
|
"slug": "touch-bar-other-items-proxy",
|
|
28769
28818
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-other-items-proxy",
|
|
28770
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28771
|
-
"version": "37.
|
|
28819
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/touch-bar-other-items-proxy.md",
|
|
28820
|
+
"version": "37.10.3",
|
|
28772
28821
|
"type": "Class",
|
|
28773
28822
|
"process": {
|
|
28774
28823
|
"main": true,
|
|
@@ -28792,8 +28841,8 @@
|
|
|
28792
28841
|
"description": "> Create a popover in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28793
28842
|
"slug": "touch-bar-popover",
|
|
28794
28843
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-popover",
|
|
28795
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28796
|
-
"version": "37.
|
|
28844
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/touch-bar-popover.md",
|
|
28845
|
+
"version": "37.10.3",
|
|
28797
28846
|
"type": "Class",
|
|
28798
28847
|
"process": {
|
|
28799
28848
|
"main": true,
|
|
@@ -28880,8 +28929,8 @@
|
|
|
28880
28929
|
"description": "> Create a scrubber (a scrollable selector)\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
28881
28930
|
"slug": "touch-bar-scrubber",
|
|
28882
28931
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-scrubber",
|
|
28883
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
28884
|
-
"version": "37.
|
|
28932
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/touch-bar-scrubber.md",
|
|
28933
|
+
"version": "37.10.3",
|
|
28885
28934
|
"type": "Class",
|
|
28886
28935
|
"process": {
|
|
28887
28936
|
"main": true,
|
|
@@ -29130,8 +29179,8 @@
|
|
|
29130
29179
|
"description": "> Create a segmented control (a button group) where one button has a selected state\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
29131
29180
|
"slug": "touch-bar-segmented-control",
|
|
29132
29181
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-segmented-control",
|
|
29133
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
29134
|
-
"version": "37.
|
|
29182
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/touch-bar-segmented-control.md",
|
|
29183
|
+
"version": "37.10.3",
|
|
29135
29184
|
"type": "Class",
|
|
29136
29185
|
"process": {
|
|
29137
29186
|
"main": true,
|
|
@@ -29322,8 +29371,8 @@
|
|
|
29322
29371
|
"description": "> Create a slider in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
29323
29372
|
"slug": "touch-bar-slider",
|
|
29324
29373
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-slider",
|
|
29325
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
29326
|
-
"version": "37.
|
|
29374
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/touch-bar-slider.md",
|
|
29375
|
+
"version": "37.10.3",
|
|
29327
29376
|
"type": "Class",
|
|
29328
29377
|
"process": {
|
|
29329
29378
|
"main": true,
|
|
@@ -29446,8 +29495,8 @@
|
|
|
29446
29495
|
"description": "> Create a spacer between two items in the touch bar for native macOS applications\n\nProcess: Main\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
29447
29496
|
"slug": "touch-bar-spacer",
|
|
29448
29497
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-spacer",
|
|
29449
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
29450
|
-
"version": "37.
|
|
29498
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/touch-bar-spacer.md",
|
|
29499
|
+
"version": "37.10.3",
|
|
29451
29500
|
"type": "Class",
|
|
29452
29501
|
"process": {
|
|
29453
29502
|
"main": true,
|
|
@@ -29527,8 +29576,8 @@
|
|
|
29527
29576
|
"description": "> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.\n\n### Class: TouchBar\n\n> Create TouchBar layouts for native macOS applications\n\nProcess: Main",
|
|
29528
29577
|
"slug": "touch-bar",
|
|
29529
29578
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar",
|
|
29530
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
29531
|
-
"version": "37.
|
|
29579
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/touch-bar.md",
|
|
29580
|
+
"version": "37.10.3",
|
|
29532
29581
|
"type": "Class",
|
|
29533
29582
|
"process": {
|
|
29534
29583
|
"main": true,
|
|
@@ -29757,8 +29806,8 @@
|
|
|
29757
29806
|
"description": "\n\n### Class: Tray\n\n> Add icons and context menus to the system's notification area.\n\nProcess: Main\n\n`Tray` is an EventEmitter.\n\n```\nconst { app, Menu, Tray } = require('electron')\n\nlet tray = null\napp.whenReady().then(() => {\n tray = new Tray('/path/to/my/icon')\n const contextMenu = Menu.buildFromTemplate([\n { label: 'Item1', type: 'radio' },\n { label: 'Item2', type: 'radio' },\n { label: 'Item3', type: 'radio', checked: true },\n { label: 'Item4', type: 'radio' }\n ])\n tray.setToolTip('This is my application.')\n tray.setContextMenu(contextMenu)\n})\n```\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.\n\n**Platform Considerations**\n\n**Linux**\n\n* Tray icon uses StatusNotifierItem by default, when it is not available in user's desktop environment the `GtkStatusIcon` will be used instead.\n* The `click` event is emitted when the tray icon receives activation from user, however the StatusNotifierItem spec does not specify which action would cause an activation, for some environments it is left mouse click, but for some it might be double left mouse click.\n* In order for changes made to individual `MenuItem`s to take effect, you have to call `setContextMenu` again. For example:\n\n```\nconst { app, Menu, Tray } = require('electron')\n\nlet appIcon = null\napp.whenReady().then(() => {\n appIcon = new Tray('/path/to/my/icon')\n const contextMenu = Menu.buildFromTemplate([\n { label: 'Item1', type: 'radio' },\n { label: 'Item2', type: 'radio' }\n ])\n\n // Make a change to the context menu\n contextMenu.items[1].checked = false\n\n // Call this again for Linux because we modified the context menu\n appIcon.setContextMenu(contextMenu)\n})\n```\n\n**MacOS**\n\n* Icons passed to the Tray constructor should be Template Images.\n* To make sure your icon isn't grainy on retina monitors, be sure your `@2x` image is 144dpi.\n* If you are bundling your application (e.g., with webpack for development), be sure that the file names are not being mangled or hashed. The filename needs to end in Template, and the `@2x` image needs to have the same filename as the standard image, or MacOS will not magically invert your image's colors or use the high density image.\n* 16x16 (72dpi) and 32x32@2x (144dpi) work well for most icons.\n\n**Windows**\n\n* It is recommended to use `ICO` icons to get best visual effects.",
|
|
29758
29807
|
"slug": "tray",
|
|
29759
29808
|
"websiteUrl": "https://electronjs.org/docs/api/tray",
|
|
29760
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
29761
|
-
"version": "37.
|
|
29809
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/tray.md",
|
|
29810
|
+
"version": "37.10.3",
|
|
29762
29811
|
"type": "Class",
|
|
29763
29812
|
"process": {
|
|
29764
29813
|
"main": true,
|
|
@@ -30600,8 +30649,8 @@
|
|
|
30600
30649
|
"description": "`utilityProcess` creates a child process with Node.js and Message ports enabled. It provides the equivalent of `child_process.fork` API from Node.js but instead uses Services API from Chromium to launch the child process.\n\nProcess: Main",
|
|
30601
30650
|
"slug": "utility-process",
|
|
30602
30651
|
"websiteUrl": "https://electronjs.org/docs/api/utility-process",
|
|
30603
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
30604
|
-
"version": "37.
|
|
30652
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/utility-process.md",
|
|
30653
|
+
"version": "37.10.3",
|
|
30605
30654
|
"type": "Module",
|
|
30606
30655
|
"process": {
|
|
30607
30656
|
"main": true,
|
|
@@ -30744,8 +30793,8 @@
|
|
|
30744
30793
|
"description": "",
|
|
30745
30794
|
"slug": "utility-process",
|
|
30746
30795
|
"websiteUrl": "https://electronjs.org/docs/api/utility-process",
|
|
30747
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
30748
|
-
"version": "37.
|
|
30796
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/utility-process.md",
|
|
30797
|
+
"version": "37.10.3",
|
|
30749
30798
|
"type": "Class",
|
|
30750
30799
|
"process": {
|
|
30751
30800
|
"main": true,
|
|
@@ -30940,8 +30989,8 @@
|
|
|
30940
30989
|
"description": "> Create and layout native views.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Class: View\n\n> A basic native view.\n\nProcess: Main\n\n`View` is an EventEmitter.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
30941
30990
|
"slug": "view",
|
|
30942
30991
|
"websiteUrl": "https://electronjs.org/docs/api/view",
|
|
30943
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
30944
|
-
"version": "37.
|
|
30992
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/view.md",
|
|
30993
|
+
"version": "37.10.3",
|
|
30945
30994
|
"type": "Class",
|
|
30946
30995
|
"process": {
|
|
30947
30996
|
"main": true,
|
|
@@ -31121,8 +31170,8 @@
|
|
|
31121
31170
|
"description": "> A View that displays a WebContents.\n\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\n\n### Class: WebContentsView extends `View`\n\n> A View that displays a WebContents.\n\nProcess: Main\n\n`WebContentsView` inherits from `View`.\n\n`WebContentsView` is an EventEmitter.\n\n> [!WARNING] Electron's built-in classes cannot be subclassed in user code. For more information, see the FAQ.",
|
|
31122
31171
|
"slug": "web-contents-view",
|
|
31123
31172
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents-view",
|
|
31124
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
31125
|
-
"version": "37.
|
|
31173
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/web-contents-view.md",
|
|
31174
|
+
"version": "37.10.3",
|
|
31126
31175
|
"type": "Class",
|
|
31127
31176
|
"process": {
|
|
31128
31177
|
"main": true,
|
|
@@ -31184,8 +31233,8 @@
|
|
|
31184
31233
|
"description": "> Render and control web pages.\n\nProcess: Main\n\n`webContents` is an EventEmitter. It is responsible for rendering and controlling a web page and is a property of the `BrowserWindow` object. An example of accessing the `webContents` object:\n\n### Navigation Events\n\nSeveral events can be used to monitor navigations as they occur within a `webContents`.\n\n### Document Navigations\n\nWhen a `webContents` navigates to another page (as opposed to an in-page navigation), the following events will be fired.\n\n* `did-start-navigation`\n* `will-frame-navigate`\n* `will-navigate` (only fired when main frame navigates)\n* `will-redirect` (only fired when a redirect happens during navigation)\n* `did-redirect-navigation` (only fired when a redirect happens during navigation)\n* `did-frame-navigate`\n* `did-navigate` (only fired when main frame navigates)\n\nSubsequent events will not fire if `event.preventDefault()` is called on any of the cancellable events.\n\n### In-page Navigation\n\nIn-page navigations don't cause the page to reload, but instead navigate to a location within the current page. These events are not cancellable. For an in-page navigations, the following events will fire in this order:\n\n* `did-start-navigation`\n* `did-navigate-in-page`\n\n### Frame Navigation\n\nThe `will-navigate` and `did-navigate` events only fire when the mainFrame navigates. If you want to also observe navigations in `<iframe>`s, use `will-frame-navigate` and `did-frame-navigate` events.",
|
|
31185
31234
|
"slug": "web-contents",
|
|
31186
31235
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents",
|
|
31187
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
31188
|
-
"version": "37.
|
|
31236
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/web-contents.md",
|
|
31237
|
+
"version": "37.10.3",
|
|
31189
31238
|
"type": "Module",
|
|
31190
31239
|
"process": {
|
|
31191
31240
|
"main": true,
|
|
@@ -31325,8 +31374,8 @@
|
|
|
31325
31374
|
"description": "",
|
|
31326
31375
|
"slug": "web-contents",
|
|
31327
31376
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents",
|
|
31328
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
31329
|
-
"version": "37.
|
|
31377
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/web-contents.md",
|
|
31378
|
+
"version": "37.10.3",
|
|
31330
31379
|
"type": "Class",
|
|
31331
31380
|
"process": {
|
|
31332
31381
|
"main": true,
|
|
@@ -37502,8 +37551,8 @@
|
|
|
37502
37551
|
"description": "> Control web pages and iframes.\n\nProcess: Main\n\nThe `webFrameMain` module can be used to lookup frames across existing `WebContents` instances. Navigation events are the common use case.\n\n```\nconst { BrowserWindow, webFrameMain } = require('electron')\n\nconst win = new BrowserWindow({ width: 800, height: 1500 })\nwin.loadURL('https://twitter.com')\n\nwin.webContents.on(\n 'did-frame-navigate',\n (event, url, httpResponseCode, httpStatusText, isMainFrame, frameProcessId, frameRoutingId) => {\n const frame = webFrameMain.fromId(frameProcessId, frameRoutingId)\n if (frame) {\n const code = 'document.body.innerHTML = document.body.innerHTML.replaceAll(\"heck\", \"h*ck\")'\n frame.executeJavaScript(code)\n }\n }\n)\n```\n\nYou can also access frames of existing pages by using the `mainFrame` property of `WebContents`.",
|
|
37503
37552
|
"slug": "web-frame-main",
|
|
37504
37553
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
|
|
37505
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
37506
|
-
"version": "37.
|
|
37554
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/web-frame-main.md",
|
|
37555
|
+
"version": "37.10.3",
|
|
37507
37556
|
"type": "Module",
|
|
37508
37557
|
"process": {
|
|
37509
37558
|
"main": true,
|
|
@@ -37558,8 +37607,8 @@
|
|
|
37558
37607
|
"description": "",
|
|
37559
37608
|
"slug": "web-frame-main",
|
|
37560
37609
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
|
|
37561
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
37562
|
-
"version": "37.
|
|
37610
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/web-frame-main.md",
|
|
37611
|
+
"version": "37.10.3",
|
|
37563
37612
|
"type": "Class",
|
|
37564
37613
|
"process": {
|
|
37565
37614
|
"main": true,
|
|
@@ -37917,8 +37966,8 @@
|
|
|
37917
37966
|
"description": "> Customize the rendering of the current web page.\n\nProcess: Renderer\n\n`webFrame` export of the Electron module is an instance of the `WebFrame` class representing the current frame. Sub-frames can be retrieved by certain properties and methods (e.g. `webFrame.firstChild`).\n\nAn example of zooming current page to 200%.",
|
|
37918
37967
|
"slug": "web-frame",
|
|
37919
37968
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame",
|
|
37920
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
37921
|
-
"version": "37.
|
|
37969
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/web-frame.md",
|
|
37970
|
+
"version": "37.10.3",
|
|
37922
37971
|
"type": "Module",
|
|
37923
37972
|
"process": {
|
|
37924
37973
|
"main": false,
|
|
@@ -38631,8 +38680,8 @@
|
|
|
38631
38680
|
"description": "",
|
|
38632
38681
|
"slug": "web-request",
|
|
38633
38682
|
"websiteUrl": "https://electronjs.org/docs/api/web-request",
|
|
38634
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
38635
|
-
"version": "37.
|
|
38683
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/web-request.md",
|
|
38684
|
+
"version": "37.10.3",
|
|
38636
38685
|
"type": "Class",
|
|
38637
38686
|
"process": {
|
|
38638
38687
|
"main": true,
|
|
@@ -40549,8 +40598,8 @@
|
|
|
40549
40598
|
"description": "> A utility layer to interact with Web API objects (Files, Blobs, etc.)\n\nProcess: Renderer",
|
|
40550
40599
|
"slug": "web-utils",
|
|
40551
40600
|
"websiteUrl": "https://electronjs.org/docs/api/web-utils",
|
|
40552
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
40553
|
-
"version": "37.
|
|
40601
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/web-utils.md",
|
|
40602
|
+
"version": "37.10.3",
|
|
40554
40603
|
"type": "Module",
|
|
40555
40604
|
"process": {
|
|
40556
40605
|
"main": false,
|
|
@@ -40591,8 +40640,8 @@
|
|
|
40591
40640
|
"description": "\n\n### Warning\n\nElectron's `webview` tag is based on Chromium's `webview`, which is undergoing dramatic architectural changes. This impacts the stability of `webviews`, including rendering, navigation, and event routing. We currently recommend to not use the `webview` tag and to consider alternatives, like `iframe`, a `WebContentsView`, or an architecture that avoids embedded content altogether.\n\n### Enabling\n\nBy default the `webview` tag is disabled in Electron >= 5. You need to enable the tag by setting the `webviewTag` webPreferences option when constructing your `BrowserWindow`. For more information see the BrowserWindow constructor docs.\n\n### Overview\n\n> Display external web content in an isolated frame and process.\n\nProcess: Renderer\n _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._\n\nUse the `webview` tag to embed 'guest' content (such as web pages) in your Electron app. The guest content is contained within the `webview` container. An embedded page within your app controls how the guest content is laid out and rendered.\n\nUnlike an `iframe`, the `webview` runs in a separate process than your app. It doesn't have the same permissions as your web page and all interactions between your app and embedded content will be asynchronous. This keeps your app safe from the embedded content.\n\n> [!NOTE] Most methods called on the webview from the host page require a synchronous call to the main process.\n\n### Example\n\nTo embed a web page in your app, add the `webview` tag to your app's embedder page (this is the app page that will display the guest content). In its simplest form, the `webview` tag includes the `src` of the web page and css styles that control the appearance of the `webview` container:\n\n```\n<webview id=\"foo\" src=\"https://www.github.com/\" style=\"display:inline-flex; width:640px; height:480px\"></webview>\n```\n\nIf you want to control the guest content in any way, you can write JavaScript that listens for `webview` events and responds to those events using the `webview` methods. Here's sample code with two event listeners: one that listens for the web page to start loading, the other for the web page to stop loading, and displays a \"loading...\" message during the load time:\n\n```\n<script>\n onload = () => {\n const webview = document.querySelector('webview')\n const indicator = document.querySelector('.indicator')\n\n const loadstart = () => {\n indicator.innerText = 'loading...'\n }\n\n const loadstop = () => {\n indicator.innerText = ''\n }\n\n webview.addEventListener('did-start-loading', loadstart)\n webview.addEventListener('did-stop-loading', loadstop)\n }\n</script>\n```\n\n### Internal implementation\n\nUnder the hood `webview` is implemented with Out-of-Process iframes (OOPIFs). The `webview` tag is essentially a custom element using shadow DOM to wrap an `iframe` element inside it.\n\nSo the behavior of `webview` is very similar to a cross-domain `iframe`, as examples:\n\n* When clicking into a `webview`, the page focus will move from the embedder frame to `webview`.\n* You can not add keyboard, mouse, and scroll event listeners to `webview`.\n* All reactions between the embedder frame and `webview` are asynchronous.\n\n### CSS Styling Notes\n\nPlease note that the `webview` tag's style uses `display:flex;` internally to ensure the child `iframe` element fills the full height and width of its `webview` container when used with traditional and flexbox layouts. Please do not overwrite the default `display:flex;` CSS property, unless specifying `display:inline-flex;` for inline layout.\n\n### Tag Attributes\n\nThe `webview` tag has the following attributes:\n\n### `src`\n\n```\n<webview src=\"https://www.github.com/\"></webview>\n```\n\nA `string` representing the visible URL. Writing to this attribute initiates top-level navigation.\n\nAssigning `src` its own value will reload the current page.\n\nThe `src` attribute can also accept data URLs, such as `data:text/plain,Hello, world!`.\n\n### `nodeintegration`\n\n```\n<webview src=\"https://www.google.com/\" nodeintegration></webview>\n```\n\nA `boolean`. When this attribute is present the guest page in `webview` will have node integration and can use node APIs like `require` and `process` to access low level system resources. Node integration is disabled by default in the guest page.\n\n### `nodeintegrationinsubframes`\n\n```\n<webview src=\"https://www.google.com/\" nodeintegrationinsubframes></webview>\n```\n\nA `boolean` for the experimental option for enabling NodeJS support in sub-frames such as iframes inside the `webview`. All your preloads will load for every iframe, you can use `process.isMainFrame` to determine if you are in the main frame or not. This option is disabled by default in the guest page.\n\n### `plugins`\n\n```\n<webview src=\"https://www.github.com/\" plugins></webview>\n```\n\nA `boolean`. When this attribute is present the guest page in `webview` will be able to use browser plugins. Plugins are disabled by default.\n\n### `preload`\n\n```\n<!-- from a file -->\n<webview src=\"https://www.github.com/\" preload=\"./test.js\"></webview>\n<!-- or if you want to load from an asar archive -->\n<webview src=\"https://www.github.com/\" preload=\"./app.asar/test.js\"></webview>\n```\n\nA `string` that specifies a script that will be loaded before other scripts run in the guest page. The protocol of script's URL must be `file:` (even when using `asar:` archives) because it will be loaded by Node's `require` under the hood, which treats `asar:` archives as virtual directories.\n\nWhen the guest page doesn't have node integration this script will still have access to all Node APIs, but global objects injected by Node will be deleted after this script has finished executing.\n\n### `httpreferrer`\n\n```\n<webview src=\"https://www.github.com/\" httpreferrer=\"https://example.com/\"></webview>\n```\n\nA `string` that sets the referrer URL for the guest page.\n\n### `useragent`\n\n```\n<webview src=\"https://www.github.com/\" useragent=\"Mozilla/5.0 (Windows NT 6.1; WOW64; Trident/7.0; AS; rv:11.0) like Gecko\"></webview>\n```\n\nA `string` that sets the user agent for the guest page before the page is navigated to. Once the page is loaded, use the `setUserAgent` method to change the user agent.\n\n### `disablewebsecurity`\n\n```\n<webview src=\"https://www.github.com/\" disablewebsecurity></webview>\n```\n\nA `boolean`. When this attribute is present the guest page will have web security disabled. Web security is enabled by default.\n\nThis value can only be modified before the first navigation.\n\n### `partition`\n\n```\n<webview src=\"https://github.com\" partition=\"persist:github\"></webview>\n<webview src=\"https://electronjs.org\" partition=\"electron\"></webview>\n```\n\nA `string` that sets the session used by the page. If `partition` starts with `persist:`, the page will use a persistent session available to all pages in the app with the same `partition`. if there is no `persist:` prefix, the page will use an in-memory session. By assigning the same `partition`, multiple pages can share the same session. If the `partition` is unset then default session of the app will be used.\n\nThis value can only be modified before the first navigation, since the session of an active renderer process cannot change. Subsequent attempts to modify the value will fail with a DOM exception.\n\n### `allowpopups`\n\n```\n<webview src=\"https://www.github.com/\" allowpopups></webview>\n```\n\nA `boolean`. When this attribute is present the guest page will be allowed to open new windows. Popups are disabled by default.\n\n### `webpreferences`\n\n```\n<webview src=\"https://github.com\" webpreferences=\"allowRunningInsecureContent, javascript=no\"></webview>\n```\n\nA `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.\n\nThe string follows the same format as the features string in `window.open`. A name by itself is given a `true` boolean value. A preference can be set to another value by including an `=`, followed by the value. Special values `yes` and `1` are interpreted as `true`, while `no` and `0` are interpreted as `false`.\n\n### `enableblinkfeatures`\n\n```\n<webview src=\"https://www.github.com/\" enableblinkfeatures=\"PreciseMemoryInfo, CSSVariables\"></webview>\n```\n\nA `string` which is a list of strings which specifies the blink features to be enabled separated by `,`. The full list of supported feature strings can be found in the RuntimeEnabledFeatures.json5 file.\n\n### `disableblinkfeatures`\n\n```\n<webview src=\"https://www.github.com/\" disableblinkfeatures=\"PreciseMemoryInfo, CSSVariables\"></webview>\n```\n\nA `string` which is a list of strings which specifies the blink features to be disabled separated by `,`. The full list of supported feature strings can be found in the RuntimeEnabledFeatures.json5 file.",
|
|
40592
40641
|
"slug": "webview-tag",
|
|
40593
40642
|
"websiteUrl": "https://electronjs.org/docs/api/webview-tag",
|
|
40594
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
40595
|
-
"version": "37.
|
|
40643
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/webview-tag.md",
|
|
40644
|
+
"version": "37.10.3",
|
|
40596
40645
|
"type": "Element",
|
|
40597
40646
|
"process": {
|
|
40598
40647
|
"main": false,
|
|
@@ -43737,8 +43786,8 @@
|
|
|
43737
43786
|
"description": "When setting minimum or maximum window size with `minWidth`/`maxWidth`/ `minHeight`/`maxHeight`, it only constrains the users. It won't prevent you from passing a size that does not follow size constraints to `setBounds`/`setSize` or to the constructor of `BrowserWindow`.\n\nThe possible values and behaviors of the `type` option are platform dependent. Possible values are:\n\n* On Linux, possible types are `desktop`, `dock`, `toolbar`, `splash`, `notification`.\n * The `desktop` type places the window at the desktop background window level (kCGDesktopWindowLevel - 1). However, note that a desktop window will not receive focus, keyboard, or mouse events. You can still use globalShortcut to receive input sparingly.\n * The `dock` type creates a dock-like window behavior.\n * The `toolbar` type creates a window with a toolbar appearance.\n * The `splash` type behaves in a specific way. It is not draggable, even if the CSS styling of the window's body contains -webkit-app-region: drag. This type is commonly used for splash screens.\n * The `notification` type creates a window that behaves like a system notification.\n* On macOS, possible types are `desktop`, `textured`, `panel`.\n * The `textured` type adds metal gradient appearance. This option is **deprecated**.\n * The `desktop` type places the window at the desktop background window level (`kCGDesktopWindowLevel - 1`). Note that desktop window will not receive focus, keyboard or mouse events, but you can use `globalShortcut` to receive input sparingly.\n * The `panel` type enables the window to float on top of full-screened apps by adding the `NSWindowStyleMaskNonactivatingPanel` style mask, normally reserved for NSPanel, at runtime. Also, the window will appear on all spaces (desktops).\n* On Windows, possible type is `toolbar`.",
|
|
43738
43787
|
"slug": "base-window-options",
|
|
43739
43788
|
"websiteUrl": "https://electronjs.org/docs/api/structures/base-window-options",
|
|
43740
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
43741
|
-
"version": "37.
|
|
43789
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/base-window-options.md",
|
|
43790
|
+
"version": "37.10.3",
|
|
43742
43791
|
"properties": [
|
|
43743
43792
|
{
|
|
43744
43793
|
"name": "width",
|
|
@@ -44377,8 +44426,8 @@
|
|
|
44377
44426
|
"description": "",
|
|
44378
44427
|
"slug": "bluetooth-device",
|
|
44379
44428
|
"websiteUrl": "https://electronjs.org/docs/api/structures/bluetooth-device",
|
|
44380
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44381
|
-
"version": "37.
|
|
44429
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/bluetooth-device.md",
|
|
44430
|
+
"version": "37.10.3",
|
|
44382
44431
|
"properties": [
|
|
44383
44432
|
{
|
|
44384
44433
|
"name": "deviceName",
|
|
@@ -44407,8 +44456,8 @@
|
|
|
44407
44456
|
"description": "",
|
|
44408
44457
|
"slug": "browser-window-options",
|
|
44409
44458
|
"websiteUrl": "https://electronjs.org/docs/api/structures/browser-window-options",
|
|
44410
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44411
|
-
"version": "37.
|
|
44459
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/browser-window-options.md",
|
|
44460
|
+
"version": "37.10.3",
|
|
44412
44461
|
"properties": [
|
|
44413
44462
|
{
|
|
44414
44463
|
"name": "webPreferences",
|
|
@@ -44434,8 +44483,8 @@
|
|
|
44434
44483
|
"description": "",
|
|
44435
44484
|
"slug": "certificate-principal",
|
|
44436
44485
|
"websiteUrl": "https://electronjs.org/docs/api/structures/certificate-principal",
|
|
44437
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44438
|
-
"version": "37.
|
|
44486
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/certificate-principal.md",
|
|
44487
|
+
"version": "37.10.3",
|
|
44439
44488
|
"properties": [
|
|
44440
44489
|
{
|
|
44441
44490
|
"name": "commonName",
|
|
@@ -44499,8 +44548,8 @@
|
|
|
44499
44548
|
"description": "",
|
|
44500
44549
|
"slug": "certificate",
|
|
44501
44550
|
"websiteUrl": "https://electronjs.org/docs/api/structures/certificate",
|
|
44502
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44503
|
-
"version": "37.
|
|
44551
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/certificate.md",
|
|
44552
|
+
"version": "37.10.3",
|
|
44504
44553
|
"properties": [
|
|
44505
44554
|
{
|
|
44506
44555
|
"name": "data",
|
|
@@ -44595,8 +44644,8 @@
|
|
|
44595
44644
|
"description": "",
|
|
44596
44645
|
"slug": "cookie",
|
|
44597
44646
|
"websiteUrl": "https://electronjs.org/docs/api/structures/cookie",
|
|
44598
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44599
|
-
"version": "37.
|
|
44647
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/cookie.md",
|
|
44648
|
+
"version": "37.10.3",
|
|
44600
44649
|
"properties": [
|
|
44601
44650
|
{
|
|
44602
44651
|
"name": "name",
|
|
@@ -44708,8 +44757,8 @@
|
|
|
44708
44757
|
"description": "",
|
|
44709
44758
|
"slug": "cpu-usage",
|
|
44710
44759
|
"websiteUrl": "https://electronjs.org/docs/api/structures/cpu-usage",
|
|
44711
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44712
|
-
"version": "37.
|
|
44760
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/cpu-usage.md",
|
|
44761
|
+
"version": "37.10.3",
|
|
44713
44762
|
"properties": [
|
|
44714
44763
|
{
|
|
44715
44764
|
"name": "percentCPUUsage",
|
|
@@ -44743,8 +44792,8 @@
|
|
|
44743
44792
|
"description": "",
|
|
44744
44793
|
"slug": "crash-report",
|
|
44745
44794
|
"websiteUrl": "https://electronjs.org/docs/api/structures/crash-report",
|
|
44746
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44747
|
-
"version": "37.
|
|
44795
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/crash-report.md",
|
|
44796
|
+
"version": "37.10.3",
|
|
44748
44797
|
"properties": [
|
|
44749
44798
|
{
|
|
44750
44799
|
"name": "date",
|
|
@@ -44771,8 +44820,8 @@
|
|
|
44771
44820
|
"description": "",
|
|
44772
44821
|
"slug": "custom-scheme",
|
|
44773
44822
|
"websiteUrl": "https://electronjs.org/docs/api/structures/custom-scheme",
|
|
44774
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44775
|
-
"version": "37.
|
|
44823
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/custom-scheme.md",
|
|
44824
|
+
"version": "37.10.3",
|
|
44776
44825
|
"properties": [
|
|
44777
44826
|
{
|
|
44778
44827
|
"name": "scheme",
|
|
@@ -44865,8 +44914,8 @@
|
|
|
44865
44914
|
"description": "",
|
|
44866
44915
|
"slug": "desktop-capturer-source",
|
|
44867
44916
|
"websiteUrl": "https://electronjs.org/docs/api/structures/desktop-capturer-source",
|
|
44868
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44869
|
-
"version": "37.
|
|
44917
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/desktop-capturer-source.md",
|
|
44918
|
+
"version": "37.10.3",
|
|
44870
44919
|
"properties": [
|
|
44871
44920
|
{
|
|
44872
44921
|
"name": "id",
|
|
@@ -44919,8 +44968,8 @@
|
|
|
44919
44968
|
"description": "The `Display` object represents a physical display connected to the system. A fake `Display` may exist on a headless system, or a `Display` may correspond to a remote, virtual display.",
|
|
44920
44969
|
"slug": "display",
|
|
44921
44970
|
"websiteUrl": "https://electronjs.org/docs/api/structures/display",
|
|
44922
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
44923
|
-
"version": "37.
|
|
44971
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/display.md",
|
|
44972
|
+
"version": "37.10.3",
|
|
44924
44973
|
"properties": [
|
|
44925
44974
|
{
|
|
44926
44975
|
"name": "accelerometerSupport",
|
|
@@ -45112,8 +45161,8 @@
|
|
|
45112
45161
|
"description": "",
|
|
45113
45162
|
"slug": "extension-info",
|
|
45114
45163
|
"websiteUrl": "https://electronjs.org/docs/api/structures/extension-info",
|
|
45115
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45116
|
-
"version": "37.
|
|
45164
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/extension-info.md",
|
|
45165
|
+
"version": "37.10.3",
|
|
45117
45166
|
"properties": [
|
|
45118
45167
|
{
|
|
45119
45168
|
"name": "name",
|
|
@@ -45141,8 +45190,8 @@
|
|
|
45141
45190
|
"description": "",
|
|
45142
45191
|
"slug": "extension",
|
|
45143
45192
|
"websiteUrl": "https://electronjs.org/docs/api/structures/extension",
|
|
45144
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45145
|
-
"version": "37.
|
|
45193
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/extension.md",
|
|
45194
|
+
"version": "37.10.3",
|
|
45146
45195
|
"properties": [
|
|
45147
45196
|
{
|
|
45148
45197
|
"name": "id",
|
|
@@ -45205,8 +45254,8 @@
|
|
|
45205
45254
|
"description": "",
|
|
45206
45255
|
"slug": "file-filter",
|
|
45207
45256
|
"websiteUrl": "https://electronjs.org/docs/api/structures/file-filter",
|
|
45208
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45209
|
-
"version": "37.
|
|
45257
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/file-filter.md",
|
|
45258
|
+
"version": "37.10.3",
|
|
45210
45259
|
"properties": [
|
|
45211
45260
|
{
|
|
45212
45261
|
"name": "name",
|
|
@@ -45234,8 +45283,8 @@
|
|
|
45234
45283
|
"description": "",
|
|
45235
45284
|
"slug": "file-path-with-headers",
|
|
45236
45285
|
"websiteUrl": "https://electronjs.org/docs/api/structures/file-path-with-headers",
|
|
45237
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45238
|
-
"version": "37.
|
|
45286
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/file-path-with-headers.md",
|
|
45287
|
+
"version": "37.10.3",
|
|
45239
45288
|
"properties": [
|
|
45240
45289
|
{
|
|
45241
45290
|
"name": "path",
|
|
@@ -45275,8 +45324,8 @@
|
|
|
45275
45324
|
"description": "",
|
|
45276
45325
|
"slug": "filesystem-permission-request",
|
|
45277
45326
|
"websiteUrl": "https://electronjs.org/docs/api/structures/filesystem-permission-request",
|
|
45278
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45279
|
-
"version": "37.
|
|
45327
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/filesystem-permission-request.md",
|
|
45328
|
+
"version": "37.10.3",
|
|
45280
45329
|
"properties": [
|
|
45281
45330
|
{
|
|
45282
45331
|
"name": "filePath",
|
|
@@ -45321,8 +45370,8 @@
|
|
|
45321
45370
|
"description": "Possible values:\n\n* `disabled_software` - Software only. Hardware acceleration disabled (yellow)\n* `disabled_off` - Disabled (red)\n* `disabled_off_ok` - Disabled (yellow)\n* `unavailable_software` - Software only, hardware acceleration unavailable (yellow)\n* `unavailable_off` - Unavailable (red)\n* `unavailable_off_ok` - Unavailable (yellow)\n* `enabled_readback` - Hardware accelerated but at reduced performance (yellow)\n* `enabled_force` - Hardware accelerated on all pages (green)\n* `enabled` - Hardware accelerated (green)\n* `enabled_on` - Enabled (green)\n* `enabled_force_on` - Force enabled (green)",
|
|
45322
45371
|
"slug": "gpu-feature-status",
|
|
45323
45372
|
"websiteUrl": "https://electronjs.org/docs/api/structures/gpu-feature-status",
|
|
45324
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45325
|
-
"version": "37.
|
|
45373
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/gpu-feature-status.md",
|
|
45374
|
+
"version": "37.10.3",
|
|
45326
45375
|
"properties": [
|
|
45327
45376
|
{
|
|
45328
45377
|
"name": "2d_canvas",
|
|
@@ -45449,8 +45498,8 @@
|
|
|
45449
45498
|
"description": "",
|
|
45450
45499
|
"slug": "hid-device",
|
|
45451
45500
|
"websiteUrl": "https://electronjs.org/docs/api/structures/hid-device",
|
|
45452
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45453
|
-
"version": "37.
|
|
45501
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/hid-device.md",
|
|
45502
|
+
"version": "37.10.3",
|
|
45454
45503
|
"properties": [
|
|
45455
45504
|
{
|
|
45456
45505
|
"name": "deviceId",
|
|
@@ -45582,8 +45631,8 @@
|
|
|
45582
45631
|
"description": "",
|
|
45583
45632
|
"slug": "input-event",
|
|
45584
45633
|
"websiteUrl": "https://electronjs.org/docs/api/structures/input-event",
|
|
45585
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45586
|
-
"version": "37.
|
|
45634
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/input-event.md",
|
|
45635
|
+
"version": "37.10.3",
|
|
45587
45636
|
"properties": [
|
|
45588
45637
|
{
|
|
45589
45638
|
"name": "type",
|
|
@@ -45842,8 +45891,8 @@
|
|
|
45842
45891
|
"description": "",
|
|
45843
45892
|
"slug": "ipc-main-event",
|
|
45844
45893
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-event",
|
|
45845
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45846
|
-
"version": "37.
|
|
45894
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/ipc-main-event.md",
|
|
45895
|
+
"version": "37.10.3",
|
|
45847
45896
|
"properties": [
|
|
45848
45897
|
{
|
|
45849
45898
|
"name": "type",
|
|
@@ -45953,8 +46002,8 @@
|
|
|
45953
46002
|
"description": "",
|
|
45954
46003
|
"slug": "ipc-main-invoke-event",
|
|
45955
46004
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-invoke-event",
|
|
45956
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
45957
|
-
"version": "37.
|
|
46005
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/ipc-main-invoke-event.md",
|
|
46006
|
+
"version": "37.10.3",
|
|
45958
46007
|
"properties": [
|
|
45959
46008
|
{
|
|
45960
46009
|
"name": "type",
|
|
@@ -46022,8 +46071,8 @@
|
|
|
46022
46071
|
"description": "",
|
|
46023
46072
|
"slug": "ipc-main-service-worker-event",
|
|
46024
46073
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-service-worker-event",
|
|
46025
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46026
|
-
"version": "37.
|
|
46074
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/ipc-main-service-worker-event.md",
|
|
46075
|
+
"version": "37.10.3",
|
|
46027
46076
|
"properties": [
|
|
46028
46077
|
{
|
|
46029
46078
|
"name": "type",
|
|
@@ -46116,8 +46165,8 @@
|
|
|
46116
46165
|
"description": "",
|
|
46117
46166
|
"slug": "ipc-main-service-worker-invoke-event",
|
|
46118
46167
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-service-worker-invoke-event",
|
|
46119
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46120
|
-
"version": "37.
|
|
46168
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/ipc-main-service-worker-invoke-event.md",
|
|
46169
|
+
"version": "37.10.3",
|
|
46121
46170
|
"properties": [
|
|
46122
46171
|
{
|
|
46123
46172
|
"name": "type",
|
|
@@ -46168,8 +46217,8 @@
|
|
|
46168
46217
|
"description": "",
|
|
46169
46218
|
"slug": "ipc-renderer-event",
|
|
46170
46219
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-renderer-event",
|
|
46171
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46172
|
-
"version": "37.
|
|
46220
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/ipc-renderer-event.md",
|
|
46221
|
+
"version": "37.10.3",
|
|
46173
46222
|
"properties": [
|
|
46174
46223
|
{
|
|
46175
46224
|
"name": "sender",
|
|
@@ -46195,8 +46244,8 @@
|
|
|
46195
46244
|
"description": "> [!NOTE] If a `JumpListCategory` object has neither the `type` nor the `name` property set then its `type` is assumed to be `tasks`. If the `name` property is set but the `type` property is omitted then the `type` is assumed to be `custom`.\n\n> [!NOTE] The maximum length of a Jump List item's `description` property is 260 characters. Beyond this limit, the item will not be added to the Jump List, nor will it be displayed.",
|
|
46196
46245
|
"slug": "jump-list-category",
|
|
46197
46246
|
"websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-category",
|
|
46198
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46199
|
-
"version": "37.
|
|
46247
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/jump-list-category.md",
|
|
46248
|
+
"version": "37.10.3",
|
|
46200
46249
|
"properties": [
|
|
46201
46250
|
{
|
|
46202
46251
|
"name": "type",
|
|
@@ -46249,8 +46298,8 @@
|
|
|
46249
46298
|
"description": "",
|
|
46250
46299
|
"slug": "jump-list-item",
|
|
46251
46300
|
"websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-item",
|
|
46252
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46253
|
-
"version": "37.
|
|
46301
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/jump-list-item.md",
|
|
46302
|
+
"version": "37.10.3",
|
|
46254
46303
|
"properties": [
|
|
46255
46304
|
{
|
|
46256
46305
|
"name": "type",
|
|
@@ -46353,8 +46402,8 @@
|
|
|
46353
46402
|
"description": "",
|
|
46354
46403
|
"slug": "keyboard-event",
|
|
46355
46404
|
"websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-event",
|
|
46356
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46357
|
-
"version": "37.
|
|
46405
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/keyboard-event.md",
|
|
46406
|
+
"version": "37.10.3",
|
|
46358
46407
|
"properties": [
|
|
46359
46408
|
{
|
|
46360
46409
|
"name": "ctrlKey",
|
|
@@ -46405,8 +46454,8 @@
|
|
|
46405
46454
|
"description": "",
|
|
46406
46455
|
"slug": "keyboard-input-event",
|
|
46407
46456
|
"websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-input-event",
|
|
46408
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46409
|
-
"version": "37.
|
|
46457
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/keyboard-input-event.md",
|
|
46458
|
+
"version": "37.10.3",
|
|
46410
46459
|
"properties": [
|
|
46411
46460
|
{
|
|
46412
46461
|
"name": "type",
|
|
@@ -46452,8 +46501,8 @@
|
|
|
46452
46501
|
"description": "",
|
|
46453
46502
|
"slug": "media-access-permission-request",
|
|
46454
46503
|
"websiteUrl": "https://electronjs.org/docs/api/structures/media-access-permission-request",
|
|
46455
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46456
|
-
"version": "37.
|
|
46504
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/media-access-permission-request.md",
|
|
46505
|
+
"version": "37.10.3",
|
|
46457
46506
|
"properties": [
|
|
46458
46507
|
{
|
|
46459
46508
|
"name": "securityOrigin",
|
|
@@ -46490,8 +46539,8 @@
|
|
|
46490
46539
|
"description": "Note that all statistics are reported in Kilobytes.",
|
|
46491
46540
|
"slug": "memory-info",
|
|
46492
46541
|
"websiteUrl": "https://electronjs.org/docs/api/structures/memory-info",
|
|
46493
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46494
|
-
"version": "37.
|
|
46542
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/memory-info.md",
|
|
46543
|
+
"version": "37.10.3",
|
|
46495
46544
|
"properties": [
|
|
46496
46545
|
{
|
|
46497
46546
|
"name": "workingSetSize",
|
|
@@ -46527,8 +46576,8 @@
|
|
|
46527
46576
|
"description": "",
|
|
46528
46577
|
"slug": "memory-usage-details",
|
|
46529
46578
|
"websiteUrl": "https://electronjs.org/docs/api/structures/memory-usage-details",
|
|
46530
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46531
|
-
"version": "37.
|
|
46579
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/memory-usage-details.md",
|
|
46580
|
+
"version": "37.10.3",
|
|
46532
46581
|
"properties": [
|
|
46533
46582
|
{
|
|
46534
46583
|
"name": "count",
|
|
@@ -46562,8 +46611,8 @@
|
|
|
46562
46611
|
"description": "",
|
|
46563
46612
|
"slug": "mime-typed-buffer",
|
|
46564
46613
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mime-typed-buffer",
|
|
46565
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46566
|
-
"version": "37.
|
|
46614
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/mime-typed-buffer.md",
|
|
46615
|
+
"version": "37.10.3",
|
|
46567
46616
|
"properties": [
|
|
46568
46617
|
{
|
|
46569
46618
|
"name": "mimeType",
|
|
@@ -46600,8 +46649,8 @@
|
|
|
46600
46649
|
"description": "",
|
|
46601
46650
|
"slug": "mouse-input-event",
|
|
46602
46651
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mouse-input-event",
|
|
46603
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46604
|
-
"version": "37.
|
|
46652
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/mouse-input-event.md",
|
|
46653
|
+
"version": "37.10.3",
|
|
46605
46654
|
"properties": [
|
|
46606
46655
|
{
|
|
46607
46656
|
"name": "type",
|
|
@@ -46728,8 +46777,8 @@
|
|
|
46728
46777
|
"description": "",
|
|
46729
46778
|
"slug": "mouse-wheel-input-event",
|
|
46730
46779
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mouse-wheel-input-event",
|
|
46731
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46732
|
-
"version": "37.
|
|
46780
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/mouse-wheel-input-event.md",
|
|
46781
|
+
"version": "37.10.3",
|
|
46733
46782
|
"properties": [
|
|
46734
46783
|
{
|
|
46735
46784
|
"name": "type",
|
|
@@ -46817,8 +46866,8 @@
|
|
|
46817
46866
|
"description": "",
|
|
46818
46867
|
"slug": "navigation-entry",
|
|
46819
46868
|
"websiteUrl": "https://electronjs.org/docs/api/structures/navigation-entry",
|
|
46820
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46821
|
-
"version": "37.
|
|
46869
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/navigation-entry.md",
|
|
46870
|
+
"version": "37.10.3",
|
|
46822
46871
|
"properties": [
|
|
46823
46872
|
{
|
|
46824
46873
|
"name": "url",
|
|
@@ -46855,8 +46904,8 @@
|
|
|
46855
46904
|
"description": "",
|
|
46856
46905
|
"slug": "notification-action",
|
|
46857
46906
|
"websiteUrl": "https://electronjs.org/docs/api/structures/notification-action",
|
|
46858
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46859
|
-
"version": "37.
|
|
46907
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/notification-action.md",
|
|
46908
|
+
"version": "37.10.3",
|
|
46860
46909
|
"properties": [
|
|
46861
46910
|
{
|
|
46862
46911
|
"name": "type",
|
|
@@ -46889,8 +46938,8 @@
|
|
|
46889
46938
|
"description": "",
|
|
46890
46939
|
"slug": "notification-response",
|
|
46891
46940
|
"websiteUrl": "https://electronjs.org/docs/api/structures/notification-response",
|
|
46892
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46893
|
-
"version": "37.
|
|
46941
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/notification-response.md",
|
|
46942
|
+
"version": "37.10.3",
|
|
46894
46943
|
"properties": [
|
|
46895
46944
|
{
|
|
46896
46945
|
"name": "actionIdentifier",
|
|
@@ -46954,8 +47003,8 @@
|
|
|
46954
47003
|
"description": "",
|
|
46955
47004
|
"slug": "offscreen-shared-texture",
|
|
46956
47005
|
"websiteUrl": "https://electronjs.org/docs/api/structures/offscreen-shared-texture",
|
|
46957
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
46958
|
-
"version": "37.
|
|
47006
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/offscreen-shared-texture.md",
|
|
47007
|
+
"version": "37.10.3",
|
|
46959
47008
|
"properties": [
|
|
46960
47009
|
{
|
|
46961
47010
|
"name": "textureInfo",
|
|
@@ -47162,8 +47211,8 @@
|
|
|
47162
47211
|
"description": "",
|
|
47163
47212
|
"slug": "open-external-permission-request",
|
|
47164
47213
|
"websiteUrl": "https://electronjs.org/docs/api/structures/open-external-permission-request",
|
|
47165
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47166
|
-
"version": "37.
|
|
47214
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/open-external-permission-request.md",
|
|
47215
|
+
"version": "37.10.3",
|
|
47167
47216
|
"properties": [
|
|
47168
47217
|
{
|
|
47169
47218
|
"name": "externalURL",
|
|
@@ -47182,8 +47231,8 @@
|
|
|
47182
47231
|
"description": "",
|
|
47183
47232
|
"slug": "payment-discount",
|
|
47184
47233
|
"websiteUrl": "https://electronjs.org/docs/api/structures/payment-discount",
|
|
47185
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47186
|
-
"version": "37.
|
|
47234
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/payment-discount.md",
|
|
47235
|
+
"version": "37.10.3",
|
|
47187
47236
|
"properties": [
|
|
47188
47237
|
{
|
|
47189
47238
|
"name": "identifier",
|
|
@@ -47237,8 +47286,8 @@
|
|
|
47237
47286
|
"description": "",
|
|
47238
47287
|
"slug": "permission-request",
|
|
47239
47288
|
"websiteUrl": "https://electronjs.org/docs/api/structures/permission-request",
|
|
47240
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47241
|
-
"version": "37.
|
|
47289
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/permission-request.md",
|
|
47290
|
+
"version": "37.10.3",
|
|
47242
47291
|
"properties": [
|
|
47243
47292
|
{
|
|
47244
47293
|
"name": "requestingUrl",
|
|
@@ -47265,8 +47314,8 @@
|
|
|
47265
47314
|
"description": "> [!NOTE] Both `x` and `y` must be whole integers, when providing a point object as input to an Electron API we will automatically round your `x` and `y` values to the nearest whole integer.",
|
|
47266
47315
|
"slug": "point",
|
|
47267
47316
|
"websiteUrl": "https://electronjs.org/docs/api/structures/point",
|
|
47268
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47269
|
-
"version": "37.
|
|
47317
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/point.md",
|
|
47318
|
+
"version": "37.10.3",
|
|
47270
47319
|
"properties": [
|
|
47271
47320
|
{
|
|
47272
47321
|
"name": "x",
|
|
@@ -47292,8 +47341,8 @@
|
|
|
47292
47341
|
"description": "",
|
|
47293
47342
|
"slug": "post-body",
|
|
47294
47343
|
"websiteUrl": "https://electronjs.org/docs/api/structures/post-body",
|
|
47295
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47296
|
-
"version": "37.
|
|
47344
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/post-body.md",
|
|
47345
|
+
"version": "37.10.3",
|
|
47297
47346
|
"properties": [
|
|
47298
47347
|
{
|
|
47299
47348
|
"name": "data",
|
|
@@ -47338,8 +47387,8 @@
|
|
|
47338
47387
|
"description": "",
|
|
47339
47388
|
"slug": "preload-script-registration",
|
|
47340
47389
|
"websiteUrl": "https://electronjs.org/docs/api/structures/preload-script-registration",
|
|
47341
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47342
|
-
"version": "37.
|
|
47390
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/preload-script-registration.md",
|
|
47391
|
+
"version": "37.10.3",
|
|
47343
47392
|
"properties": [
|
|
47344
47393
|
{
|
|
47345
47394
|
"name": "type",
|
|
@@ -47385,8 +47434,8 @@
|
|
|
47385
47434
|
"description": "",
|
|
47386
47435
|
"slug": "preload-script",
|
|
47387
47436
|
"websiteUrl": "https://electronjs.org/docs/api/structures/preload-script",
|
|
47388
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47389
|
-
"version": "37.
|
|
47437
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/preload-script.md",
|
|
47438
|
+
"version": "37.10.3",
|
|
47390
47439
|
"properties": [
|
|
47391
47440
|
{
|
|
47392
47441
|
"name": "type",
|
|
@@ -47432,8 +47481,8 @@
|
|
|
47432
47481
|
"description": "",
|
|
47433
47482
|
"slug": "printer-info",
|
|
47434
47483
|
"websiteUrl": "https://electronjs.org/docs/api/structures/printer-info",
|
|
47435
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47436
|
-
"version": "37.
|
|
47484
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/printer-info.md",
|
|
47485
|
+
"version": "37.10.3",
|
|
47437
47486
|
"properties": [
|
|
47438
47487
|
{
|
|
47439
47488
|
"name": "name",
|
|
@@ -47479,8 +47528,8 @@
|
|
|
47479
47528
|
"description": "",
|
|
47480
47529
|
"slug": "process-memory-info",
|
|
47481
47530
|
"websiteUrl": "https://electronjs.org/docs/api/structures/process-memory-info",
|
|
47482
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47483
|
-
"version": "37.
|
|
47531
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/process-memory-info.md",
|
|
47532
|
+
"version": "37.10.3",
|
|
47484
47533
|
"properties": [
|
|
47485
47534
|
{
|
|
47486
47535
|
"name": "residentSet",
|
|
@@ -47517,8 +47566,8 @@
|
|
|
47517
47566
|
"description": "",
|
|
47518
47567
|
"slug": "process-metric",
|
|
47519
47568
|
"websiteUrl": "https://electronjs.org/docs/api/structures/process-metric",
|
|
47520
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47521
|
-
"version": "37.
|
|
47569
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/process-metric.md",
|
|
47570
|
+
"version": "37.10.3",
|
|
47522
47571
|
"properties": [
|
|
47523
47572
|
{
|
|
47524
47573
|
"name": "pid",
|
|
@@ -47667,8 +47716,8 @@
|
|
|
47667
47716
|
"description": "",
|
|
47668
47717
|
"slug": "product-discount",
|
|
47669
47718
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product-discount",
|
|
47670
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47671
|
-
"version": "37.
|
|
47719
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/product-discount.md",
|
|
47720
|
+
"version": "37.10.3",
|
|
47672
47721
|
"properties": [
|
|
47673
47722
|
{
|
|
47674
47723
|
"name": "identifier",
|
|
@@ -47750,8 +47799,8 @@
|
|
|
47750
47799
|
"description": "",
|
|
47751
47800
|
"slug": "product-subscription-period",
|
|
47752
47801
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product-subscription-period",
|
|
47753
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47754
|
-
"version": "37.
|
|
47802
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/product-subscription-period.md",
|
|
47803
|
+
"version": "37.10.3",
|
|
47755
47804
|
"properties": [
|
|
47756
47805
|
{
|
|
47757
47806
|
"name": "numberOfUnits",
|
|
@@ -47795,8 +47844,8 @@
|
|
|
47795
47844
|
"description": "",
|
|
47796
47845
|
"slug": "product",
|
|
47797
47846
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product",
|
|
47798
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47799
|
-
"version": "37.
|
|
47847
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/product.md",
|
|
47848
|
+
"version": "37.10.3",
|
|
47800
47849
|
"properties": [
|
|
47801
47850
|
{
|
|
47802
47851
|
"name": "productIdentifier",
|
|
@@ -47917,8 +47966,8 @@
|
|
|
47917
47966
|
"description": "",
|
|
47918
47967
|
"slug": "protocol-request",
|
|
47919
47968
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-request",
|
|
47920
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47921
|
-
"version": "37.
|
|
47969
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/protocol-request.md",
|
|
47970
|
+
"version": "37.10.3",
|
|
47922
47971
|
"properties": [
|
|
47923
47972
|
{
|
|
47924
47973
|
"name": "url",
|
|
@@ -47983,8 +48032,8 @@
|
|
|
47983
48032
|
"description": "",
|
|
47984
48033
|
"slug": "protocol-response-upload-data",
|
|
47985
48034
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response-upload-data",
|
|
47986
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
47987
|
-
"version": "37.
|
|
48035
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/protocol-response-upload-data.md",
|
|
48036
|
+
"version": "37.10.3",
|
|
47988
48037
|
"properties": [
|
|
47989
48038
|
{
|
|
47990
48039
|
"name": "contentType",
|
|
@@ -48021,8 +48070,8 @@
|
|
|
48021
48070
|
"description": "",
|
|
48022
48071
|
"slug": "protocol-response",
|
|
48023
48072
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response",
|
|
48024
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48025
|
-
"version": "37.
|
|
48073
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/protocol-response.md",
|
|
48074
|
+
"version": "37.10.3",
|
|
48026
48075
|
"properties": [
|
|
48027
48076
|
{
|
|
48028
48077
|
"name": "error",
|
|
@@ -48170,8 +48219,8 @@
|
|
|
48170
48219
|
"description": "When `mode` is unspecified, `pacScript` and `proxyRules` are provided together, the `proxyRules` option is ignored and `pacScript` configuration is applied.\n\nThe `proxyRules` has to follow the rules below:\n\nFor example:\n\n* `http=foopy:80;ftp=foopy2` - Use HTTP proxy `foopy:80` for `http://` URLs, and HTTP proxy `foopy2:80` for `ftp://` URLs.\n* `foopy:80` - Use HTTP proxy `foopy:80` for all URLs.\n* `foopy:80,bar,direct://` - Use HTTP proxy `foopy:80` for all URLs, failing over to `bar` if `foopy:80` is unavailable, and after that using no proxy.\n* `socks4://foopy` - Use SOCKS v4 proxy `foopy:1080` for all URLs.\n* `http=foopy,socks5://bar.com` - Use HTTP proxy `foopy` for http URLs, and fail over to the SOCKS5 proxy `bar.com` if `foopy` is unavailable.\n* `http=foopy,direct://` - Use HTTP proxy `foopy` for http URLs, and use no proxy if `foopy` is unavailable.\n* `http=foopy;socks=foopy2` - Use HTTP proxy `foopy` for http URLs, and use `socks4://foopy2` for all other URLs.\n\nThe `proxyBypassRules` is a comma separated list of rules described below:\n\n* `[ URL_SCHEME \"://\" ] HOSTNAME_PATTERN [ \":\" <port> ]`\n\nMatch all hostnames that match the pattern HOSTNAME_PATTERN.\n\nExamples: \"foobar.com\", \"*foobar.com\", \"*.foobar.com\", \"*foobar.com:99\", \"https://x.*.y.com:99\"\n* `\".\" HOSTNAME_SUFFIX_PATTERN [ \":\" PORT ]`\n\nMatch a particular domain suffix.\n\nExamples: \".google.com\", \".com\", \"http://.google.com\"\n* `[ SCHEME \"://\" ] IP_LITERAL [ \":\" PORT ]`\n\nMatch URLs which are IP address literals.\n\nExamples: \"127.0.1\", \"[0:0::1]\", \"[::1]\", \"http://[::1]:99\"\n* `IP_LITERAL \"/\" PREFIX_LENGTH_IN_BITS`\n\nMatch any URL that is to an IP literal that falls between the given range. IP range is specified using CIDR notation.\n\nExamples: \"192.168.1.1/16\", \"fefe:13::abc/33\".\n* `<local>`\n\nMatch local addresses. The meaning of `<local>` is whether the host matches one of: \"127.0.0.1\", \"::1\", \"localhost\".",
|
|
48171
48220
|
"slug": "proxy-config",
|
|
48172
48221
|
"websiteUrl": "https://electronjs.org/docs/api/structures/proxy-config",
|
|
48173
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48174
|
-
"version": "37.
|
|
48222
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/proxy-config.md",
|
|
48223
|
+
"version": "37.10.3",
|
|
48175
48224
|
"properties": [
|
|
48176
48225
|
{
|
|
48177
48226
|
"name": "mode",
|
|
@@ -48238,8 +48287,8 @@
|
|
|
48238
48287
|
"description": "",
|
|
48239
48288
|
"slug": "rectangle",
|
|
48240
48289
|
"websiteUrl": "https://electronjs.org/docs/api/structures/rectangle",
|
|
48241
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48242
|
-
"version": "37.
|
|
48290
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/rectangle.md",
|
|
48291
|
+
"version": "37.10.3",
|
|
48243
48292
|
"properties": [
|
|
48244
48293
|
{
|
|
48245
48294
|
"name": "x",
|
|
@@ -48281,8 +48330,8 @@
|
|
|
48281
48330
|
"description": "",
|
|
48282
48331
|
"slug": "referrer",
|
|
48283
48332
|
"websiteUrl": "https://electronjs.org/docs/api/structures/referrer",
|
|
48284
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48285
|
-
"version": "37.
|
|
48333
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/referrer.md",
|
|
48334
|
+
"version": "37.10.3",
|
|
48286
48335
|
"properties": [
|
|
48287
48336
|
{
|
|
48288
48337
|
"name": "url",
|
|
@@ -48343,8 +48392,8 @@
|
|
|
48343
48392
|
"description": "",
|
|
48344
48393
|
"slug": "render-process-gone-details",
|
|
48345
48394
|
"websiteUrl": "https://electronjs.org/docs/api/structures/render-process-gone-details",
|
|
48346
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48347
|
-
"version": "37.
|
|
48395
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/render-process-gone-details.md",
|
|
48396
|
+
"version": "37.10.3",
|
|
48348
48397
|
"properties": [
|
|
48349
48398
|
{
|
|
48350
48399
|
"name": "reason",
|
|
@@ -48400,8 +48449,8 @@
|
|
|
48400
48449
|
"description": "",
|
|
48401
48450
|
"slug": "resolved-endpoint",
|
|
48402
48451
|
"websiteUrl": "https://electronjs.org/docs/api/structures/resolved-endpoint",
|
|
48403
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48404
|
-
"version": "37.
|
|
48452
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/resolved-endpoint.md",
|
|
48453
|
+
"version": "37.10.3",
|
|
48405
48454
|
"properties": [
|
|
48406
48455
|
{
|
|
48407
48456
|
"name": "address",
|
|
@@ -48442,8 +48491,8 @@
|
|
|
48442
48491
|
"description": "",
|
|
48443
48492
|
"slug": "resolved-host",
|
|
48444
48493
|
"websiteUrl": "https://electronjs.org/docs/api/structures/resolved-host",
|
|
48445
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48446
|
-
"version": "37.
|
|
48494
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/resolved-host.md",
|
|
48495
|
+
"version": "37.10.3",
|
|
48447
48496
|
"properties": [
|
|
48448
48497
|
{
|
|
48449
48498
|
"name": "endpoints",
|
|
@@ -48461,8 +48510,8 @@
|
|
|
48461
48510
|
"description": "",
|
|
48462
48511
|
"slug": "scrubber-item",
|
|
48463
48512
|
"websiteUrl": "https://electronjs.org/docs/api/structures/scrubber-item",
|
|
48464
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48465
|
-
"version": "37.
|
|
48513
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/scrubber-item.md",
|
|
48514
|
+
"version": "37.10.3",
|
|
48466
48515
|
"properties": [
|
|
48467
48516
|
{
|
|
48468
48517
|
"name": "label",
|
|
@@ -48489,8 +48538,8 @@
|
|
|
48489
48538
|
"description": "",
|
|
48490
48539
|
"slug": "segmented-control-segment",
|
|
48491
48540
|
"websiteUrl": "https://electronjs.org/docs/api/structures/segmented-control-segment",
|
|
48492
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48493
|
-
"version": "37.
|
|
48541
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/segmented-control-segment.md",
|
|
48542
|
+
"version": "37.10.3",
|
|
48494
48543
|
"properties": [
|
|
48495
48544
|
{
|
|
48496
48545
|
"name": "label",
|
|
@@ -48525,8 +48574,8 @@
|
|
|
48525
48574
|
"description": "",
|
|
48526
48575
|
"slug": "serial-port",
|
|
48527
48576
|
"websiteUrl": "https://electronjs.org/docs/api/structures/serial-port",
|
|
48528
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48529
|
-
"version": "37.
|
|
48577
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/serial-port.md",
|
|
48578
|
+
"version": "37.10.3",
|
|
48530
48579
|
"properties": [
|
|
48531
48580
|
{
|
|
48532
48581
|
"name": "portId",
|
|
@@ -48612,8 +48661,8 @@
|
|
|
48612
48661
|
"description": "",
|
|
48613
48662
|
"slug": "service-worker-info",
|
|
48614
48663
|
"websiteUrl": "https://electronjs.org/docs/api/structures/service-worker-info",
|
|
48615
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48616
|
-
"version": "37.
|
|
48664
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/service-worker-info.md",
|
|
48665
|
+
"version": "37.10.3",
|
|
48617
48666
|
"properties": [
|
|
48618
48667
|
{
|
|
48619
48668
|
"name": "scriptUrl",
|
|
@@ -48657,8 +48706,8 @@
|
|
|
48657
48706
|
"description": "",
|
|
48658
48707
|
"slug": "shared-dictionary-info",
|
|
48659
48708
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shared-dictionary-info",
|
|
48660
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48661
|
-
"version": "37.
|
|
48709
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/shared-dictionary-info.md",
|
|
48710
|
+
"version": "37.10.3",
|
|
48662
48711
|
"properties": [
|
|
48663
48712
|
{
|
|
48664
48713
|
"name": "match",
|
|
@@ -48753,8 +48802,8 @@
|
|
|
48753
48802
|
"description": "",
|
|
48754
48803
|
"slug": "shared-dictionary-usage-info",
|
|
48755
48804
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shared-dictionary-usage-info",
|
|
48756
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48757
|
-
"version": "37.
|
|
48805
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/shared-dictionary-usage-info.md",
|
|
48806
|
+
"version": "37.10.3",
|
|
48758
48807
|
"properties": [
|
|
48759
48808
|
{
|
|
48760
48809
|
"name": "frameOrigin",
|
|
@@ -48790,8 +48839,8 @@
|
|
|
48790
48839
|
"description": "",
|
|
48791
48840
|
"slug": "shared-worker-info",
|
|
48792
48841
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shared-worker-info",
|
|
48793
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48794
|
-
"version": "37.
|
|
48842
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/shared-worker-info.md",
|
|
48843
|
+
"version": "37.10.3",
|
|
48795
48844
|
"properties": [
|
|
48796
48845
|
{
|
|
48797
48846
|
"name": "id",
|
|
@@ -48819,8 +48868,8 @@
|
|
|
48819
48868
|
"description": "",
|
|
48820
48869
|
"slug": "sharing-item",
|
|
48821
48870
|
"websiteUrl": "https://electronjs.org/docs/api/structures/sharing-item",
|
|
48822
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48823
|
-
"version": "37.
|
|
48871
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/sharing-item.md",
|
|
48872
|
+
"version": "37.10.3",
|
|
48824
48873
|
"properties": [
|
|
48825
48874
|
{
|
|
48826
48875
|
"name": "texts",
|
|
@@ -48857,8 +48906,8 @@
|
|
|
48857
48906
|
"description": "",
|
|
48858
48907
|
"slug": "shortcut-details",
|
|
48859
48908
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shortcut-details",
|
|
48860
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48861
|
-
"version": "37.
|
|
48909
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/shortcut-details.md",
|
|
48910
|
+
"version": "37.10.3",
|
|
48862
48911
|
"properties": [
|
|
48863
48912
|
{
|
|
48864
48913
|
"name": "target",
|
|
@@ -48939,8 +48988,8 @@
|
|
|
48939
48988
|
"description": "",
|
|
48940
48989
|
"slug": "size",
|
|
48941
48990
|
"websiteUrl": "https://electronjs.org/docs/api/structures/size",
|
|
48942
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48943
|
-
"version": "37.
|
|
48991
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/size.md",
|
|
48992
|
+
"version": "37.10.3",
|
|
48944
48993
|
"properties": [
|
|
48945
48994
|
{
|
|
48946
48995
|
"name": "width",
|
|
@@ -48966,8 +49015,8 @@
|
|
|
48966
49015
|
"description": "",
|
|
48967
49016
|
"slug": "task",
|
|
48968
49017
|
"websiteUrl": "https://electronjs.org/docs/api/structures/task",
|
|
48969
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
48970
|
-
"version": "37.
|
|
49018
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/task.md",
|
|
49019
|
+
"version": "37.10.3",
|
|
48971
49020
|
"properties": [
|
|
48972
49021
|
{
|
|
48973
49022
|
"name": "program",
|
|
@@ -49039,8 +49088,8 @@
|
|
|
49039
49088
|
"description": "The `flags` is an array that can include following `string`s:\n\n* `enabled` - The button is active and available to the user.\n* `disabled` - The button is disabled. It is present, but has a visual state indicating it will not respond to user action.\n* `dismissonclick` - When the button is clicked, the thumbnail window closes immediately.\n* `nobackground` - Do not draw a button border, use only the image.\n* `hidden` - The button is not shown to the user.\n* `noninteractive` - The button is enabled but not interactive; no pressed button state is drawn. This value is intended for instances where the button is used in a notification.",
|
|
49040
49089
|
"slug": "thumbar-button",
|
|
49041
49090
|
"websiteUrl": "https://electronjs.org/docs/api/structures/thumbar-button",
|
|
49042
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49043
|
-
"version": "37.
|
|
49091
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/thumbar-button.md",
|
|
49092
|
+
"version": "37.10.3",
|
|
49044
49093
|
"properties": [
|
|
49045
49094
|
{
|
|
49046
49095
|
"name": "icon",
|
|
@@ -49086,8 +49135,8 @@
|
|
|
49086
49135
|
"description": "",
|
|
49087
49136
|
"slug": "trace-categories-and-options",
|
|
49088
49137
|
"websiteUrl": "https://electronjs.org/docs/api/structures/trace-categories-and-options",
|
|
49089
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49090
|
-
"version": "37.
|
|
49138
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/trace-categories-and-options.md",
|
|
49139
|
+
"version": "37.10.3",
|
|
49091
49140
|
"properties": [
|
|
49092
49141
|
{
|
|
49093
49142
|
"name": "categoryFilter",
|
|
@@ -49115,8 +49164,8 @@
|
|
|
49115
49164
|
"description": "An example TraceConfig that roughly matches what Chrome DevTools records:",
|
|
49116
49165
|
"slug": "trace-config",
|
|
49117
49166
|
"websiteUrl": "https://electronjs.org/docs/api/structures/trace-config",
|
|
49118
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49119
|
-
"version": "37.
|
|
49167
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/trace-config.md",
|
|
49168
|
+
"version": "37.10.3",
|
|
49120
49169
|
"properties": [
|
|
49121
49170
|
{
|
|
49122
49171
|
"name": "recording_mode",
|
|
@@ -49230,8 +49279,8 @@
|
|
|
49230
49279
|
"description": "",
|
|
49231
49280
|
"slug": "transaction",
|
|
49232
49281
|
"websiteUrl": "https://electronjs.org/docs/api/structures/transaction",
|
|
49233
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49234
|
-
"version": "37.
|
|
49282
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/transaction.md",
|
|
49283
|
+
"version": "37.10.3",
|
|
49235
49284
|
"properties": [
|
|
49236
49285
|
{
|
|
49237
49286
|
"name": "transactionIdentifier",
|
|
@@ -49359,8 +49408,8 @@
|
|
|
49359
49408
|
"description": "",
|
|
49360
49409
|
"slug": "upload-data",
|
|
49361
49410
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-data",
|
|
49362
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49363
|
-
"version": "37.
|
|
49411
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/upload-data.md",
|
|
49412
|
+
"version": "37.10.3",
|
|
49364
49413
|
"properties": [
|
|
49365
49414
|
{
|
|
49366
49415
|
"name": "bytes",
|
|
@@ -49396,8 +49445,8 @@
|
|
|
49396
49445
|
"description": "",
|
|
49397
49446
|
"slug": "upload-file",
|
|
49398
49447
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-file",
|
|
49399
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49400
|
-
"version": "37.
|
|
49448
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/upload-file.md",
|
|
49449
|
+
"version": "37.10.3",
|
|
49401
49450
|
"properties": [
|
|
49402
49451
|
{
|
|
49403
49452
|
"name": "type",
|
|
@@ -49448,8 +49497,8 @@
|
|
|
49448
49497
|
"description": "",
|
|
49449
49498
|
"slug": "upload-raw-data",
|
|
49450
49499
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-raw-data",
|
|
49451
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49452
|
-
"version": "37.
|
|
49500
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/upload-raw-data.md",
|
|
49501
|
+
"version": "37.10.3",
|
|
49453
49502
|
"properties": [
|
|
49454
49503
|
{
|
|
49455
49504
|
"name": "type",
|
|
@@ -49475,8 +49524,8 @@
|
|
|
49475
49524
|
"description": "",
|
|
49476
49525
|
"slug": "usb-device",
|
|
49477
49526
|
"websiteUrl": "https://electronjs.org/docs/api/structures/usb-device",
|
|
49478
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49479
|
-
"version": "37.
|
|
49527
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/usb-device.md",
|
|
49528
|
+
"version": "37.10.3",
|
|
49480
49529
|
"properties": [
|
|
49481
49530
|
{
|
|
49482
49531
|
"name": "deviceId",
|
|
@@ -49610,8 +49659,8 @@
|
|
|
49610
49659
|
"description": "This type is a helper alias, no object will ever exist of this type.",
|
|
49611
49660
|
"slug": "user-default-types",
|
|
49612
49661
|
"websiteUrl": "https://electronjs.org/docs/api/structures/user-default-types",
|
|
49613
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49614
|
-
"version": "37.
|
|
49662
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/user-default-types.md",
|
|
49663
|
+
"version": "37.10.3",
|
|
49615
49664
|
"properties": [
|
|
49616
49665
|
{
|
|
49617
49666
|
"name": "string",
|
|
@@ -49704,8 +49753,8 @@
|
|
|
49704
49753
|
"description": "",
|
|
49705
49754
|
"slug": "web-preferences",
|
|
49706
49755
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-preferences",
|
|
49707
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
49708
|
-
"version": "37.
|
|
49756
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/web-preferences.md",
|
|
49757
|
+
"version": "37.10.3",
|
|
49709
49758
|
"properties": [
|
|
49710
49759
|
{
|
|
49711
49760
|
"name": "devTools",
|
|
@@ -49750,7 +49799,7 @@
|
|
|
49750
49799
|
},
|
|
49751
49800
|
{
|
|
49752
49801
|
"name": "sandbox",
|
|
49753
|
-
"description": "If set, this will sandbox the renderer associated with the window, making it compatible with the Chromium OS-level sandbox and disabling the Node.js engine. This is not the same as the `nodeIntegration` option and the APIs available to the preload script are more limited. Read more about the option here.",
|
|
49802
|
+
"description": "If set, this will sandbox the renderer associated with the window, making it compatible with the Chromium OS-level sandbox and disabling the Node.js engine. This is not the same as the `nodeIntegration` option and the APIs available to the preload script are more limited. Default is `true` since Electron 20. The sandbox will automatically be disabled when `nodeIntegration` is set to `true`. Read more about the option here.",
|
|
49754
49803
|
"required": false,
|
|
49755
49804
|
"additionalTags": [],
|
|
49756
49805
|
"collection": false,
|
|
@@ -50211,8 +50260,8 @@
|
|
|
50211
50260
|
"description": "",
|
|
50212
50261
|
"slug": "web-request-filter",
|
|
50213
50262
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-request-filter",
|
|
50214
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
50215
|
-
"version": "37.
|
|
50263
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/web-request-filter.md",
|
|
50264
|
+
"version": "37.10.3",
|
|
50216
50265
|
"properties": [
|
|
50217
50266
|
{
|
|
50218
50267
|
"name": "urls",
|
|
@@ -50298,8 +50347,8 @@
|
|
|
50298
50347
|
"description": "",
|
|
50299
50348
|
"slug": "web-source",
|
|
50300
50349
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-source",
|
|
50301
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
50302
|
-
"version": "37.
|
|
50350
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/web-source.md",
|
|
50351
|
+
"version": "37.10.3",
|
|
50303
50352
|
"properties": [
|
|
50304
50353
|
{
|
|
50305
50354
|
"name": "code",
|
|
@@ -50327,8 +50376,8 @@
|
|
|
50327
50376
|
"description": "",
|
|
50328
50377
|
"slug": "window-open-handler-response",
|
|
50329
50378
|
"websiteUrl": "https://electronjs.org/docs/api/structures/window-open-handler-response",
|
|
50330
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
50331
|
-
"version": "37.
|
|
50379
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/window-open-handler-response.md",
|
|
50380
|
+
"version": "37.10.3",
|
|
50332
50381
|
"properties": [
|
|
50333
50382
|
{
|
|
50334
50383
|
"name": "action",
|
|
@@ -50381,8 +50430,8 @@
|
|
|
50381
50430
|
"description": "Unfortunately, Windows does not offer a way to differentiate between a shutdown and a reboot, meaning the 'shutdown' reason is triggered in both scenarios. For more details on the `WM_ENDSESSION` message and its associated reasons, refer to the MSDN documentation.",
|
|
50382
50431
|
"slug": "window-session-end-event",
|
|
50383
50432
|
"websiteUrl": "https://electronjs.org/docs/api/structures/window-session-end-event",
|
|
50384
|
-
"repoUrl": "https://github.com/electron/electron/blob/v37.
|
|
50385
|
-
"version": "37.
|
|
50433
|
+
"repoUrl": "https://github.com/electron/electron/blob/v37.10.3/docs/api/structures/window-session-end-event.md",
|
|
50434
|
+
"version": "37.10.3",
|
|
50386
50435
|
"properties": [
|
|
50387
50436
|
{
|
|
50388
50437
|
"name": "reasons",
|