diff --git a/docs/api/app.md b/docs/api/app.md index 764840dd1e..634f60cde0 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -2,6 +2,8 @@ > Control your application's event lifecycle. +Process: [Main](../tutorial/quick-start.md#main-process) + The following example shows how to quit the application when the last window is closed: diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index b36dc2042b..f50dcd0917 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -2,6 +2,8 @@ > Enable apps to automatically update themselves. +Process: [Main](../tutorial/quick-start.md#main-process) + The `autoUpdater` module provides an interface for the [Squirrel](https://github.com/Squirrel) framework. diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index f04434ece4..5904e485d9 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -2,6 +2,8 @@ > Create and control browser windows. +Process: [Main](../tutorial/quick-start.md#main-process) + ```javascript // In the main process. const {BrowserWindow} = require('electron') diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md index ba2438d36c..f6e72b82c7 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -2,6 +2,8 @@ > Perform copy and paste operations on the system clipboard. +Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) + The following example shows how to write a string to the clipboard: ```javascript diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 20ee2c26ac..b23f8b070b 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -2,6 +2,8 @@ > Submit crash reports to a remote server. +Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) + The following is an example of automatically submitting a crash report to a remote server: diff --git a/docs/api/desktop-capturer.md b/docs/api/desktop-capturer.md index 0b6b411e03..5e64a8403d 100644 --- a/docs/api/desktop-capturer.md +++ b/docs/api/desktop-capturer.md @@ -3,6 +3,8 @@ > Access information about media sources that can be used to capture audio and > video from the desktop using the [`navigator.webkitGetUserMedia`] API. +Process: [Renderer](../tutorial/quick-start.md#renderer-process) + The following example shows how to capture video from a desktop window whose title is `Electron`: diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 1bc971164c..5094c714c3 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -2,6 +2,8 @@ > Display native system dialogs for opening and saving files, alerting, etc. +Process: [Main](../tutorial/quick-start.md#main-process) + An example of showing a dialog to select multiple files and directories: ```javascript diff --git a/docs/api/download-item.md b/docs/api/download-item.md index bdb0f8eedf..08939c3445 100644 --- a/docs/api/download-item.md +++ b/docs/api/download-item.md @@ -2,6 +2,8 @@ > Control file downloads from remote sources. +Process: [Main](../tutorial/quick-start.md#main-process) + `DownloadItem` is an `EventEmitter` that represents a download item in Electron. It is used in `will-download` event of `Session` class, and allows users to control the download item. @@ -59,7 +61,7 @@ Returns: * `state` String Emitted when the download is in a terminal state. This includes a completed -download, a cancelled download(via `downloadItem.cancel()`), and interrupted +download, a cancelled download (via `downloadItem.cancel()`), and interrupted download that can't be resumed. The `state` can be one of following: diff --git a/docs/api/file-object.md b/docs/api/file-object.md index c39a0cf715..d451513c02 100644 --- a/docs/api/file-object.md +++ b/docs/api/file-object.md @@ -7,7 +7,7 @@ let users work on native files directly with the HTML5 file API. Electron has added a `path` attribute to the `File` interface which exposes the file's real path on filesystem. -Example on getting a real path from a dragged-onto-the-app file: +Example of getting a real path from a dragged-onto-the-app file: ```html
diff --git a/docs/api/global-shortcut.md b/docs/api/global-shortcut.md index eb4edda73c..db6253e4b7 100644 --- a/docs/api/global-shortcut.md +++ b/docs/api/global-shortcut.md @@ -2,6 +2,8 @@ > Detect keyboard events when the application does not have keyboard focus. +Process: [Main](../tutorial/quick-start.md#main-process) + The `globalShortcut` module can register/unregister a global keyboard shortcut with the operating system so that you can customize the operations for various shortcuts. diff --git a/docs/api/ipc-main.md b/docs/api/ipc-main.md index a5951fe1a6..c474512ad6 100644 --- a/docs/api/ipc-main.md +++ b/docs/api/ipc-main.md @@ -2,6 +2,8 @@ > Communicate asynchronously from the main process to renderer processes. +Process: [Main](../tutorial/quick-start.md#main-process) + The `ipcMain` module is an instance of the [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) class. When used in the main process, it handles asynchronous and synchronous messages sent from a renderer diff --git a/docs/api/ipc-renderer.md b/docs/api/ipc-renderer.md index afe83a845a..b40baf856d 100644 --- a/docs/api/ipc-renderer.md +++ b/docs/api/ipc-renderer.md @@ -2,6 +2,8 @@ > Communicate asynchronously from a renderer process to the main process. +Process: [Renderer](../tutorial/quick-start.md#renderer-process) + The `ipcRenderer` module is an instance of the [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter) class. It provides a few methods so you can send synchronous and asynchronous messages from the render diff --git a/docs/api/menu-item.md b/docs/api/menu-item.md index 5adcdd75ad..812a50f301 100644 --- a/docs/api/menu-item.md +++ b/docs/api/menu-item.md @@ -2,6 +2,8 @@ > Add items to native application menus and context menus. +Process: [Main](../tutorial/quick-start.md#main-process) + See [`Menu`](menu.md) for examples. ## Class: MenuItem diff --git a/docs/api/menu.md b/docs/api/menu.md index f3ab77588c..d5446f46ce 100644 --- a/docs/api/menu.md +++ b/docs/api/menu.md @@ -2,6 +2,8 @@ > Create native application menus and context menus. +Process: [Main](../tutorial/quick-start.md#main-process) + Each `Menu` consists of multiple [`MenuItem`](menu-item.md)s and each `MenuItem` can have a submenu. diff --git a/docs/api/native-image.md b/docs/api/native-image.md index 4c447d50ec..7ca8c18c48 100644 --- a/docs/api/native-image.md +++ b/docs/api/native-image.md @@ -2,6 +2,8 @@ > Create tray, dock, and application icons using PNG or JPG files. +Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) + In 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. @@ -155,6 +157,8 @@ Creates a new `NativeImage` instance from `dataURL`. > Natively wrap images such as tray, dock, and application icons. +Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) + ### Instance Methods The following methods are available on instances of the `NativeImage` class: diff --git a/docs/api/net.md b/docs/api/net.md index 30792cb262..194f135512 100644 --- a/docs/api/net.md +++ b/docs/api/net.md @@ -2,6 +2,8 @@ > Issue HTTP/HTTPS requests using Chromium's native networking library +Process: [Main](../tutorial/quick-start.md#main-process) + The `net` module is a client-side API for issuing HTTP(S) requests. It is similar to the [HTTP](https://nodejs.org/api/http.html) and [HTTPS](https://nodejs.org/api/https.html) modules of Node.js but uses @@ -72,6 +74,8 @@ specified protocol scheme in the `options` object. > Make HTTP/HTTPS requests. +Process: [Main](../tutorial/quick-start.md#main-process) + `ClientRequest` implements the [Writable Stream](https://nodejs.org/api/stream.html#stream_writable_streams) interface and is therefore an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). @@ -264,6 +268,8 @@ response object,it will emit the `aborted` event. > Handle responses to HTTP/HTTPS requests. +Process: [Main](../tutorial/quick-start.md#main-process) + `IncomingMessage` implements the [Readable Stream](https://nodejs.org/api/stream.html#stream_readable_streams) interface and is therefore an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). diff --git a/docs/api/power-monitor.md b/docs/api/power-monitor.md index d6bbe1041e..5827ef6205 100644 --- a/docs/api/power-monitor.md +++ b/docs/api/power-monitor.md @@ -2,6 +2,8 @@ > Monitor power state changes. +Process: [Main](../tutorial/quick-start.md#main-process) + You cannot require or use this module until the `ready` event of the `app` module is emitted. diff --git a/docs/api/power-save-blocker.md b/docs/api/power-save-blocker.md index 1164f93fb9..cd1138f195 100644 --- a/docs/api/power-save-blocker.md +++ b/docs/api/power-save-blocker.md @@ -2,6 +2,8 @@ > Block the system from entering low-power (sleep) mode. +Process: [Main](../tutorial/quick-start.md#main-process) + For example: ```javascript diff --git a/docs/api/process.md b/docs/api/process.md index 3fe90fc06d..275d05c53e 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -2,6 +2,8 @@ > Extensions to process object. +Process: [Main](../tutorial/quick-start.md#main-process) + The `process` object is extended in Electron with following APIs: ## Events diff --git a/docs/api/protocol.md b/docs/api/protocol.md index 4050ea110f..da5604b1fe 100644 --- a/docs/api/protocol.md +++ b/docs/api/protocol.md @@ -2,6 +2,8 @@ > Register a custom protocol and intercept existing protocol requests. +Process: [Main](../tutorial/quick-start.md#main-process) + An example of implementing a protocol that has the same effect as the `file://` protocol: diff --git a/docs/api/remote.md b/docs/api/remote.md index 08e86bc192..bff7f8ab77 100644 --- a/docs/api/remote.md +++ b/docs/api/remote.md @@ -2,6 +2,8 @@ > Use main process modules from the renderer process. +Process: [Renderer](../tutorial/quick-start.md#renderer-process) + The `remote` module provides a simple way to do inter-process communication (IPC) between the renderer process (web page) and the main process. diff --git a/docs/api/screen.md b/docs/api/screen.md index f366cddf24..81bee1f25f 100644 --- a/docs/api/screen.md +++ b/docs/api/screen.md @@ -2,6 +2,8 @@ > Retrieve information about screen size, displays, cursor position, etc. +Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) + You cannot require or use this module until the `ready` event of the `app` module is emitted. diff --git a/docs/api/session.md b/docs/api/session.md index 9cd629fe1d..9b77ce3403 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -2,6 +2,8 @@ > Manage browser sessions, cookies, cache, proxy settings, etc. +Process: [Main](../tutorial/quick-start.md#main-process) + The `session` module can be used to create new `Session` objects. You can also access the `session` of existing pages by using the `session` @@ -52,6 +54,8 @@ A `Session` object, the default session object of the app. > Get and set properties of a session. +Process: [Main](../tutorial/quick-start.md#main-process) + You can create a `Session` object in the `session` module: ```javascript @@ -375,6 +379,8 @@ app.on('ready', function () { > Query and modify a session's cookies. +Process: [Main](../tutorial/quick-start.md#main-process) + Instances of the `Cookies` class are accessed by using `cookies` property of a `Session`. @@ -480,6 +486,8 @@ Removes the cookies matching `url` and `name`, `callback` will called with > Intercept and modify the contents of a request at various stages of its lifetime. +Process: [Main](../tutorial/quick-start.md#main-process) + Instances of the `WebRequest` class are accessed by using the `webRequest` property of a `Session`. diff --git a/docs/api/shell.md b/docs/api/shell.md index 03f6972e3b..89ae954ad6 100644 --- a/docs/api/shell.md +++ b/docs/api/shell.md @@ -2,6 +2,8 @@ > Manage files and URLs using their default applications. +Process: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) + The `shell` module provides functions related to desktop integration. An example of opening a URL in the user's default browser: diff --git a/docs/api/system-preferences.md b/docs/api/system-preferences.md index 90fef8fec3..535ae403ef 100644 --- a/docs/api/system-preferences.md +++ b/docs/api/system-preferences.md @@ -2,6 +2,8 @@ > Get system preferences. +Process: [Main](../tutorial/quick-start.md#main-process) + ```javascript const {systemPreferences} = require('electron') console.log(systemPreferences.isDarkMode()) diff --git a/docs/api/tray.md b/docs/api/tray.md index 3ac2d54038..6353c470df 100644 --- a/docs/api/tray.md +++ b/docs/api/tray.md @@ -2,6 +2,8 @@ > Add icons and context menus to the system's notification area. +Process: [Main](../tutorial/quick-start.md#main-process) + ```javascript const {app, Menu, Tray} = require('electron') diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 4d86808136..55db42e492 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -2,6 +2,8 @@ > Render and control web pages. +Process: [Main](../tutorial/quick-start.md#main-process) + `webContents` is an [EventEmitter](https://nodejs.org/api/events.html#events_class_eventemitter). It is responsible for rendering and controlling a web page and is a property of @@ -47,6 +49,8 @@ Returns `WebContents` - A WebContents instance with the given ID. > Render and control the contents of a BrowserWindow instance. +Process: [Main](../tutorial/quick-start.md#main-process) + ### Instance Events #### Event: 'did-finish-load' @@ -1186,6 +1190,8 @@ A Debugger instance for this webContents. > An alternate transport for Chrome's remote debugging protocol. +Process: [Main](../tutorial/quick-start.md#main-process) + Chrome Developer Tools has a [special binding][rdp] available at JavaScript runtime that allows interacting with pages and instrumenting them. diff --git a/docs/api/web-frame.md b/docs/api/web-frame.md index 078ced9725..f35ea3eed3 100644 --- a/docs/api/web-frame.md +++ b/docs/api/web-frame.md @@ -2,6 +2,8 @@ > Customize the rendering of the current web page. +Process: [Renderer](../tutorial/quick-start.md#renderer-process) + An example of zooming current page to 200%. ```javascript diff --git a/docs/api/window-open.md b/docs/api/window-open.md index 2c0d9cb453..ef4b02d1b9 100644 --- a/docs/api/window-open.md +++ b/docs/api/window-open.md @@ -45,6 +45,8 @@ origin preference. > Manipulate the child browser window +Process: [Renderer](../tutorial/quick-start.md#renderer-process) + The `BrowserWindowProxy` object is returned from `window.open` and provides limited functionality with the child window.