blockquote summaries
This commit is contained in:
parent
ee190ca62a
commit
0527b17e42
32 changed files with 32 additions and 32 deletions
|
@ -1,6 +1,6 @@
|
|||
# Accelerator
|
||||
|
||||
Define keyboard shortcuts.
|
||||
> Define keyboard shortcuts.
|
||||
|
||||
Accelerators can contain multiple modifiers and key codes, combined by
|
||||
the `+` character.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# app
|
||||
|
||||
Control your application's event lifecycle.
|
||||
> Control your application's event lifecycle.
|
||||
|
||||
The following example shows how to quit the application when the last window is
|
||||
closed:
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# autoUpdater
|
||||
|
||||
Enable apps to update themselves automatically.
|
||||
> Enable apps to update themselves automatically.
|
||||
|
||||
The `autoUpdater` module provides and interface for the [Squirrel](https://github.com/Squirrel) framework.
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# BrowserWindow
|
||||
|
||||
Create and control browser windows.
|
||||
> Create and control browser windows.
|
||||
|
||||
```javascript
|
||||
// In the main process.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Supported Chrome command line switches
|
||||
|
||||
Command line switches supported by Electron.
|
||||
> Command line switches supported by Electron.
|
||||
|
||||
You can use [app.commandLine.appendSwitch][append-switch] to append them in
|
||||
your app's main script before the [ready][ready] event of [app][app] module is
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# clipboard
|
||||
|
||||
Perform copy and paste operations on the system clipboard.
|
||||
> Perform copy and paste operations on the system clipboard.
|
||||
|
||||
The following example shows how to write a string to the clipboard:
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# contentTracing
|
||||
|
||||
Debug your application using Chromium's content module.
|
||||
> Debug your application using Chromium's content module.
|
||||
|
||||
This module does not include a web interface
|
||||
so you need to open `chrome://tracing/` in a Chrome browser and load the
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# crashReporter
|
||||
|
||||
Submit crash reports to a remote server.
|
||||
> Submit crash reports to a remote server.
|
||||
|
||||
The following is an example of automatically submitting a crash report to a
|
||||
remote server:
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# desktopCapturer
|
||||
|
||||
Capture audio, video, and images from a microphone, camera, or
|
||||
> Capture audio, video, and images from a microphone, camera, or
|
||||
screen using the `getUserMedia` API.
|
||||
|
||||
```javascript
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# dialog
|
||||
|
||||
Display native system dialogs for opening and saving files, alerting, etc.
|
||||
> Display native system dialogs for opening and saving files, alerting, etc.
|
||||
|
||||
An example of showing a dialog to select multiple files and directories:
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# DownloadItem
|
||||
|
||||
Trigger file downloads from remote sources.
|
||||
> Trigger file downloads from remote sources.
|
||||
|
||||
`DownloadItem` is an EventEmitter represents a download item in Electron. It
|
||||
is used in `will-download` event of `Session` module, and allows users to
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Environment variables
|
||||
|
||||
Control application configuration and behavior without changing code.
|
||||
> Control application configuration and behavior without changing code.
|
||||
|
||||
Some behaviors of Electron are controlled by environment variables, because they
|
||||
are initialized earlier than command line and the app's code.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# `File` object
|
||||
|
||||
Use the HTML5 `File` API to work natively with files on the filesystem.
|
||||
> Use the HTML5 `File` API to work natively with files on the filesystem.
|
||||
|
||||
The DOM's File interface provides abstraction around native files in order to
|
||||
let users work on native files directly with the HTML5 file API. Electron has
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# globalShortcut
|
||||
|
||||
Detect keyboard events when the application does not have keyboard focus.
|
||||
> Detect keyboard events when the application does not have keyboard focus.
|
||||
|
||||
The `globalShortcut` module can register/unregister a global keyboard shortcut
|
||||
with the operating system so that you can customize the operations for various
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# ipcMain
|
||||
|
||||
Communicate asynchronously from the main process to renderer processes.
|
||||
> Communicate asynchronously from the main process to renderer processes.
|
||||
|
||||
The `ipcMain` module is an instance of the
|
||||
[EventEmitter](https://nodejs.org/api/events.html) class. When used in the main
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# ipcRenderer
|
||||
|
||||
Communicate asynchronously from a renderer process to the main process.
|
||||
> Communicate asynchronously from a renderer process to the main process.
|
||||
|
||||
The `ipcRenderer` module is an instance of the
|
||||
[EventEmitter](https://nodejs.org/api/events.html) class. It provides a few
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# MenuItem
|
||||
|
||||
Add items to application and context menus.
|
||||
> Add items to application and context menus.
|
||||
|
||||
See [`menu`](menu.md) for examples.
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Menu
|
||||
|
||||
Create native application menus and context menus.
|
||||
> Create native application menus and context menus.
|
||||
|
||||
This module is a main process module which can be used in a render process via
|
||||
the `remote` module.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# nativeImage
|
||||
|
||||
Create tray, dock, and application icons using PNG or JPG files.
|
||||
> Create tray, dock, and application icons using PNG or JPG files.
|
||||
|
||||
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.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# powerMonitor
|
||||
|
||||
Monitor power state changes.
|
||||
> Monitor power state changes.
|
||||
|
||||
You can only use it in the main process. You should not use this module until the `ready`
|
||||
event of the `app` module is emitted.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# powerSaveBlocker
|
||||
|
||||
Block the system from entering low-power (sleep) mode.
|
||||
> Block the system from entering low-power (sleep) mode.
|
||||
|
||||
For example:
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# process
|
||||
|
||||
Get information about the running application process.
|
||||
> Get information about the running application process.
|
||||
|
||||
The `process` object in Electron has the following differences from the one in
|
||||
upstream node:
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# protocol
|
||||
|
||||
Register a custom protocol to intercept click events from other running
|
||||
> Register a custom protocol to intercept click events from other running
|
||||
applications.
|
||||
|
||||
An example of implementing a protocol that has the same effect as the
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# remote
|
||||
|
||||
Communicate between the renderer process and the main process.
|
||||
> Communicate between the renderer process and the main process.
|
||||
|
||||
The `remote` module provides a simple way to do inter-process communication
|
||||
(IPC) between the renderer process (web page) and the main process.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# session
|
||||
|
||||
Manage browser cookies, cache, and other session data.
|
||||
> Manage browser cookies, cache, and other session data.
|
||||
|
||||
The `session` module can be used to create new `Session` objects.
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# shell
|
||||
|
||||
Manage files and URLs using their default applications.
|
||||
> Manage files and URLs using their default applications.
|
||||
|
||||
The `shell` module provides functions related to desktop integration.
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Synopsis
|
||||
|
||||
Info about Node.js and the main and renderer processes.
|
||||
> Info about Node.js and the main and renderer processes.
|
||||
|
||||
All of [Node.js's built-in modules](http://nodejs.org/api/) are available in
|
||||
Electron and third-party node modules also fully supported as well (including
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Tray
|
||||
|
||||
Add icons and context menus to the system's notification area.
|
||||
> Add icons and context menus to the system's notification area.
|
||||
|
||||
```javascript
|
||||
const electron = require('electron');
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# webContents
|
||||
|
||||
Render and control web pages using lifecycle events.
|
||||
> Render and control web pages using lifecycle events.
|
||||
|
||||
`webContents` is an
|
||||
[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter).
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# webFrame
|
||||
|
||||
Customize the rendering of the current web page.
|
||||
> Customize the rendering of the current web page.
|
||||
|
||||
An example of zooming current page to 200%.
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# The `<webview>` tag
|
||||
|
||||
Display external web content in an isolated frame and process.
|
||||
> Display external web content in an isolated frame and process.
|
||||
|
||||
Use the `webview` tag to embed 'guest' content (such as web pages) in your
|
||||
Electron app. The guest content is contained within the `webview` container.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# The `window.open` function
|
||||
|
||||
Create a new window in a web page.
|
||||
> Create a new window in a web page.
|
||||
|
||||
When `window.open` is called to create a new window in a web page, a new instance
|
||||
of `BrowserWindow` will be created for the `url` and a proxy will be returned
|
||||
|
|
Loading…
Reference in a new issue