diff --git a/demo/package-lock.json b/demo/package-lock.json index c75270e..08e6548 100644 --- a/demo/package-lock.json +++ b/demo/package-lock.json @@ -9,7 +9,7 @@ "version": "0.3.0", "license": "MIT", "devDependencies": { - "electron": "v26.2.3" + "electron": "v26.2.4" } }, "node_modules/@electron/get": { @@ -242,9 +242,9 @@ "optional": true }, "node_modules/electron": { - "version": "26.2.3", - "resolved": "https://registry.npmjs.org/electron/-/electron-26.2.3.tgz", - "integrity": "sha512-osdKf9mbhrqE81ITdvQ7TjVOayXfcAlWm8A6EtBt/eFSh7a/FijebGVkgs0S7qWQdhO0KaNZDb1Gx00sWuDQdw==", + "version": "26.2.4", + "resolved": "https://registry.npmjs.org/electron/-/electron-26.2.4.tgz", + "integrity": "sha512-weMUSMyDho5E0DPQ3breba3D96IxwNvtYHjMd/4/wNN3BdI5s3+0orNnPVGJFcLhSvKoxuKUqdVonUocBPwlQA==", "dev": true, "hasInstallScript": true, "dependencies": { @@ -985,9 +985,9 @@ "optional": true }, "electron": { - "version": "26.2.3", - "resolved": "https://registry.npmjs.org/electron/-/electron-26.2.3.tgz", - "integrity": "sha512-osdKf9mbhrqE81ITdvQ7TjVOayXfcAlWm8A6EtBt/eFSh7a/FijebGVkgs0S7qWQdhO0KaNZDb1Gx00sWuDQdw==", + "version": "26.2.4", + "resolved": "https://registry.npmjs.org/electron/-/electron-26.2.4.tgz", + "integrity": "sha512-weMUSMyDho5E0DPQ3breba3D96IxwNvtYHjMd/4/wNN3BdI5s3+0orNnPVGJFcLhSvKoxuKUqdVonUocBPwlQA==", "dev": true, "requires": { "@electron/get": "^2.0.0", diff --git a/demo/package.json b/demo/package.json index ad74178..1eeb4e6 100644 --- a/demo/package.json +++ b/demo/package.json @@ -13,6 +13,6 @@ "start": "electron ." }, "devDependencies": { - "electron": "v26.2.3" + "electron": "v26.2.4" } } diff --git a/electron-api.json b/electron-api.json index 0525e7d..6866480 100644 --- a/electron-api.json +++ b/electron-api.json @@ -4,8 +4,8 @@ "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:", "slug": "app", "websiteUrl": "https://electronjs.org/docs/api/app", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/app.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/app.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -3043,8 +3043,8 @@ "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.", "slug": "auto-updater", "websiteUrl": "https://electronjs.org/docs/api/auto-updater", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/auto-updater.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/auto-updater.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -3259,8 +3259,8 @@ "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```", "slug": "browser-view", "websiteUrl": "https://electronjs.org/docs/api/browser-view", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/browser-view.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/browser-view.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -3420,8 +3420,8 @@ "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 top = new BrowserWindow()\nconst child = new BrowserWindow({ parent: top, modal: true, show: false })\nchild.loadURL('https://github.com')\nchild.once('ready-to-show', () => {\n child.show()\n})\n```\n\n### Page visibility\n\nThe Page Visibility API works as follows:\n\n* On all platforms, the visibility state tracks whether the window is hidden/minimized or not.\n* Additionally, on macOS, the visibility state also tracks the window occlusion state. If the window is occluded (i.e. fully covered) by another window, the visibility state will be `hidden`. On other platforms, the visibility state will be `hidden` only when the window is minimized or explicitly hidden with `win.hide()`.\n* If a `BrowserWindow` is created with `show: false`, the initial visibility state will be `visible` despite the window actually being hidden.\n* If `backgroundThrottling` is disabled, the visibility state will remain `visible` even if the window is minimized, occluded, or hidden.\n\nIt is recommended that you pause expensive operations when the visibility state is `hidden` in order to minimize power consumption.\n\n### Platform notices\n\n* On macOS modal windows will be displayed as sheets attached to the parent window.\n* On macOS the child windows will keep the relative position to parent window when parent window moves, while on Windows and Linux child windows will not move.\n* On Linux the type of modal windows will be changed to `dialog`.\n* On Linux many desktop environments do not support hiding a modal window.\n\n### Class: BrowserWindow\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`.", "slug": "browser-window", "websiteUrl": "https://electronjs.org/docs/api/browser-window", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/browser-window.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/browser-window.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -7099,8 +7099,8 @@ "description": "> Make HTTP/HTTPS requests.\n\nProcess: Main
_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.", "slug": "client-request", "websiteUrl": "https://electronjs.org/docs/api/client-request", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/client-request.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/client-request.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -7763,8 +7763,8 @@ "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:", "slug": "clipboard", "websiteUrl": "https://electronjs.org/docs/api/clipboard", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/clipboard.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/clipboard.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -8429,8 +8429,8 @@ "description": "", "slug": "command-line", "websiteUrl": "https://electronjs.org/docs/api/command-line", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/command-line.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/command-line.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -8556,8 +8556,8 @@ "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.", "slug": "content-tracing", "websiteUrl": "https://electronjs.org/docs/api/content-tracing", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/content-tracing.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/content-tracing.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -8693,8 +8693,8 @@ "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.", "slug": "context-bridge", "websiteUrl": "https://electronjs.org/docs/api/context-bridge", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/context-bridge.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/context-bridge.md", + "version": "26.2.4", "type": "Module", "process": { "main": false, @@ -8769,8 +8769,8 @@ "description": "", "slug": "cookies", "websiteUrl": "https://electronjs.org/docs/api/cookies", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/cookies.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/cookies.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -9118,8 +9118,8 @@ "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.", "slug": "crash-reporter", "websiteUrl": "https://electronjs.org/docs/api/crash-reporter", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/crash-reporter.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/crash-reporter.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -9381,8 +9381,8 @@ "description": "", "slug": "debugger", "websiteUrl": "https://electronjs.org/docs/api/debugger", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/debugger.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/debugger.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -9552,8 +9552,8 @@ "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 { BrowserWindow, desktopCapturer } = require('electron')\n\nconst mainWindow = new BrowserWindow()\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.", "slug": "desktop-capturer", "websiteUrl": "https://electronjs.org/docs/api/desktop-capturer", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/desktop-capturer.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/desktop-capturer.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -9633,8 +9633,8 @@ "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:", "slug": "dialog", "websiteUrl": "https://electronjs.org/docs/api/dialog", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/dialog.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/dialog.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -10724,8 +10724,8 @@ "description": "", "slug": "dock", "websiteUrl": "https://electronjs.org/docs/api/dock", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/dock.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/dock.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -10968,8 +10968,8 @@ "description": "", "slug": "download-item", "websiteUrl": "https://electronjs.org/docs/api/download-item", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/download-item.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/download-item.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -11354,8 +11354,8 @@ "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.", "slug": "global-shortcut", "websiteUrl": "https://electronjs.org/docs/api/global-shortcut", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/global-shortcut.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/global-shortcut.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -11474,8 +11474,8 @@ "description": "> In-app purchases on Mac App Store.\n\nProcess: Main", "slug": "in-app-purchase", "websiteUrl": "https://electronjs.org/docs/api/in-app-purchase", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/in-app-purchase.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/in-app-purchase.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -11651,8 +11651,8 @@ "description": "", "slug": "incoming-message", "websiteUrl": "https://electronjs.org/docs/api/incoming-message", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/incoming-message.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/incoming-message.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -11799,8 +11799,8 @@ "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.", "slug": "ipc-main", "websiteUrl": "https://electronjs.org/docs/api/ipc-main", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/ipc-main.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/ipc-main.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -12093,8 +12093,8 @@ "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.", "slug": "ipc-renderer", "websiteUrl": "https://electronjs.org/docs/api/ipc-renderer", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/ipc-renderer.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/ipc-renderer.md", + "version": "26.2.4", "type": "Module", "process": { "main": false, @@ -12425,8 +12425,8 @@ "description": "> Add items to native application menus and context menus.\n\nProcess: Main\n\nSee `Menu` for examples.", "slug": "menu-item", "websiteUrl": "https://electronjs.org/docs/api/menu-item", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/menu-item.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/menu-item.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -13313,8 +13313,8 @@ "description": "\n\n### Class: Menu\n\n> Create native application menus and context menus.\n\nProcess: Main", "slug": "menu", "websiteUrl": "https://electronjs.org/docs/api/menu", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/menu.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/menu.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -13686,8 +13686,8 @@ "description": "", "slug": "message-channel-main", "websiteUrl": "https://electronjs.org/docs/api/message-channel-main", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/message-channel-main.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/message-channel-main.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -13726,8 +13726,8 @@ "description": "", "slug": "message-port-main", "websiteUrl": "https://electronjs.org/docs/api/message-port-main", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/message-port-main.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/message-port-main.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -13832,8 +13832,8 @@ "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`", "slug": "native-image", "websiteUrl": "https://electronjs.org/docs/api/native-image", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/native-image.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/native-image.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -14078,8 +14078,8 @@ "description": "", "slug": "native-image", "websiteUrl": "https://electronjs.org/docs/api/native-image", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/native-image.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/native-image.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -14500,8 +14500,8 @@ "description": "> Read and respond to changes in Chromium's native color theme.\n\nProcess: Main", "slug": "native-theme", "websiteUrl": "https://electronjs.org/docs/api/native-theme", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/native-theme.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/native-theme.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -14599,8 +14599,8 @@ "description": "> Logging network events for a session.\n\nProcess: Main\n\n```\nconst { app, netLog } = require('electron')\n\napp.whenReady().then(async () => {\n await netLog.startLogging('/path/to/net-log')\n // After some network events\n const path = await netLog.stopLogging()\n console.log('Net-logs written to', path)\n})\n```\n\nSee `--log-net-log` to log network events throughout the app's lifecycle.\n\n**Note:** All methods unless specified can only be used after the `ready` event of the `app` module gets emitted.", "slug": "net-log", "websiteUrl": "https://electronjs.org/docs/api/net-log", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/net-log.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/net-log.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -14714,8 +14714,8 @@ "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.", "slug": "net", "websiteUrl": "https://electronjs.org/docs/api/net", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/net.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/net.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -14954,8 +14954,8 @@ "description": "> Create OS desktop notifications\n\nProcess: Main\n\n:::info Renderer process notifications\n\nIf you want to show notifications from a renderer process you should use the web Notifications API\n\n:::\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", "slug": "notification", "websiteUrl": "https://electronjs.org/docs/api/notification", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/notification.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/notification.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -15460,8 +15460,8 @@ "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._", "slug": "parent-port", "websiteUrl": "https://electronjs.org/docs/api/parent-port", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/parent-port.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/parent-port.md", + "version": "26.2.4", "type": "Module", "process": { "main": false, @@ -15531,8 +15531,8 @@ "description": "> Monitor power state changes.\n\nProcess: Main", "slug": "power-monitor", "websiteUrl": "https://electronjs.org/docs/api/power-monitor", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/power-monitor.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/power-monitor.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -15759,8 +15759,8 @@ "description": "> Block the system from entering low-power (sleep) mode.\n\nProcess: Main\n\nFor example:", "slug": "power-save-blocker", "websiteUrl": "https://electronjs.org/docs/api/power-save-blocker", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/power-save-blocker.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/power-save-blocker.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -15848,8 +15848,8 @@ "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`", "slug": "process", "websiteUrl": "https://electronjs.org/docs/api/process", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/process.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/process.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -16379,8 +16379,8 @@ "description": "> Register a custom protocol and intercept existing protocol requests.\n\nProcess: Main\n\nAn example of implementing a protocol that has the same effect as the `file://` protocol:\n\n```\nconst { app, protocol, net } = require('electron')\n\napp.whenReady().then(() => {\n protocol.handle('atom', (request) =>\n net.fetch('file://' + request.url.slice('atom://'.length)))\n})\n```\n\n**Note:** All methods unless specified can only be used after the `ready` event of the `app` module gets emitted.\n\n### Using `protocol` with a custom `partition` or `session`\n\nA protocol is registered to a specific Electron `session` object. If you don't specify a session, then your `protocol` will be applied to the default session that Electron uses. However, if you define a `partition` or `session` on your `browserWindow`'s `webPreferences`, then that window will use a different session and your custom protocol will not work if you just use `electron.protocol.XXX`.\n\nTo have your custom protocol work in combination with a custom session, you need to register it to that session explicitly.\n\n```\nconst { app, BrowserWindow, net, protocol, session } = require('electron')\nconst path = require('node:path')\nconst url = require('url')\n\napp.whenReady().then(() => {\n const partition = 'persist:example'\n const ses = session.fromPartition(partition)\n\n ses.protocol.handle('atom', (request) => {\n const filePath = request.url.slice('atom://'.length)\n return net.fetch(url.pathToFileURL(path.join(__dirname, filePath)).toString())\n })\n\n const mainWindow = new BrowserWindow({ webPreferences: { partition } })\n})\n```", "slug": "protocol", "websiteUrl": "https://electronjs.org/docs/api/protocol", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/protocol.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/protocol.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -17245,8 +17245,8 @@ "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):", "slug": "push-notifications", "websiteUrl": "https://electronjs.org/docs/api/push-notifications", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/push-notifications.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/push-notifications.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -17334,8 +17334,8 @@ "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.", "slug": "safe-storage", "websiteUrl": "https://electronjs.org/docs/api/safe-storage", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/safe-storage.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/safe-storage.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -17464,8 +17464,8 @@ "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:", "slug": "screen", "websiteUrl": "https://electronjs.org/docs/api/screen", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/screen.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/screen.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -17761,8 +17761,8 @@ "description": "", "slug": "service-workers", "websiteUrl": "https://electronjs.org/docs/api/service-workers", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/service-workers.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/service-workers.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -17991,8 +17991,8 @@ "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.", "slug": "session", "websiteUrl": "https://electronjs.org/docs/api/session", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/session.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/session.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -18096,8 +18096,8 @@ "description": "", "slug": "session", "websiteUrl": "https://electronjs.org/docs/api/session", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/session.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/session.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -21202,8 +21202,8 @@ "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", "slug": "share-menu", "websiteUrl": "https://electronjs.org/docs/api/share-menu", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/share-menu.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/share-menu.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -21269,8 +21269,8 @@ "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.", "slug": "shell", "websiteUrl": "https://electronjs.org/docs/api/shell", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/shell.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/shell.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -21511,8 +21511,8 @@ "description": "> Get system preferences.\n\nProcess: Main", "slug": "system-preferences", "websiteUrl": "https://electronjs.org/docs/api/system-preferences", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/system-preferences.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/system-preferences.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -22898,8 +22898,8 @@ "description": "> Create a button in the touch bar for native macOS applications\n\nProcess: Main
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._", "slug": "touch-bar-button", "websiteUrl": "https://electronjs.org/docs/api/touch-bar-button", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/touch-bar-button.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/touch-bar-button.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -23089,8 +23089,8 @@ "description": "> Create a color picker in the touch bar for native macOS applications\n\nProcess: Main
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._", "slug": "touch-bar-color-picker", "websiteUrl": "https://electronjs.org/docs/api/touch-bar-color-picker", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/touch-bar-color-picker.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/touch-bar-color-picker.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -23181,8 +23181,8 @@ "description": "> Create a group in the touch bar for native macOS applications\n\nProcess: Main
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._", "slug": "touch-bar-group", "websiteUrl": "https://electronjs.org/docs/api/touch-bar-group", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/touch-bar-group.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/touch-bar-group.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -23223,8 +23223,8 @@ "description": "> Create a label in the touch bar for native macOS applications\n\nProcess: Main
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._", "slug": "touch-bar-label", "websiteUrl": "https://electronjs.org/docs/api/touch-bar-label", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/touch-bar-label.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/touch-bar-label.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -23315,8 +23315,8 @@ "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
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._", "slug": "touch-bar-other-items-proxy", "websiteUrl": "https://electronjs.org/docs/api/touch-bar-other-items-proxy", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/touch-bar-other-items-proxy.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/touch-bar-other-items-proxy.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -23339,8 +23339,8 @@ "description": "> Create a popover in the touch bar for native macOS applications\n\nProcess: Main
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._", "slug": "touch-bar-popover", "websiteUrl": "https://electronjs.org/docs/api/touch-bar-popover", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/touch-bar-popover.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/touch-bar-popover.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -23426,8 +23426,8 @@ "description": "> Create a scrubber (a scrollable selector)\n\nProcess: Main
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._", "slug": "touch-bar-scrubber", "websiteUrl": "https://electronjs.org/docs/api/touch-bar-scrubber", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/touch-bar-scrubber.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/touch-bar-scrubber.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -23675,8 +23675,8 @@ "description": "> Create a segmented control (a button group) where one button has a selected state\n\nProcess: Main
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._", "slug": "touch-bar-segmented-control", "websiteUrl": "https://electronjs.org/docs/api/touch-bar-segmented-control", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/touch-bar-segmented-control.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/touch-bar-segmented-control.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -23866,8 +23866,8 @@ "description": "> Create a slider in the touch bar for native macOS applications\n\nProcess: Main
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._", "slug": "touch-bar-slider", "websiteUrl": "https://electronjs.org/docs/api/touch-bar-slider", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/touch-bar-slider.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/touch-bar-slider.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -23989,8 +23989,8 @@ "description": "> Create a spacer between two items in the touch bar for native macOS applications\n\nProcess: Main
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._", "slug": "touch-bar-spacer", "websiteUrl": "https://electronjs.org/docs/api/touch-bar-spacer", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/touch-bar-spacer.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/touch-bar-spacer.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -24069,8 +24069,8 @@ "description": "\n\n### Class: TouchBar\n\n> Create TouchBar layouts for native macOS applications\n\nProcess: Main", "slug": "touch-bar", "websiteUrl": "https://electronjs.org/docs/api/touch-bar", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/touch-bar.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/touch-bar.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -24298,8 +24298,8 @@ "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.", "slug": "tray", "websiteUrl": "https://electronjs.org/docs/api/tray", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/tray.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/tray.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -25087,8 +25087,8 @@ "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
", "slug": "utility-process", "websiteUrl": "https://electronjs.org/docs/api/utility-process", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/utility-process.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/utility-process.md", + "version": "26.2.4", "type": "Module", "process": { "main": true, @@ -25222,8 +25222,8 @@ "description": "", "slug": "utility-process", "websiteUrl": "https://electronjs.org/docs/api/utility-process", - "repoUrl": "https://github.com/electron/electron/blob/v26.2.3/docs/api/utility-process.md", - "version": "26.2.3", + "repoUrl": "https://github.com/electron/electron/blob/v26.2.4/docs/api/utility-process.md", + "version": "26.2.4", "type": "Class", "process": { "main": true, @@ -25375,8 +25375,8 @@ "description": "> Render and control web pages.\n\nProcess: Main\n\n`webContents` is an EventEmitter. It is responsible for rendering and controlling a web page and is a property of the `BrowserWindow` object. An example of accessing the `webContents` object:\n\n### Navigation Events\n\nSeveral events can be used to monitor navigations as they occur within a `webContents`.\n\n### Document Navigations\n\nWhen a `webContents` navigates to another page (as opposed to an in-page navigation), the following events will be fired.\n\n* `did-start-navigation`\n* `will-frame-navigate`\n* `will-navigate` (only fired when main frame navigates)\n* `will-redirect` (only fired when a redirect happens during navigation)\n* `did-redirect-navigation` (only fired when a redirect happens during navigation)\n* `did-frame-navigate`\n* `did-navigate` (only fired when main frame navigates)\n\nSubsequent events will not fire if `event.preventDefault()` is called on any of the cancellable events.\n\n### In-page Navigation\n\nIn-page navigations don't cause the page to reload, but instead navigate to a location within the current page. These events are not cancellable. For an in-page navigations, the following events will fire in this order:\n\n* `did-start-navigation`\n* `did-navigate-in-page`\n\n### Frame Navigation\n\nThe `will-navigate` and `did-navigate` events only fire when the mainFrame navigates. If you want to also observe navigations in `