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 03872ab597..f6e72b82c7 100644 --- a/docs/api/clipboard.md +++ b/docs/api/clipboard.md @@ -2,7 +2,7 @@ > Perform copy and paste operations on the system clipboard. -Processes: [Main](../tutorial/quick-start.md#main-process), [Renderer](../tutorial/quick-start.md#renderer-process) +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: 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/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 9e39d789a9..39ec5140f1 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 cf4c75133b..bdcea83e1e 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..67cf4b108e 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. diff --git a/docs/api/net.md b/docs/api/net.md index e78cddbbd8..6a6a9b1c37 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 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..53ca76b202 100644 --- a/docs/api/screen.md +++ b/docs/api/screen.md @@ -2,6 +2,9 @@ > 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..849e8bbb64 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` diff --git a/docs/api/shell.md b/docs/api/shell.md index 03f6972e3b..e5fad8659c 100644 --- a/docs/api/shell.md +++ b/docs/api/shell.md @@ -2,6 +2,9 @@ > 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 96e3eee7df..61bd21f207 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 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