@overwolf/ow-electron 22.3.13 → 22.3.25
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/README.md +1 -1
- package/checksums.json +8 -8
- package/electron-api.json +262 -262
- package/electron.d.ts +1 -1
- package/ow-electron.d.ts +1 -1
- package/package.json +2 -2
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/v22.3.
|
|
8
|
-
"version": "22.3.
|
|
7
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/app.md",
|
|
8
|
+
"version": "22.3.27",
|
|
9
9
|
"type": "Module",
|
|
10
10
|
"process": {
|
|
11
11
|
"main": true,
|
|
@@ -3000,8 +3000,8 @@
|
|
|
3000
3000
|
"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**Note:** 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 the electron-winstaller, Electron Forge or the grunt-electron-installer package to generate a Windows installer.\n\nWhen using electron-winstaller or Electron Forge make sure you do not try to update your app the first time it runs (Also see this issue for more info). It's also recommended to use electron-squirrel-startup to get desktop shortcuts for your app.\n\nThe installer generated with Squirrel 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.\n\nLike Squirrel.Mac, Windows can host updates on S3 or any other static file host. You can read the documents of Squirrel.Windows to get more details about how Squirrel.Windows works.",
|
|
3001
3001
|
"slug": "auto-updater",
|
|
3002
3002
|
"websiteUrl": "https://electronjs.org/docs/api/auto-updater",
|
|
3003
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
3004
|
-
"version": "22.3.
|
|
3003
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/auto-updater.md",
|
|
3004
|
+
"version": "22.3.27",
|
|
3005
3005
|
"type": "Module",
|
|
3006
3006
|
"process": {
|
|
3007
3007
|
"main": true,
|
|
@@ -3210,8 +3210,8 @@
|
|
|
3210
3210
|
"description": "A `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\nProcess: Main\n\nThis module cannot be used until the `ready` event of the `app` module is emitted.\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```",
|
|
3211
3211
|
"slug": "browser-view",
|
|
3212
3212
|
"websiteUrl": "https://electronjs.org/docs/api/browser-view",
|
|
3213
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
3214
|
-
"version": "22.3.
|
|
3213
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/browser-view.md",
|
|
3214
|
+
"version": "22.3.27",
|
|
3215
3215
|
"type": "Class",
|
|
3216
3216
|
"process": {
|
|
3217
3217
|
"main": true,
|
|
@@ -3372,8 +3372,8 @@
|
|
|
3372
3372
|
"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 `parent` and `modal` options:\n\n```\nconst { BrowserWindow } = require('electron')\n\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\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`.",
|
|
3373
3373
|
"slug": "browser-window",
|
|
3374
3374
|
"websiteUrl": "https://electronjs.org/docs/api/browser-window",
|
|
3375
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
3376
|
-
"version": "22.3.
|
|
3375
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/browser-window.md",
|
|
3376
|
+
"version": "22.3.27",
|
|
3377
3377
|
"type": "Class",
|
|
3378
3378
|
"process": {
|
|
3379
3379
|
"main": true,
|
|
@@ -7974,8 +7974,8 @@
|
|
|
7974
7974
|
"description": "> Make HTTP/HTTPS requests.\n\nProcess: Main<br /> _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.",
|
|
7975
7975
|
"slug": "client-request",
|
|
7976
7976
|
"websiteUrl": "https://electronjs.org/docs/api/client-request",
|
|
7977
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
7978
|
-
"version": "22.3.
|
|
7977
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/client-request.md",
|
|
7978
|
+
"version": "22.3.27",
|
|
7979
7979
|
"type": "Class",
|
|
7980
7980
|
"process": {
|
|
7981
7981
|
"main": true,
|
|
@@ -8571,8 +8571,8 @@
|
|
|
8571
8571
|
"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:",
|
|
8572
8572
|
"slug": "clipboard",
|
|
8573
8573
|
"websiteUrl": "https://electronjs.org/docs/api/clipboard",
|
|
8574
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
8575
|
-
"version": "22.3.
|
|
8574
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/clipboard.md",
|
|
8575
|
+
"version": "22.3.27",
|
|
8576
8576
|
"type": "Module",
|
|
8577
8577
|
"process": {
|
|
8578
8578
|
"main": true,
|
|
@@ -9237,8 +9237,8 @@
|
|
|
9237
9237
|
"description": "",
|
|
9238
9238
|
"slug": "command-line",
|
|
9239
9239
|
"websiteUrl": "https://electronjs.org/docs/api/command-line",
|
|
9240
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
9241
|
-
"version": "22.3.
|
|
9240
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/command-line.md",
|
|
9241
|
+
"version": "22.3.27",
|
|
9242
9242
|
"type": "Class",
|
|
9243
9243
|
"process": {
|
|
9244
9244
|
"main": true,
|
|
@@ -9364,8 +9364,8 @@
|
|
|
9364
9364
|
"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.",
|
|
9365
9365
|
"slug": "content-tracing",
|
|
9366
9366
|
"websiteUrl": "https://electronjs.org/docs/api/content-tracing",
|
|
9367
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
9368
|
-
"version": "22.3.
|
|
9367
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/content-tracing.md",
|
|
9368
|
+
"version": "22.3.27",
|
|
9369
9369
|
"type": "Module",
|
|
9370
9370
|
"process": {
|
|
9371
9371
|
"main": true,
|
|
@@ -9501,8 +9501,8 @@
|
|
|
9501
9501
|
"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.",
|
|
9502
9502
|
"slug": "context-bridge",
|
|
9503
9503
|
"websiteUrl": "https://electronjs.org/docs/api/context-bridge",
|
|
9504
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
9505
|
-
"version": "22.3.
|
|
9504
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/context-bridge.md",
|
|
9505
|
+
"version": "22.3.27",
|
|
9506
9506
|
"type": "Module",
|
|
9507
9507
|
"process": {
|
|
9508
9508
|
"main": false,
|
|
@@ -9577,8 +9577,8 @@
|
|
|
9577
9577
|
"description": "",
|
|
9578
9578
|
"slug": "cookies",
|
|
9579
9579
|
"websiteUrl": "https://electronjs.org/docs/api/cookies",
|
|
9580
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
9581
|
-
"version": "22.3.
|
|
9580
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/cookies.md",
|
|
9581
|
+
"version": "22.3.27",
|
|
9582
9582
|
"type": "Class",
|
|
9583
9583
|
"process": {
|
|
9584
9584
|
"main": true,
|
|
@@ -9914,8 +9914,8 @@
|
|
|
9914
9914
|
"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.",
|
|
9915
9915
|
"slug": "crash-reporter",
|
|
9916
9916
|
"websiteUrl": "https://electronjs.org/docs/api/crash-reporter",
|
|
9917
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
9918
|
-
"version": "22.3.
|
|
9917
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/crash-reporter.md",
|
|
9918
|
+
"version": "22.3.27",
|
|
9919
9919
|
"type": "Module",
|
|
9920
9920
|
"process": {
|
|
9921
9921
|
"main": true,
|
|
@@ -10177,8 +10177,8 @@
|
|
|
10177
10177
|
"description": "",
|
|
10178
10178
|
"slug": "debugger",
|
|
10179
10179
|
"websiteUrl": "https://electronjs.org/docs/api/debugger",
|
|
10180
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
10181
|
-
"version": "22.3.
|
|
10180
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/debugger.md",
|
|
10181
|
+
"version": "22.3.27",
|
|
10182
10182
|
"type": "Class",
|
|
10183
10183
|
"process": {
|
|
10184
10184
|
"main": true,
|
|
@@ -10342,8 +10342,8 @@
|
|
|
10342
10342
|
"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// In the main process.\nconst { desktopCapturer } = require('electron')\n\ndesktopCapturer.getSources({ types: ['window', 'screen'] }).then(async sources => {\n for (const source of sources) {\n if (source.name === 'Electron') {\n mainWindow.webContents.send('SET_SOURCE', source.id)\n return\n }\n }\n})\n```\n\n```\n// In the preload script.\nconst { ipcRenderer } = require('electron')\n\nipcRenderer.on('SET_SOURCE', async (event, sourceId) => {\n try {\n const stream = await navigator.mediaDevices.getUserMedia({\n audio: false,\n video: {\n mandatory: {\n chromeMediaSource: 'desktop',\n chromeMediaSourceId: sourceId,\n minWidth: 1280,\n maxWidth: 1280,\n minHeight: 720,\n maxHeight: 720\n }\n }\n })\n handleStream(stream)\n } catch (e) {\n handleError(e)\n }\n})\n\nfunction handleStream (stream) {\n const video = document.querySelector('video')\n video.srcObject = stream\n video.onloadedmetadata = (e) => video.play()\n}\n\nfunction handleError (e) {\n console.log(e)\n}\n```\n\nTo capture video from a source provided by `desktopCapturer` the constraints passed to `navigator.mediaDevices.getUserMedia` must include `chromeMediaSource: 'desktop'`, and `audio: false`.\n\nTo capture both audio and video from the entire desktop the constraints passed to `navigator.mediaDevices.getUserMedia` must include `chromeMediaSource: 'desktop'`, for both `audio` and `video`, but should not include a `chromeMediaSourceId` constraint.",
|
|
10343
10343
|
"slug": "desktop-capturer",
|
|
10344
10344
|
"websiteUrl": "https://electronjs.org/docs/api/desktop-capturer",
|
|
10345
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
10346
|
-
"version": "22.3.
|
|
10345
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/desktop-capturer.md",
|
|
10346
|
+
"version": "22.3.27",
|
|
10347
10347
|
"type": "Module",
|
|
10348
10348
|
"process": {
|
|
10349
10349
|
"main": true,
|
|
@@ -10414,8 +10414,8 @@
|
|
|
10414
10414
|
"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:",
|
|
10415
10415
|
"slug": "dialog",
|
|
10416
10416
|
"websiteUrl": "https://electronjs.org/docs/api/dialog",
|
|
10417
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
10418
|
-
"version": "22.3.
|
|
10417
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/dialog.md",
|
|
10418
|
+
"version": "22.3.27",
|
|
10419
10419
|
"type": "Module",
|
|
10420
10420
|
"process": {
|
|
10421
10421
|
"main": true,
|
|
@@ -11463,8 +11463,8 @@
|
|
|
11463
11463
|
"description": "",
|
|
11464
11464
|
"slug": "dock",
|
|
11465
11465
|
"websiteUrl": "https://electronjs.org/docs/api/dock",
|
|
11466
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
11467
|
-
"version": "22.3.
|
|
11466
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/dock.md",
|
|
11467
|
+
"version": "22.3.27",
|
|
11468
11468
|
"type": "Class",
|
|
11469
11469
|
"process": {
|
|
11470
11470
|
"main": true,
|
|
@@ -11707,8 +11707,8 @@
|
|
|
11707
11707
|
"description": "",
|
|
11708
11708
|
"slug": "download-item",
|
|
11709
11709
|
"websiteUrl": "https://electronjs.org/docs/api/download-item",
|
|
11710
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
11711
|
-
"version": "22.3.
|
|
11710
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/download-item.md",
|
|
11711
|
+
"version": "22.3.27",
|
|
11712
11712
|
"type": "Class",
|
|
11713
11713
|
"process": {
|
|
11714
11714
|
"main": true,
|
|
@@ -12089,8 +12089,8 @@
|
|
|
12089
12089
|
"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.",
|
|
12090
12090
|
"slug": "global-shortcut",
|
|
12091
12091
|
"websiteUrl": "https://electronjs.org/docs/api/global-shortcut",
|
|
12092
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
12093
|
-
"version": "22.3.
|
|
12092
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/global-shortcut.md",
|
|
12093
|
+
"version": "22.3.27",
|
|
12094
12094
|
"type": "Module",
|
|
12095
12095
|
"process": {
|
|
12096
12096
|
"main": true,
|
|
@@ -12210,8 +12210,8 @@
|
|
|
12210
12210
|
"description": "> In-app purchases on Mac App Store.\n\nProcess: Main",
|
|
12211
12211
|
"slug": "in-app-purchase",
|
|
12212
12212
|
"websiteUrl": "https://electronjs.org/docs/api/in-app-purchase",
|
|
12213
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
12214
|
-
"version": "22.3.
|
|
12213
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/in-app-purchase.md",
|
|
12214
|
+
"version": "22.3.27",
|
|
12215
12215
|
"type": "Module",
|
|
12216
12216
|
"process": {
|
|
12217
12217
|
"main": true,
|
|
@@ -12359,8 +12359,8 @@
|
|
|
12359
12359
|
"description": "",
|
|
12360
12360
|
"slug": "incoming-message",
|
|
12361
12361
|
"websiteUrl": "https://electronjs.org/docs/api/incoming-message",
|
|
12362
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
12363
|
-
"version": "22.3.
|
|
12362
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/incoming-message.md",
|
|
12363
|
+
"version": "22.3.27",
|
|
12364
12364
|
"type": "Class",
|
|
12365
12365
|
"process": {
|
|
12366
12366
|
"main": true,
|
|
@@ -12506,8 +12506,8 @@
|
|
|
12506
12506
|
"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.",
|
|
12507
12507
|
"slug": "ipc-main",
|
|
12508
12508
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-main",
|
|
12509
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
12510
|
-
"version": "22.3.
|
|
12509
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/ipc-main.md",
|
|
12510
|
+
"version": "22.3.27",
|
|
12511
12511
|
"type": "Module",
|
|
12512
12512
|
"process": {
|
|
12513
12513
|
"main": true,
|
|
@@ -12800,8 +12800,8 @@
|
|
|
12800
12800
|
"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.",
|
|
12801
12801
|
"slug": "ipc-renderer",
|
|
12802
12802
|
"websiteUrl": "https://electronjs.org/docs/api/ipc-renderer",
|
|
12803
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
12804
|
-
"version": "22.3.
|
|
12803
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/ipc-renderer.md",
|
|
12804
|
+
"version": "22.3.27",
|
|
12805
12805
|
"type": "Module",
|
|
12806
12806
|
"process": {
|
|
12807
12807
|
"main": false,
|
|
@@ -13132,8 +13132,8 @@
|
|
|
13132
13132
|
"description": "> Add items to native application menus and context menus.\n\nProcess: Main\n\nSee `Menu` for examples.",
|
|
13133
13133
|
"slug": "menu-item",
|
|
13134
13134
|
"websiteUrl": "https://electronjs.org/docs/api/menu-item",
|
|
13135
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
13136
|
-
"version": "22.3.
|
|
13135
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/menu-item.md",
|
|
13136
|
+
"version": "22.3.27",
|
|
13137
13137
|
"type": "Class",
|
|
13138
13138
|
"process": {
|
|
13139
13139
|
"main": true,
|
|
@@ -14020,8 +14020,8 @@
|
|
|
14020
14020
|
"description": "\n\n### Class: Menu\n\n> Create native application menus and context menus.\n\nProcess: Main",
|
|
14021
14021
|
"slug": "menu",
|
|
14022
14022
|
"websiteUrl": "https://electronjs.org/docs/api/menu",
|
|
14023
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
14024
|
-
"version": "22.3.
|
|
14023
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/menu.md",
|
|
14024
|
+
"version": "22.3.27",
|
|
14025
14025
|
"type": "Class",
|
|
14026
14026
|
"process": {
|
|
14027
14027
|
"main": true,
|
|
@@ -14334,8 +14334,8 @@
|
|
|
14334
14334
|
"description": "",
|
|
14335
14335
|
"slug": "message-channel-main",
|
|
14336
14336
|
"websiteUrl": "https://electronjs.org/docs/api/message-channel-main",
|
|
14337
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
14338
|
-
"version": "22.3.
|
|
14337
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/message-channel-main.md",
|
|
14338
|
+
"version": "22.3.27",
|
|
14339
14339
|
"type": "Class",
|
|
14340
14340
|
"process": {
|
|
14341
14341
|
"main": true,
|
|
@@ -14374,8 +14374,8 @@
|
|
|
14374
14374
|
"description": "",
|
|
14375
14375
|
"slug": "message-port-main",
|
|
14376
14376
|
"websiteUrl": "https://electronjs.org/docs/api/message-port-main",
|
|
14377
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
14378
|
-
"version": "22.3.
|
|
14377
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/message-port-main.md",
|
|
14378
|
+
"version": "22.3.27",
|
|
14379
14379
|
"type": "Class",
|
|
14380
14380
|
"process": {
|
|
14381
14381
|
"main": true,
|
|
@@ -14479,8 +14479,8 @@
|
|
|
14479
14479
|
"description": "> Create tray, dock, and application icons using PNG or JPG files.\n\nProcess: Main, Renderer\n\nIn Electron, for the APIs that take images, you can pass either file paths or `NativeImage` instances. An empty image will be used when `null` is passed.\n\nFor example, when creating a tray or setting a window's icon, you can pass an image file path as a `string`:\n\n```\nconst { BrowserWindow, Tray } = require('electron')\n\nconst appIcon = new Tray('/Users/somebody/images/icon.png')\nconst win = new BrowserWindow({ icon: '/Users/somebody/images/window.png' })\nconsole.log(appIcon, win)\n```\n\nOr read the image from the clipboard, which returns a `NativeImage`:\n\n### Supported Formats\n\nCurrently `PNG` and `JPEG` image formats are supported. `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, it is recommended to include at least the following sizes in the:\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 *Size requirements* section in this article.\n\n### High Resolution Image\n\nOn platforms that have high-DPI support such as Apple Retina displays, you can append `@2x` after image's base filename to mark it as a 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 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. For example:\n\n```\nimages/\n├── icon.png\n├── icon@2x.png\n└── icon@3x.png\n```\n\n```\nconst { Tray } = require('electron')\nconst appIcon = new Tray('/Users/somebody/images/icon.png')\nconsole.log(appIcon)\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\n\nTemplate 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 icon, so it can adapt to both light and dark menu bars.\n\n**Note:** Template image is only supported on macOS.\n\nTo mark an image as a template image, its filename should end with the word `Template`. For example:\n\n* `xxxTemplate.png`\n* `xxxTemplate@2x.png`",
|
|
14480
14480
|
"slug": "native-image",
|
|
14481
14481
|
"websiteUrl": "https://electronjs.org/docs/api/native-image",
|
|
14482
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
14483
|
-
"version": "22.3.
|
|
14482
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/native-image.md",
|
|
14483
|
+
"version": "22.3.27",
|
|
14484
14484
|
"type": "Module",
|
|
14485
14485
|
"process": {
|
|
14486
14486
|
"main": true,
|
|
@@ -14725,8 +14725,8 @@
|
|
|
14725
14725
|
"description": "",
|
|
14726
14726
|
"slug": "native-image",
|
|
14727
14727
|
"websiteUrl": "https://electronjs.org/docs/api/native-image",
|
|
14728
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
14729
|
-
"version": "22.3.
|
|
14728
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/native-image.md",
|
|
14729
|
+
"version": "22.3.27",
|
|
14730
14730
|
"type": "Class",
|
|
14731
14731
|
"process": {
|
|
14732
14732
|
"main": true,
|
|
@@ -15134,8 +15134,8 @@
|
|
|
15134
15134
|
"description": "> Read and respond to changes in Chromium's native color theme.\n\nProcess: Main",
|
|
15135
15135
|
"slug": "native-theme",
|
|
15136
15136
|
"websiteUrl": "https://electronjs.org/docs/api/native-theme",
|
|
15137
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
15138
|
-
"version": "22.3.
|
|
15137
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/native-theme.md",
|
|
15138
|
+
"version": "22.3.27",
|
|
15139
15139
|
"type": "Module",
|
|
15140
15140
|
"process": {
|
|
15141
15141
|
"main": true,
|
|
@@ -15233,8 +15233,8 @@
|
|
|
15233
15233
|
"description": "> Logging network events for a session.\n\nProcess: Main\n\n```\nconst { 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.",
|
|
15234
15234
|
"slug": "net-log",
|
|
15235
15235
|
"websiteUrl": "https://electronjs.org/docs/api/net-log",
|
|
15236
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
15237
|
-
"version": "22.3.
|
|
15236
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/net-log.md",
|
|
15237
|
+
"version": "22.3.27",
|
|
15238
15238
|
"type": "Module",
|
|
15239
15239
|
"process": {
|
|
15240
15240
|
"main": true,
|
|
@@ -15348,8 +15348,8 @@
|
|
|
15348
15348
|
"description": "> Issue HTTP/HTTPS requests using Chromium's native networking library\n\nProcess: Main\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.",
|
|
15349
15349
|
"slug": "net",
|
|
15350
15350
|
"websiteUrl": "https://electronjs.org/docs/api/net",
|
|
15351
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
15352
|
-
"version": "22.3.
|
|
15351
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/net.md",
|
|
15352
|
+
"version": "22.3.27",
|
|
15353
15353
|
"type": "Module",
|
|
15354
15354
|
"process": {
|
|
15355
15355
|
"main": true,
|
|
@@ -15421,8 +15421,8 @@
|
|
|
15421
15421
|
"description": "> Create OS desktop notifications\n\nProcess: Main\n\n### Using in the renderer process\n\nIf you want to show Notifications from a renderer process you should use the HTML5 Notification 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### 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",
|
|
15422
15422
|
"slug": "notification",
|
|
15423
15423
|
"websiteUrl": "https://electronjs.org/docs/api/notification",
|
|
15424
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
15425
|
-
"version": "22.3.
|
|
15424
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/notification.md",
|
|
15425
|
+
"version": "22.3.27",
|
|
15426
15426
|
"type": "Class",
|
|
15427
15427
|
"process": {
|
|
15428
15428
|
"main": true,
|
|
@@ -15918,8 +15918,8 @@
|
|
|
15918
15918
|
"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._",
|
|
15919
15919
|
"slug": "parent-port",
|
|
15920
15920
|
"websiteUrl": "https://electronjs.org/docs/api/parent-port",
|
|
15921
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
15922
|
-
"version": "22.3.
|
|
15921
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/parent-port.md",
|
|
15922
|
+
"version": "22.3.27",
|
|
15923
15923
|
"type": "Module",
|
|
15924
15924
|
"process": {
|
|
15925
15925
|
"main": false,
|
|
@@ -15988,8 +15988,8 @@
|
|
|
15988
15988
|
"description": "> Monitor power state changes.\n\nProcess: Main",
|
|
15989
15989
|
"slug": "power-monitor",
|
|
15990
15990
|
"websiteUrl": "https://electronjs.org/docs/api/power-monitor",
|
|
15991
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
15992
|
-
"version": "22.3.
|
|
15991
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/power-monitor.md",
|
|
15992
|
+
"version": "22.3.27",
|
|
15993
15993
|
"type": "Module",
|
|
15994
15994
|
"process": {
|
|
15995
15995
|
"main": true,
|
|
@@ -16161,8 +16161,8 @@
|
|
|
16161
16161
|
"description": "> Block the system from entering low-power (sleep) mode.\n\nProcess: Main\n\nFor example:",
|
|
16162
16162
|
"slug": "power-save-blocker",
|
|
16163
16163
|
"websiteUrl": "https://electronjs.org/docs/api/power-save-blocker",
|
|
16164
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
16165
|
-
"version": "22.3.
|
|
16164
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/power-save-blocker.md",
|
|
16165
|
+
"version": "22.3.27",
|
|
16166
16166
|
"type": "Module",
|
|
16167
16167
|
"process": {
|
|
16168
16168
|
"main": true,
|
|
@@ -16247,8 +16247,8 @@
|
|
|
16247
16247
|
"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* `getIOCounters()`\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`",
|
|
16248
16248
|
"slug": "process",
|
|
16249
16249
|
"websiteUrl": "https://electronjs.org/docs/api/process",
|
|
16250
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
16251
|
-
"version": "22.3.
|
|
16250
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/process.md",
|
|
16251
|
+
"version": "22.3.27",
|
|
16252
16252
|
"type": "Module",
|
|
16253
16253
|
"process": {
|
|
16254
16254
|
"main": true,
|
|
@@ -16778,8 +16778,8 @@
|
|
|
16778
16778
|
"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 } = require('electron')\nconst path = require('path')\nconst url = require('url')\n\napp.whenReady().then(() => {\n protocol.registerFileProtocol('atom', (request, callback) => {\n const filePath = url.fileURLToPath('file://' + request.url.slice('atom://'.length))\n callback(filePath)\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 { session, app, protocol } = require('electron')\nconst path = require('path')\n\napp.whenReady().then(() => {\n const partition = 'persist:example'\n const ses = session.fromPartition(partition)\n\n ses.protocol.registerFileProtocol('atom', (request, callback) => {\n const url = request.url.substr(7)\n callback({ path: path.normalize(`${__dirname}/${url}`) })\n })\n\n mainWindow = new BrowserWindow({ webPreferences: { partition } })\n})\n```",
|
|
16779
16779
|
"slug": "protocol",
|
|
16780
16780
|
"websiteUrl": "https://electronjs.org/docs/api/protocol",
|
|
16781
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
16782
|
-
"version": "22.3.
|
|
16781
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/protocol.md",
|
|
16782
|
+
"version": "22.3.27",
|
|
16783
16783
|
"type": "Module",
|
|
16784
16784
|
"process": {
|
|
16785
16785
|
"main": true,
|
|
@@ -17524,8 +17524,8 @@
|
|
|
17524
17524
|
"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):",
|
|
17525
17525
|
"slug": "push-notifications",
|
|
17526
17526
|
"websiteUrl": "https://electronjs.org/docs/api/push-notifications",
|
|
17527
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
17528
|
-
"version": "22.3.
|
|
17527
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/push-notifications.md",
|
|
17528
|
+
"version": "22.3.27",
|
|
17529
17529
|
"type": "Module",
|
|
17530
17530
|
"process": {
|
|
17531
17531
|
"main": true,
|
|
@@ -17604,8 +17604,8 @@
|
|
|
17604
17604
|
"description": "> Allows access to simple encryption and decryption of strings for storage on the local machine.\n\nProcess: Main\n\nThis module protects data stored on disk from being accessed by other applications or users with full disk access.\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.",
|
|
17605
17605
|
"slug": "safe-storage",
|
|
17606
17606
|
"websiteUrl": "https://electronjs.org/docs/api/safe-storage",
|
|
17607
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
17608
|
-
"version": "22.3.
|
|
17607
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/safe-storage.md",
|
|
17608
|
+
"version": "22.3.27",
|
|
17609
17609
|
"type": "Module",
|
|
17610
17610
|
"process": {
|
|
17611
17611
|
"main": true,
|
|
@@ -17677,8 +17677,8 @@
|
|
|
17677
17677
|
"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```\nconst { app, BrowserWindow, screen } = require('electron')\n\nlet win\napp.whenReady().then(() => {\n const { width, height } = screen.getPrimaryDisplay().workAreaSize\n win = new BrowserWindow({ width, height })\n win.loadURL('https://github.com')\n})\n```\n\nAnother example of creating a window in the external display:",
|
|
17678
17678
|
"slug": "screen",
|
|
17679
17679
|
"websiteUrl": "https://electronjs.org/docs/api/screen",
|
|
17680
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
17681
|
-
"version": "22.3.
|
|
17680
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/screen.md",
|
|
17681
|
+
"version": "22.3.27",
|
|
17682
17682
|
"type": "Module",
|
|
17683
17683
|
"process": {
|
|
17684
17684
|
"main": true,
|
|
@@ -17967,8 +17967,8 @@
|
|
|
17967
17967
|
"description": "",
|
|
17968
17968
|
"slug": "service-workers",
|
|
17969
17969
|
"websiteUrl": "https://electronjs.org/docs/api/service-workers",
|
|
17970
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
17971
|
-
"version": "22.3.
|
|
17970
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/service-workers.md",
|
|
17971
|
+
"version": "22.3.27",
|
|
17972
17972
|
"type": "Class",
|
|
17973
17973
|
"process": {
|
|
17974
17974
|
"main": true,
|
|
@@ -18193,8 +18193,8 @@
|
|
|
18193
18193
|
"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.",
|
|
18194
18194
|
"slug": "session",
|
|
18195
18195
|
"websiteUrl": "https://electronjs.org/docs/api/session",
|
|
18196
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
18197
|
-
"version": "22.3.
|
|
18196
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/session.md",
|
|
18197
|
+
"version": "22.3.27",
|
|
18198
18198
|
"type": "Module",
|
|
18199
18199
|
"process": {
|
|
18200
18200
|
"main": true,
|
|
@@ -18260,8 +18260,8 @@
|
|
|
18260
18260
|
"description": "",
|
|
18261
18261
|
"slug": "session",
|
|
18262
18262
|
"websiteUrl": "https://electronjs.org/docs/api/session",
|
|
18263
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
18264
|
-
"version": "22.3.
|
|
18263
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/session.md",
|
|
18264
|
+
"version": "22.3.27",
|
|
18265
18265
|
"type": "Class",
|
|
18266
18266
|
"process": {
|
|
18267
18267
|
"main": true,
|
|
@@ -20723,8 +20723,8 @@
|
|
|
20723
20723
|
"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",
|
|
20724
20724
|
"slug": "share-menu",
|
|
20725
20725
|
"websiteUrl": "https://electronjs.org/docs/api/share-menu",
|
|
20726
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
20727
|
-
"version": "22.3.
|
|
20726
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/share-menu.md",
|
|
20727
|
+
"version": "22.3.27",
|
|
20728
20728
|
"type": "Class",
|
|
20729
20729
|
"process": {
|
|
20730
20730
|
"main": true,
|
|
@@ -20790,8 +20790,8 @@
|
|
|
20790
20790
|
"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**Note:** While the `shell` module can be used in the renderer process, it will not function in a sandboxed renderer.",
|
|
20791
20791
|
"slug": "shell",
|
|
20792
20792
|
"websiteUrl": "https://electronjs.org/docs/api/shell",
|
|
20793
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
20794
|
-
"version": "22.3.
|
|
20793
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/shell.md",
|
|
20794
|
+
"version": "22.3.27",
|
|
20795
20795
|
"type": "Module",
|
|
20796
20796
|
"process": {
|
|
20797
20797
|
"main": true,
|
|
@@ -21022,8 +21022,8 @@
|
|
|
21022
21022
|
"description": "> Get system preferences.\n\nProcess: Main",
|
|
21023
21023
|
"slug": "system-preferences",
|
|
21024
21024
|
"websiteUrl": "https://electronjs.org/docs/api/system-preferences",
|
|
21025
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
21026
|
-
"version": "22.3.
|
|
21025
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/system-preferences.md",
|
|
21026
|
+
"version": "22.3.27",
|
|
21027
21027
|
"type": "Module",
|
|
21028
21028
|
"process": {
|
|
21029
21029
|
"main": true,
|
|
@@ -22448,8 +22448,8 @@
|
|
|
22448
22448
|
"description": "> Create a button in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22449
22449
|
"slug": "touch-bar-button",
|
|
22450
22450
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-button",
|
|
22451
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22452
|
-
"version": "22.3.
|
|
22451
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/touch-bar-button.md",
|
|
22452
|
+
"version": "22.3.27",
|
|
22453
22453
|
"type": "Class",
|
|
22454
22454
|
"process": {
|
|
22455
22455
|
"main": true,
|
|
@@ -22639,8 +22639,8 @@
|
|
|
22639
22639
|
"description": "> Create a color picker in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22640
22640
|
"slug": "touch-bar-color-picker",
|
|
22641
22641
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-color-picker",
|
|
22642
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22643
|
-
"version": "22.3.
|
|
22642
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/touch-bar-color-picker.md",
|
|
22643
|
+
"version": "22.3.27",
|
|
22644
22644
|
"type": "Class",
|
|
22645
22645
|
"process": {
|
|
22646
22646
|
"main": true,
|
|
@@ -22731,8 +22731,8 @@
|
|
|
22731
22731
|
"description": "> Create a group in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22732
22732
|
"slug": "touch-bar-group",
|
|
22733
22733
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-group",
|
|
22734
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22735
|
-
"version": "22.3.
|
|
22734
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/touch-bar-group.md",
|
|
22735
|
+
"version": "22.3.27",
|
|
22736
22736
|
"type": "Class",
|
|
22737
22737
|
"process": {
|
|
22738
22738
|
"main": true,
|
|
@@ -22773,8 +22773,8 @@
|
|
|
22773
22773
|
"description": "> Create a label in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22774
22774
|
"slug": "touch-bar-label",
|
|
22775
22775
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-label",
|
|
22776
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22777
|
-
"version": "22.3.
|
|
22776
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/touch-bar-label.md",
|
|
22777
|
+
"version": "22.3.27",
|
|
22778
22778
|
"type": "Class",
|
|
22779
22779
|
"process": {
|
|
22780
22780
|
"main": true,
|
|
@@ -22865,8 +22865,8 @@
|
|
|
22865
22865
|
"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\nNote: Only one instance of this class can be added per TouchBar.\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22866
22866
|
"slug": "touch-bar-other-items-proxy",
|
|
22867
22867
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-other-items-proxy",
|
|
22868
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22869
|
-
"version": "22.3.
|
|
22868
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/touch-bar-other-items-proxy.md",
|
|
22869
|
+
"version": "22.3.27",
|
|
22870
22870
|
"type": "Class",
|
|
22871
22871
|
"process": {
|
|
22872
22872
|
"main": true,
|
|
@@ -22889,8 +22889,8 @@
|
|
|
22889
22889
|
"description": "> Create a popover in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22890
22890
|
"slug": "touch-bar-popover",
|
|
22891
22891
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-popover",
|
|
22892
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22893
|
-
"version": "22.3.
|
|
22892
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/touch-bar-popover.md",
|
|
22893
|
+
"version": "22.3.27",
|
|
22894
22894
|
"type": "Class",
|
|
22895
22895
|
"process": {
|
|
22896
22896
|
"main": true,
|
|
@@ -22976,8 +22976,8 @@
|
|
|
22976
22976
|
"description": "> Create a scrubber (a scrollable selector)\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
22977
22977
|
"slug": "touch-bar-scrubber",
|
|
22978
22978
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-scrubber",
|
|
22979
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
22980
|
-
"version": "22.3.
|
|
22979
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/touch-bar-scrubber.md",
|
|
22980
|
+
"version": "22.3.27",
|
|
22981
22981
|
"type": "Class",
|
|
22982
22982
|
"process": {
|
|
22983
22983
|
"main": true,
|
|
@@ -23225,8 +23225,8 @@
|
|
|
23225
23225
|
"description": "> Create a segmented control (a button group) where one button has a selected state\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23226
23226
|
"slug": "touch-bar-segmented-control",
|
|
23227
23227
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-segmented-control",
|
|
23228
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
23229
|
-
"version": "22.3.
|
|
23228
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/touch-bar-segmented-control.md",
|
|
23229
|
+
"version": "22.3.27",
|
|
23230
23230
|
"type": "Class",
|
|
23231
23231
|
"process": {
|
|
23232
23232
|
"main": true,
|
|
@@ -23416,8 +23416,8 @@
|
|
|
23416
23416
|
"description": "> Create a slider in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23417
23417
|
"slug": "touch-bar-slider",
|
|
23418
23418
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-slider",
|
|
23419
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
23420
|
-
"version": "22.3.
|
|
23419
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/touch-bar-slider.md",
|
|
23420
|
+
"version": "22.3.27",
|
|
23421
23421
|
"type": "Class",
|
|
23422
23422
|
"process": {
|
|
23423
23423
|
"main": true,
|
|
@@ -23539,8 +23539,8 @@
|
|
|
23539
23539
|
"description": "> Create a spacer between two items in the touch bar for native macOS applications\n\nProcess: Main<br /> _This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._",
|
|
23540
23540
|
"slug": "touch-bar-spacer",
|
|
23541
23541
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar-spacer",
|
|
23542
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
23543
|
-
"version": "22.3.
|
|
23542
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/touch-bar-spacer.md",
|
|
23543
|
+
"version": "22.3.27",
|
|
23544
23544
|
"type": "Class",
|
|
23545
23545
|
"process": {
|
|
23546
23546
|
"main": true,
|
|
@@ -23619,8 +23619,8 @@
|
|
|
23619
23619
|
"description": "\n\n### Class: TouchBar\n\n> Create TouchBar layouts for native macOS applications\n\nProcess: Main",
|
|
23620
23620
|
"slug": "touch-bar",
|
|
23621
23621
|
"websiteUrl": "https://electronjs.org/docs/api/touch-bar",
|
|
23622
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
23623
|
-
"version": "22.3.
|
|
23622
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/touch-bar.md",
|
|
23623
|
+
"version": "22.3.27",
|
|
23624
23624
|
"type": "Class",
|
|
23625
23625
|
"process": {
|
|
23626
23626
|
"main": true,
|
|
@@ -23848,8 +23848,8 @@
|
|
|
23848
23848
|
"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__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.",
|
|
23849
23849
|
"slug": "tray",
|
|
23850
23850
|
"websiteUrl": "https://electronjs.org/docs/api/tray",
|
|
23851
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
23852
|
-
"version": "22.3.
|
|
23851
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/tray.md",
|
|
23852
|
+
"version": "22.3.27",
|
|
23853
23853
|
"type": "Class",
|
|
23854
23854
|
"process": {
|
|
23855
23855
|
"main": true,
|
|
@@ -24616,8 +24616,8 @@
|
|
|
24616
24616
|
"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<br />",
|
|
24617
24617
|
"slug": "utility-process",
|
|
24618
24618
|
"websiteUrl": "https://electronjs.org/docs/api/utility-process",
|
|
24619
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
24620
|
-
"version": "22.3.
|
|
24619
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/utility-process.md",
|
|
24620
|
+
"version": "22.3.27",
|
|
24621
24621
|
"type": "Module",
|
|
24622
24622
|
"process": {
|
|
24623
24623
|
"main": true,
|
|
@@ -24751,8 +24751,8 @@
|
|
|
24751
24751
|
"description": "",
|
|
24752
24752
|
"slug": "utility-process",
|
|
24753
24753
|
"websiteUrl": "https://electronjs.org/docs/api/utility-process",
|
|
24754
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
24755
|
-
"version": "22.3.
|
|
24754
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/utility-process.md",
|
|
24755
|
+
"version": "22.3.27",
|
|
24756
24756
|
"type": "Class",
|
|
24757
24757
|
"process": {
|
|
24758
24758
|
"main": true,
|
|
@@ -24902,8 +24902,8 @@
|
|
|
24902
24902
|
"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:",
|
|
24903
24903
|
"slug": "web-contents",
|
|
24904
24904
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents",
|
|
24905
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
24906
|
-
"version": "22.3.
|
|
24905
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/web-contents.md",
|
|
24906
|
+
"version": "22.3.27",
|
|
24907
24907
|
"type": "Module",
|
|
24908
24908
|
"process": {
|
|
24909
24909
|
"main": true,
|
|
@@ -25006,8 +25006,8 @@
|
|
|
25006
25006
|
"description": "",
|
|
25007
25007
|
"slug": "web-contents",
|
|
25008
25008
|
"websiteUrl": "https://electronjs.org/docs/api/web-contents",
|
|
25009
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
25010
|
-
"version": "22.3.
|
|
25009
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/web-contents.md",
|
|
25010
|
+
"version": "22.3.27",
|
|
25011
25011
|
"type": "Class",
|
|
25012
25012
|
"process": {
|
|
25013
25013
|
"main": true,
|
|
@@ -30090,8 +30090,8 @@
|
|
|
30090
30090
|
"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`.",
|
|
30091
30091
|
"slug": "web-frame-main",
|
|
30092
30092
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
|
|
30093
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
30094
|
-
"version": "22.3.
|
|
30093
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/web-frame-main.md",
|
|
30094
|
+
"version": "22.3.27",
|
|
30095
30095
|
"type": "Module",
|
|
30096
30096
|
"process": {
|
|
30097
30097
|
"main": true,
|
|
@@ -30145,8 +30145,8 @@
|
|
|
30145
30145
|
"description": "",
|
|
30146
30146
|
"slug": "web-frame-main",
|
|
30147
30147
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame-main",
|
|
30148
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
30149
|
-
"version": "22.3.
|
|
30148
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/web-frame-main.md",
|
|
30149
|
+
"version": "22.3.27",
|
|
30150
30150
|
"type": "Class",
|
|
30151
30151
|
"process": {
|
|
30152
30152
|
"main": true,
|
|
@@ -30444,8 +30444,8 @@
|
|
|
30444
30444
|
"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%.",
|
|
30445
30445
|
"slug": "web-frame",
|
|
30446
30446
|
"websiteUrl": "https://electronjs.org/docs/api/web-frame",
|
|
30447
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
30448
|
-
"version": "22.3.
|
|
30447
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/web-frame.md",
|
|
30448
|
+
"version": "22.3.27",
|
|
30449
30449
|
"type": "Module",
|
|
30450
30450
|
"process": {
|
|
30451
30451
|
"main": false,
|
|
@@ -31148,8 +31148,8 @@
|
|
|
31148
31148
|
"description": "",
|
|
31149
31149
|
"slug": "web-request",
|
|
31150
31150
|
"websiteUrl": "https://electronjs.org/docs/api/web-request",
|
|
31151
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
31152
|
-
"version": "22.3.
|
|
31151
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/web-request.md",
|
|
31152
|
+
"version": "22.3.27",
|
|
31153
31153
|
"type": "Class",
|
|
31154
31154
|
"process": {
|
|
31155
31155
|
"main": true,
|
|
@@ -32994,8 +32994,8 @@
|
|
|
32994
32994
|
"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`, Electron's `BrowserView`, 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<br /> _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. **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=\"http://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=\"http://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=\"http://cheng.guru\"></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\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.",
|
|
32995
32995
|
"slug": "webview-tag",
|
|
32996
32996
|
"websiteUrl": "https://electronjs.org/docs/api/webview-tag",
|
|
32997
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
32998
|
-
"version": "22.3.
|
|
32997
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/webview-tag.md",
|
|
32998
|
+
"version": "22.3.27",
|
|
32999
32999
|
"type": "Element",
|
|
33000
33000
|
"process": {
|
|
33001
33001
|
"main": false,
|
|
@@ -35690,8 +35690,8 @@
|
|
|
35690
35690
|
"description": "",
|
|
35691
35691
|
"slug": "bluetooth-device",
|
|
35692
35692
|
"websiteUrl": "https://electronjs.org/docs/api/structures/bluetooth-device",
|
|
35693
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
35694
|
-
"version": "22.3.
|
|
35693
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/bluetooth-device.md",
|
|
35694
|
+
"version": "22.3.27",
|
|
35695
35695
|
"properties": [
|
|
35696
35696
|
{
|
|
35697
35697
|
"name": "deviceName",
|
|
@@ -35719,8 +35719,8 @@
|
|
|
35719
35719
|
"description": "",
|
|
35720
35720
|
"slug": "certificate-principal",
|
|
35721
35721
|
"websiteUrl": "https://electronjs.org/docs/api/structures/certificate-principal",
|
|
35722
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
35723
|
-
"version": "22.3.
|
|
35722
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/certificate-principal.md",
|
|
35723
|
+
"version": "22.3.27",
|
|
35724
35724
|
"properties": [
|
|
35725
35725
|
{
|
|
35726
35726
|
"name": "commonName",
|
|
@@ -35784,8 +35784,8 @@
|
|
|
35784
35784
|
"description": "",
|
|
35785
35785
|
"slug": "certificate",
|
|
35786
35786
|
"websiteUrl": "https://electronjs.org/docs/api/structures/certificate",
|
|
35787
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
35788
|
-
"version": "22.3.
|
|
35787
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/certificate.md",
|
|
35788
|
+
"version": "22.3.27",
|
|
35789
35789
|
"properties": [
|
|
35790
35790
|
{
|
|
35791
35791
|
"name": "data",
|
|
@@ -35880,8 +35880,8 @@
|
|
|
35880
35880
|
"description": "",
|
|
35881
35881
|
"slug": "cookie",
|
|
35882
35882
|
"websiteUrl": "https://electronjs.org/docs/api/structures/cookie",
|
|
35883
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
35884
|
-
"version": "22.3.
|
|
35883
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/cookie.md",
|
|
35884
|
+
"version": "22.3.27",
|
|
35885
35885
|
"properties": [
|
|
35886
35886
|
{
|
|
35887
35887
|
"name": "name",
|
|
@@ -35993,8 +35993,8 @@
|
|
|
35993
35993
|
"description": "",
|
|
35994
35994
|
"slug": "cpu-usage",
|
|
35995
35995
|
"websiteUrl": "https://electronjs.org/docs/api/structures/cpu-usage",
|
|
35996
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
35997
|
-
"version": "22.3.
|
|
35996
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/cpu-usage.md",
|
|
35997
|
+
"version": "22.3.27",
|
|
35998
35998
|
"properties": [
|
|
35999
35999
|
{
|
|
36000
36000
|
"name": "percentCPUUsage",
|
|
@@ -36020,8 +36020,8 @@
|
|
|
36020
36020
|
"description": "",
|
|
36021
36021
|
"slug": "crash-report",
|
|
36022
36022
|
"websiteUrl": "https://electronjs.org/docs/api/structures/crash-report",
|
|
36023
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36024
|
-
"version": "22.3.
|
|
36023
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/crash-report.md",
|
|
36024
|
+
"version": "22.3.27",
|
|
36025
36025
|
"properties": [
|
|
36026
36026
|
{
|
|
36027
36027
|
"name": "date",
|
|
@@ -36048,8 +36048,8 @@
|
|
|
36048
36048
|
"description": "",
|
|
36049
36049
|
"slug": "custom-scheme",
|
|
36050
36050
|
"websiteUrl": "https://electronjs.org/docs/api/structures/custom-scheme",
|
|
36051
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36052
|
-
"version": "22.3.
|
|
36051
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/custom-scheme.md",
|
|
36052
|
+
"version": "22.3.27",
|
|
36053
36053
|
"properties": [
|
|
36054
36054
|
{
|
|
36055
36055
|
"name": "scheme",
|
|
@@ -36134,8 +36134,8 @@
|
|
|
36134
36134
|
"description": "",
|
|
36135
36135
|
"slug": "desktop-capturer-source",
|
|
36136
36136
|
"websiteUrl": "https://electronjs.org/docs/api/structures/desktop-capturer-source",
|
|
36137
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36138
|
-
"version": "22.3.
|
|
36137
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/desktop-capturer-source.md",
|
|
36138
|
+
"version": "22.3.27",
|
|
36139
36139
|
"properties": [
|
|
36140
36140
|
{
|
|
36141
36141
|
"name": "id",
|
|
@@ -36188,8 +36188,8 @@
|
|
|
36188
36188
|
"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.",
|
|
36189
36189
|
"slug": "display",
|
|
36190
36190
|
"websiteUrl": "https://electronjs.org/docs/api/structures/display",
|
|
36191
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36192
|
-
"version": "22.3.
|
|
36191
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/display.md",
|
|
36192
|
+
"version": "22.3.27",
|
|
36193
36193
|
"properties": [
|
|
36194
36194
|
{
|
|
36195
36195
|
"name": "id",
|
|
@@ -36358,8 +36358,8 @@
|
|
|
36358
36358
|
"description": "",
|
|
36359
36359
|
"slug": "event",
|
|
36360
36360
|
"websiteUrl": "https://electronjs.org/docs/api/structures/event",
|
|
36361
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36362
|
-
"version": "22.3.
|
|
36361
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/event.md",
|
|
36362
|
+
"version": "22.3.27",
|
|
36363
36363
|
"properties": [
|
|
36364
36364
|
{
|
|
36365
36365
|
"name": "preventDefault",
|
|
@@ -36377,8 +36377,8 @@
|
|
|
36377
36377
|
"description": "",
|
|
36378
36378
|
"slug": "extension-info",
|
|
36379
36379
|
"websiteUrl": "https://electronjs.org/docs/api/structures/extension-info",
|
|
36380
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36381
|
-
"version": "22.3.
|
|
36380
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/extension-info.md",
|
|
36381
|
+
"version": "22.3.27",
|
|
36382
36382
|
"properties": [
|
|
36383
36383
|
{
|
|
36384
36384
|
"name": "name",
|
|
@@ -36406,8 +36406,8 @@
|
|
|
36406
36406
|
"description": "",
|
|
36407
36407
|
"slug": "extension",
|
|
36408
36408
|
"websiteUrl": "https://electronjs.org/docs/api/structures/extension",
|
|
36409
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36410
|
-
"version": "22.3.
|
|
36409
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/extension.md",
|
|
36410
|
+
"version": "22.3.27",
|
|
36411
36411
|
"properties": [
|
|
36412
36412
|
{
|
|
36413
36413
|
"name": "id",
|
|
@@ -36470,8 +36470,8 @@
|
|
|
36470
36470
|
"description": "",
|
|
36471
36471
|
"slug": "file-filter",
|
|
36472
36472
|
"websiteUrl": "https://electronjs.org/docs/api/structures/file-filter",
|
|
36473
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36474
|
-
"version": "22.3.
|
|
36473
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/file-filter.md",
|
|
36474
|
+
"version": "22.3.27",
|
|
36475
36475
|
"properties": [
|
|
36476
36476
|
{
|
|
36477
36477
|
"name": "name",
|
|
@@ -36499,8 +36499,8 @@
|
|
|
36499
36499
|
"description": "",
|
|
36500
36500
|
"slug": "file-path-with-headers",
|
|
36501
36501
|
"websiteUrl": "https://electronjs.org/docs/api/structures/file-path-with-headers",
|
|
36502
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36503
|
-
"version": "22.3.
|
|
36502
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/file-path-with-headers.md",
|
|
36503
|
+
"version": "22.3.27",
|
|
36504
36504
|
"properties": [
|
|
36505
36505
|
{
|
|
36506
36506
|
"name": "path",
|
|
@@ -36539,8 +36539,8 @@
|
|
|
36539
36539
|
"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)",
|
|
36540
36540
|
"slug": "gpu-feature-status",
|
|
36541
36541
|
"websiteUrl": "https://electronjs.org/docs/api/structures/gpu-feature-status",
|
|
36542
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36543
|
-
"version": "22.3.
|
|
36542
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/gpu-feature-status.md",
|
|
36543
|
+
"version": "22.3.27",
|
|
36544
36544
|
"properties": [
|
|
36545
36545
|
{
|
|
36546
36546
|
"name": "2d_canvas",
|
|
@@ -36667,8 +36667,8 @@
|
|
|
36667
36667
|
"description": "",
|
|
36668
36668
|
"slug": "hid-device",
|
|
36669
36669
|
"websiteUrl": "https://electronjs.org/docs/api/structures/hid-device",
|
|
36670
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36671
|
-
"version": "22.3.
|
|
36670
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/hid-device.md",
|
|
36671
|
+
"version": "22.3.27",
|
|
36672
36672
|
"properties": [
|
|
36673
36673
|
{
|
|
36674
36674
|
"name": "deviceId",
|
|
@@ -36730,8 +36730,8 @@
|
|
|
36730
36730
|
"description": "",
|
|
36731
36731
|
"slug": "input-event",
|
|
36732
36732
|
"websiteUrl": "https://electronjs.org/docs/api/structures/input-event",
|
|
36733
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36734
|
-
"version": "22.3.
|
|
36733
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/input-event.md",
|
|
36734
|
+
"version": "22.3.27",
|
|
36735
36735
|
"properties": [
|
|
36736
36736
|
{
|
|
36737
36737
|
"name": "type",
|
|
@@ -36989,8 +36989,8 @@
|
|
|
36989
36989
|
"description": "",
|
|
36990
36990
|
"slug": "io-counters",
|
|
36991
36991
|
"websiteUrl": "https://electronjs.org/docs/api/structures/io-counters",
|
|
36992
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
36993
|
-
"version": "22.3.
|
|
36992
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/io-counters.md",
|
|
36993
|
+
"version": "22.3.27",
|
|
36994
36994
|
"properties": [
|
|
36995
36995
|
{
|
|
36996
36996
|
"name": "readOperationCount",
|
|
@@ -37049,8 +37049,8 @@
|
|
|
37049
37049
|
"description": "",
|
|
37050
37050
|
"slug": "ipc-main-event",
|
|
37051
37051
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-event",
|
|
37052
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37053
|
-
"version": "22.3.
|
|
37052
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/ipc-main-event.md",
|
|
37053
|
+
"version": "22.3.27",
|
|
37054
37054
|
"properties": [
|
|
37055
37055
|
{
|
|
37056
37056
|
"name": "processId",
|
|
@@ -37137,8 +37137,8 @@
|
|
|
37137
37137
|
"description": "",
|
|
37138
37138
|
"slug": "ipc-main-invoke-event",
|
|
37139
37139
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-main-invoke-event",
|
|
37140
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37141
|
-
"version": "22.3.
|
|
37140
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/ipc-main-invoke-event.md",
|
|
37141
|
+
"version": "22.3.27",
|
|
37142
37142
|
"properties": [
|
|
37143
37143
|
{
|
|
37144
37144
|
"name": "processId",
|
|
@@ -37183,8 +37183,8 @@
|
|
|
37183
37183
|
"description": "",
|
|
37184
37184
|
"slug": "ipc-renderer-event",
|
|
37185
37185
|
"websiteUrl": "https://electronjs.org/docs/api/structures/ipc-renderer-event",
|
|
37186
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37187
|
-
"version": "22.3.
|
|
37186
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/ipc-renderer-event.md",
|
|
37187
|
+
"version": "22.3.27",
|
|
37188
37188
|
"properties": [
|
|
37189
37189
|
{
|
|
37190
37190
|
"name": "sender",
|
|
@@ -37218,8 +37218,8 @@
|
|
|
37218
37218
|
"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.",
|
|
37219
37219
|
"slug": "jump-list-category",
|
|
37220
37220
|
"websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-category",
|
|
37221
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37222
|
-
"version": "22.3.
|
|
37221
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/jump-list-category.md",
|
|
37222
|
+
"version": "22.3.27",
|
|
37223
37223
|
"properties": [
|
|
37224
37224
|
{
|
|
37225
37225
|
"name": "type",
|
|
@@ -37272,8 +37272,8 @@
|
|
|
37272
37272
|
"description": "",
|
|
37273
37273
|
"slug": "jump-list-item",
|
|
37274
37274
|
"websiteUrl": "https://electronjs.org/docs/api/structures/jump-list-item",
|
|
37275
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37276
|
-
"version": "22.3.
|
|
37275
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/jump-list-item.md",
|
|
37276
|
+
"version": "22.3.27",
|
|
37277
37277
|
"properties": [
|
|
37278
37278
|
{
|
|
37279
37279
|
"name": "type",
|
|
@@ -37376,8 +37376,8 @@
|
|
|
37376
37376
|
"description": "",
|
|
37377
37377
|
"slug": "keyboard-event",
|
|
37378
37378
|
"websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-event",
|
|
37379
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37380
|
-
"version": "22.3.
|
|
37379
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/keyboard-event.md",
|
|
37380
|
+
"version": "22.3.27",
|
|
37381
37381
|
"properties": [
|
|
37382
37382
|
{
|
|
37383
37383
|
"name": "ctrlKey",
|
|
@@ -37428,8 +37428,8 @@
|
|
|
37428
37428
|
"description": "",
|
|
37429
37429
|
"slug": "keyboard-input-event",
|
|
37430
37430
|
"websiteUrl": "https://electronjs.org/docs/api/structures/keyboard-input-event",
|
|
37431
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37432
|
-
"version": "22.3.
|
|
37431
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/keyboard-input-event.md",
|
|
37432
|
+
"version": "22.3.27",
|
|
37433
37433
|
"properties": [
|
|
37434
37434
|
{
|
|
37435
37435
|
"name": "type",
|
|
@@ -37474,8 +37474,8 @@
|
|
|
37474
37474
|
"description": "Note that all statistics are reported in Kilobytes.",
|
|
37475
37475
|
"slug": "memory-info",
|
|
37476
37476
|
"websiteUrl": "https://electronjs.org/docs/api/structures/memory-info",
|
|
37477
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37478
|
-
"version": "22.3.
|
|
37477
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/memory-info.md",
|
|
37478
|
+
"version": "22.3.27",
|
|
37479
37479
|
"properties": [
|
|
37480
37480
|
{
|
|
37481
37481
|
"name": "workingSetSize",
|
|
@@ -37511,8 +37511,8 @@
|
|
|
37511
37511
|
"description": "",
|
|
37512
37512
|
"slug": "memory-usage-details",
|
|
37513
37513
|
"websiteUrl": "https://electronjs.org/docs/api/structures/memory-usage-details",
|
|
37514
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37515
|
-
"version": "22.3.
|
|
37514
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/memory-usage-details.md",
|
|
37515
|
+
"version": "22.3.27",
|
|
37516
37516
|
"properties": [
|
|
37517
37517
|
{
|
|
37518
37518
|
"name": "count",
|
|
@@ -37546,8 +37546,8 @@
|
|
|
37546
37546
|
"description": "",
|
|
37547
37547
|
"slug": "mime-typed-buffer",
|
|
37548
37548
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mime-typed-buffer",
|
|
37549
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37550
|
-
"version": "22.3.
|
|
37549
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/mime-typed-buffer.md",
|
|
37550
|
+
"version": "22.3.27",
|
|
37551
37551
|
"properties": [
|
|
37552
37552
|
{
|
|
37553
37553
|
"name": "mimeType",
|
|
@@ -37584,8 +37584,8 @@
|
|
|
37584
37584
|
"description": "",
|
|
37585
37585
|
"slug": "mouse-input-event",
|
|
37586
37586
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mouse-input-event",
|
|
37587
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37588
|
-
"version": "22.3.
|
|
37587
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/mouse-input-event.md",
|
|
37588
|
+
"version": "22.3.27",
|
|
37589
37589
|
"properties": [
|
|
37590
37590
|
{
|
|
37591
37591
|
"name": "type",
|
|
@@ -37712,8 +37712,8 @@
|
|
|
37712
37712
|
"description": "",
|
|
37713
37713
|
"slug": "mouse-wheel-input-event",
|
|
37714
37714
|
"websiteUrl": "https://electronjs.org/docs/api/structures/mouse-wheel-input-event",
|
|
37715
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37716
|
-
"version": "22.3.
|
|
37715
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/mouse-wheel-input-event.md",
|
|
37716
|
+
"version": "22.3.27",
|
|
37717
37717
|
"properties": [
|
|
37718
37718
|
{
|
|
37719
37719
|
"name": "type",
|
|
@@ -37801,8 +37801,8 @@
|
|
|
37801
37801
|
"description": "",
|
|
37802
37802
|
"slug": "notification-action",
|
|
37803
37803
|
"websiteUrl": "https://electronjs.org/docs/api/structures/notification-action",
|
|
37804
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37805
|
-
"version": "22.3.
|
|
37804
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/notification-action.md",
|
|
37805
|
+
"version": "22.3.27",
|
|
37806
37806
|
"properties": [
|
|
37807
37807
|
{
|
|
37808
37808
|
"name": "type",
|
|
@@ -37835,8 +37835,8 @@
|
|
|
37835
37835
|
"description": "",
|
|
37836
37836
|
"slug": "notification-response",
|
|
37837
37837
|
"websiteUrl": "https://electronjs.org/docs/api/structures/notification-response",
|
|
37838
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37839
|
-
"version": "22.3.
|
|
37838
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/notification-response.md",
|
|
37839
|
+
"version": "22.3.27",
|
|
37840
37840
|
"properties": [
|
|
37841
37841
|
{
|
|
37842
37842
|
"name": "actionIdentifier",
|
|
@@ -37900,8 +37900,8 @@
|
|
|
37900
37900
|
"description": "",
|
|
37901
37901
|
"slug": "payment-discount",
|
|
37902
37902
|
"websiteUrl": "https://electronjs.org/docs/api/structures/payment-discount",
|
|
37903
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37904
|
-
"version": "22.3.
|
|
37903
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/payment-discount.md",
|
|
37904
|
+
"version": "22.3.27",
|
|
37905
37905
|
"properties": [
|
|
37906
37906
|
{
|
|
37907
37907
|
"name": "identifier",
|
|
@@ -37955,8 +37955,8 @@
|
|
|
37955
37955
|
"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.",
|
|
37956
37956
|
"slug": "point",
|
|
37957
37957
|
"websiteUrl": "https://electronjs.org/docs/api/structures/point",
|
|
37958
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37959
|
-
"version": "22.3.
|
|
37958
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/point.md",
|
|
37959
|
+
"version": "22.3.27",
|
|
37960
37960
|
"properties": [
|
|
37961
37961
|
{
|
|
37962
37962
|
"name": "x",
|
|
@@ -37982,8 +37982,8 @@
|
|
|
37982
37982
|
"description": "",
|
|
37983
37983
|
"slug": "post-body",
|
|
37984
37984
|
"websiteUrl": "https://electronjs.org/docs/api/structures/post-body",
|
|
37985
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
37986
|
-
"version": "22.3.
|
|
37985
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/post-body.md",
|
|
37986
|
+
"version": "22.3.27",
|
|
37987
37987
|
"properties": [
|
|
37988
37988
|
{
|
|
37989
37989
|
"name": "data",
|
|
@@ -38028,8 +38028,8 @@
|
|
|
38028
38028
|
"description": "",
|
|
38029
38029
|
"slug": "printer-info",
|
|
38030
38030
|
"websiteUrl": "https://electronjs.org/docs/api/structures/printer-info",
|
|
38031
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38032
|
-
"version": "22.3.
|
|
38031
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/printer-info.md",
|
|
38032
|
+
"version": "22.3.27",
|
|
38033
38033
|
"properties": [
|
|
38034
38034
|
{
|
|
38035
38035
|
"name": "name",
|
|
@@ -38091,8 +38091,8 @@
|
|
|
38091
38091
|
"description": "",
|
|
38092
38092
|
"slug": "process-memory-info",
|
|
38093
38093
|
"websiteUrl": "https://electronjs.org/docs/api/structures/process-memory-info",
|
|
38094
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38095
|
-
"version": "22.3.
|
|
38094
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/process-memory-info.md",
|
|
38095
|
+
"version": "22.3.27",
|
|
38096
38096
|
"properties": [
|
|
38097
38097
|
{
|
|
38098
38098
|
"name": "residentSet",
|
|
@@ -38129,8 +38129,8 @@
|
|
|
38129
38129
|
"description": "",
|
|
38130
38130
|
"slug": "process-metric",
|
|
38131
38131
|
"websiteUrl": "https://electronjs.org/docs/api/structures/process-metric",
|
|
38132
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38133
|
-
"version": "22.3.
|
|
38132
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/process-metric.md",
|
|
38133
|
+
"version": "22.3.27",
|
|
38134
38134
|
"properties": [
|
|
38135
38135
|
{
|
|
38136
38136
|
"name": "pid",
|
|
@@ -38279,8 +38279,8 @@
|
|
|
38279
38279
|
"description": "",
|
|
38280
38280
|
"slug": "product-discount",
|
|
38281
38281
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product-discount",
|
|
38282
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38283
|
-
"version": "22.3.
|
|
38282
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/product-discount.md",
|
|
38283
|
+
"version": "22.3.27",
|
|
38284
38284
|
"properties": [
|
|
38285
38285
|
{
|
|
38286
38286
|
"name": "identifier",
|
|
@@ -38362,8 +38362,8 @@
|
|
|
38362
38362
|
"description": "",
|
|
38363
38363
|
"slug": "product-subscription-period",
|
|
38364
38364
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product-subscription-period",
|
|
38365
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38366
|
-
"version": "22.3.
|
|
38365
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/product-subscription-period.md",
|
|
38366
|
+
"version": "22.3.27",
|
|
38367
38367
|
"properties": [
|
|
38368
38368
|
{
|
|
38369
38369
|
"name": "numberOfUnits",
|
|
@@ -38407,8 +38407,8 @@
|
|
|
38407
38407
|
"description": "",
|
|
38408
38408
|
"slug": "product",
|
|
38409
38409
|
"websiteUrl": "https://electronjs.org/docs/api/structures/product",
|
|
38410
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38411
|
-
"version": "22.3.
|
|
38410
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/product.md",
|
|
38411
|
+
"version": "22.3.27",
|
|
38412
38412
|
"properties": [
|
|
38413
38413
|
{
|
|
38414
38414
|
"name": "productIdentifier",
|
|
@@ -38546,8 +38546,8 @@
|
|
|
38546
38546
|
"description": "",
|
|
38547
38547
|
"slug": "protocol-request",
|
|
38548
38548
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-request",
|
|
38549
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38550
|
-
"version": "22.3.
|
|
38549
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/protocol-request.md",
|
|
38550
|
+
"version": "22.3.27",
|
|
38551
38551
|
"properties": [
|
|
38552
38552
|
{
|
|
38553
38553
|
"name": "url",
|
|
@@ -38612,8 +38612,8 @@
|
|
|
38612
38612
|
"description": "",
|
|
38613
38613
|
"slug": "protocol-response-upload-data",
|
|
38614
38614
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response-upload-data",
|
|
38615
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38616
|
-
"version": "22.3.
|
|
38615
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/protocol-response-upload-data.md",
|
|
38616
|
+
"version": "22.3.27",
|
|
38617
38617
|
"properties": [
|
|
38618
38618
|
{
|
|
38619
38619
|
"name": "contentType",
|
|
@@ -38650,8 +38650,8 @@
|
|
|
38650
38650
|
"description": "",
|
|
38651
38651
|
"slug": "protocol-response",
|
|
38652
38652
|
"websiteUrl": "https://electronjs.org/docs/api/structures/protocol-response",
|
|
38653
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38654
|
-
"version": "22.3.
|
|
38653
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/protocol-response.md",
|
|
38654
|
+
"version": "22.3.27",
|
|
38655
38655
|
"properties": [
|
|
38656
38656
|
{
|
|
38657
38657
|
"name": "error",
|
|
@@ -38799,8 +38799,8 @@
|
|
|
38799
38799
|
"description": "",
|
|
38800
38800
|
"slug": "rectangle",
|
|
38801
38801
|
"websiteUrl": "https://electronjs.org/docs/api/structures/rectangle",
|
|
38802
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38803
|
-
"version": "22.3.
|
|
38802
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/rectangle.md",
|
|
38803
|
+
"version": "22.3.27",
|
|
38804
38804
|
"properties": [
|
|
38805
38805
|
{
|
|
38806
38806
|
"name": "x",
|
|
@@ -38842,8 +38842,8 @@
|
|
|
38842
38842
|
"description": "",
|
|
38843
38843
|
"slug": "referrer",
|
|
38844
38844
|
"websiteUrl": "https://electronjs.org/docs/api/structures/referrer",
|
|
38845
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38846
|
-
"version": "22.3.
|
|
38845
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/referrer.md",
|
|
38846
|
+
"version": "22.3.27",
|
|
38847
38847
|
"properties": [
|
|
38848
38848
|
{
|
|
38849
38849
|
"name": "url",
|
|
@@ -38904,8 +38904,8 @@
|
|
|
38904
38904
|
"description": "",
|
|
38905
38905
|
"slug": "scrubber-item",
|
|
38906
38906
|
"websiteUrl": "https://electronjs.org/docs/api/structures/scrubber-item",
|
|
38907
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38908
|
-
"version": "22.3.
|
|
38907
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/scrubber-item.md",
|
|
38908
|
+
"version": "22.3.27",
|
|
38909
38909
|
"properties": [
|
|
38910
38910
|
{
|
|
38911
38911
|
"name": "label",
|
|
@@ -38932,8 +38932,8 @@
|
|
|
38932
38932
|
"description": "",
|
|
38933
38933
|
"slug": "segmented-control-segment",
|
|
38934
38934
|
"websiteUrl": "https://electronjs.org/docs/api/structures/segmented-control-segment",
|
|
38935
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38936
|
-
"version": "22.3.
|
|
38935
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/segmented-control-segment.md",
|
|
38936
|
+
"version": "22.3.27",
|
|
38937
38937
|
"properties": [
|
|
38938
38938
|
{
|
|
38939
38939
|
"name": "label",
|
|
@@ -38968,8 +38968,8 @@
|
|
|
38968
38968
|
"description": "",
|
|
38969
38969
|
"slug": "serial-port",
|
|
38970
38970
|
"websiteUrl": "https://electronjs.org/docs/api/structures/serial-port",
|
|
38971
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
38972
|
-
"version": "22.3.
|
|
38971
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/serial-port.md",
|
|
38972
|
+
"version": "22.3.27",
|
|
38973
38973
|
"properties": [
|
|
38974
38974
|
{
|
|
38975
38975
|
"name": "portId",
|
|
@@ -39051,8 +39051,8 @@
|
|
|
39051
39051
|
"description": "",
|
|
39052
39052
|
"slug": "service-worker-info",
|
|
39053
39053
|
"websiteUrl": "https://electronjs.org/docs/api/structures/service-worker-info",
|
|
39054
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39055
|
-
"version": "22.3.
|
|
39054
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/service-worker-info.md",
|
|
39055
|
+
"version": "22.3.27",
|
|
39056
39056
|
"properties": [
|
|
39057
39057
|
{
|
|
39058
39058
|
"name": "scriptUrl",
|
|
@@ -39088,8 +39088,8 @@
|
|
|
39088
39088
|
"description": "",
|
|
39089
39089
|
"slug": "shared-worker-info",
|
|
39090
39090
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shared-worker-info",
|
|
39091
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39092
|
-
"version": "22.3.
|
|
39091
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/shared-worker-info.md",
|
|
39092
|
+
"version": "22.3.27",
|
|
39093
39093
|
"properties": [
|
|
39094
39094
|
{
|
|
39095
39095
|
"name": "id",
|
|
@@ -39117,8 +39117,8 @@
|
|
|
39117
39117
|
"description": "",
|
|
39118
39118
|
"slug": "sharing-item",
|
|
39119
39119
|
"websiteUrl": "https://electronjs.org/docs/api/structures/sharing-item",
|
|
39120
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39121
|
-
"version": "22.3.
|
|
39120
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/sharing-item.md",
|
|
39121
|
+
"version": "22.3.27",
|
|
39122
39122
|
"properties": [
|
|
39123
39123
|
{
|
|
39124
39124
|
"name": "texts",
|
|
@@ -39155,8 +39155,8 @@
|
|
|
39155
39155
|
"description": "",
|
|
39156
39156
|
"slug": "shortcut-details",
|
|
39157
39157
|
"websiteUrl": "https://electronjs.org/docs/api/structures/shortcut-details",
|
|
39158
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39159
|
-
"version": "22.3.
|
|
39158
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/shortcut-details.md",
|
|
39159
|
+
"version": "22.3.27",
|
|
39160
39160
|
"properties": [
|
|
39161
39161
|
{
|
|
39162
39162
|
"name": "target",
|
|
@@ -39237,8 +39237,8 @@
|
|
|
39237
39237
|
"description": "",
|
|
39238
39238
|
"slug": "size",
|
|
39239
39239
|
"websiteUrl": "https://electronjs.org/docs/api/structures/size",
|
|
39240
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39241
|
-
"version": "22.3.
|
|
39240
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/size.md",
|
|
39241
|
+
"version": "22.3.27",
|
|
39242
39242
|
"properties": [
|
|
39243
39243
|
{
|
|
39244
39244
|
"name": "width",
|
|
@@ -39264,8 +39264,8 @@
|
|
|
39264
39264
|
"description": "",
|
|
39265
39265
|
"slug": "task",
|
|
39266
39266
|
"websiteUrl": "https://electronjs.org/docs/api/structures/task",
|
|
39267
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39268
|
-
"version": "22.3.
|
|
39267
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/task.md",
|
|
39268
|
+
"version": "22.3.27",
|
|
39269
39269
|
"properties": [
|
|
39270
39270
|
{
|
|
39271
39271
|
"name": "program",
|
|
@@ -39337,8 +39337,8 @@
|
|
|
39337
39337
|
"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.",
|
|
39338
39338
|
"slug": "thumbar-button",
|
|
39339
39339
|
"websiteUrl": "https://electronjs.org/docs/api/structures/thumbar-button",
|
|
39340
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39341
|
-
"version": "22.3.
|
|
39340
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/thumbar-button.md",
|
|
39341
|
+
"version": "22.3.27",
|
|
39342
39342
|
"properties": [
|
|
39343
39343
|
{
|
|
39344
39344
|
"name": "icon",
|
|
@@ -39384,8 +39384,8 @@
|
|
|
39384
39384
|
"description": "",
|
|
39385
39385
|
"slug": "trace-categories-and-options",
|
|
39386
39386
|
"websiteUrl": "https://electronjs.org/docs/api/structures/trace-categories-and-options",
|
|
39387
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39388
|
-
"version": "22.3.
|
|
39387
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/trace-categories-and-options.md",
|
|
39388
|
+
"version": "22.3.27",
|
|
39389
39389
|
"properties": [
|
|
39390
39390
|
{
|
|
39391
39391
|
"name": "categoryFilter",
|
|
@@ -39413,8 +39413,8 @@
|
|
|
39413
39413
|
"description": "An example TraceConfig that roughly matches what Chrome DevTools records:",
|
|
39414
39414
|
"slug": "trace-config",
|
|
39415
39415
|
"websiteUrl": "https://electronjs.org/docs/api/structures/trace-config",
|
|
39416
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39417
|
-
"version": "22.3.
|
|
39416
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/trace-config.md",
|
|
39417
|
+
"version": "22.3.27",
|
|
39418
39418
|
"properties": [
|
|
39419
39419
|
{
|
|
39420
39420
|
"name": "recording_mode",
|
|
@@ -39528,8 +39528,8 @@
|
|
|
39528
39528
|
"description": "",
|
|
39529
39529
|
"slug": "transaction",
|
|
39530
39530
|
"websiteUrl": "https://electronjs.org/docs/api/structures/transaction",
|
|
39531
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39532
|
-
"version": "22.3.
|
|
39531
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/transaction.md",
|
|
39532
|
+
"version": "22.3.27",
|
|
39533
39533
|
"properties": [
|
|
39534
39534
|
{
|
|
39535
39535
|
"name": "transactionIdentifier",
|
|
@@ -39657,8 +39657,8 @@
|
|
|
39657
39657
|
"description": "",
|
|
39658
39658
|
"slug": "upload-data",
|
|
39659
39659
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-data",
|
|
39660
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39661
|
-
"version": "22.3.
|
|
39660
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/upload-data.md",
|
|
39661
|
+
"version": "22.3.27",
|
|
39662
39662
|
"properties": [
|
|
39663
39663
|
{
|
|
39664
39664
|
"name": "bytes",
|
|
@@ -39694,8 +39694,8 @@
|
|
|
39694
39694
|
"description": "",
|
|
39695
39695
|
"slug": "upload-file",
|
|
39696
39696
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-file",
|
|
39697
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39698
|
-
"version": "22.3.
|
|
39697
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/upload-file.md",
|
|
39698
|
+
"version": "22.3.27",
|
|
39699
39699
|
"properties": [
|
|
39700
39700
|
{
|
|
39701
39701
|
"name": "type",
|
|
@@ -39746,8 +39746,8 @@
|
|
|
39746
39746
|
"description": "",
|
|
39747
39747
|
"slug": "upload-raw-data",
|
|
39748
39748
|
"websiteUrl": "https://electronjs.org/docs/api/structures/upload-raw-data",
|
|
39749
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39750
|
-
"version": "22.3.
|
|
39749
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/upload-raw-data.md",
|
|
39750
|
+
"version": "22.3.27",
|
|
39751
39751
|
"properties": [
|
|
39752
39752
|
{
|
|
39753
39753
|
"name": "type",
|
|
@@ -39773,8 +39773,8 @@
|
|
|
39773
39773
|
"description": "This type is a helper alias, no object will never exist of this type.",
|
|
39774
39774
|
"slug": "user-default-types",
|
|
39775
39775
|
"websiteUrl": "https://electronjs.org/docs/api/structures/user-default-types",
|
|
39776
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39777
|
-
"version": "22.3.
|
|
39776
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/user-default-types.md",
|
|
39777
|
+
"version": "22.3.27",
|
|
39778
39778
|
"properties": [
|
|
39779
39779
|
{
|
|
39780
39780
|
"name": "string",
|
|
@@ -39867,8 +39867,8 @@
|
|
|
39867
39867
|
"description": "",
|
|
39868
39868
|
"slug": "web-request-filter",
|
|
39869
39869
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-request-filter",
|
|
39870
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39871
|
-
"version": "22.3.
|
|
39870
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/web-request-filter.md",
|
|
39871
|
+
"version": "22.3.27",
|
|
39872
39872
|
"properties": [
|
|
39873
39873
|
{
|
|
39874
39874
|
"name": "urls",
|
|
@@ -39887,8 +39887,8 @@
|
|
|
39887
39887
|
"description": "",
|
|
39888
39888
|
"slug": "web-source",
|
|
39889
39889
|
"websiteUrl": "https://electronjs.org/docs/api/structures/web-source",
|
|
39890
|
-
"repoUrl": "https://github.com/electron/electron/blob/v22.3.
|
|
39891
|
-
"version": "22.3.
|
|
39890
|
+
"repoUrl": "https://github.com/electron/electron/blob/v22.3.27/docs/api/structures/web-source.md",
|
|
39891
|
+
"version": "22.3.27",
|
|
39892
39892
|
"properties": [
|
|
39893
39893
|
{
|
|
39894
39894
|
"name": "code",
|