diff --git a/docs/api/app.md b/docs/api/app.md index c8ddb47bd315..f86a205e6f96 100644 --- a/docs/api/app.md +++ b/docs/api/app.md @@ -523,8 +523,8 @@ This method returns `true` if the system is in Dark Mode, and `false` otherwise. * `result` Integer - Result of import. Imports the certificate in pkcs12 format into the platform certificate store. -`callback` is called with the `result` of import operation, a value of `0` indicates -success while any other value indicates failure according to chromium [net_error_list](https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h). +`callback` is called with the `result` of import operation, a value of `0` +indicates success while any other value indicates failure according to chromium [net_error_list](https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h). ### `app.commandLine.appendSwitch(switch[, value])` diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index 8dd6d2412a4a..dccae1212aa0 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -5,8 +5,11 @@ This module provides an interface for the `Squirrel` auto-updater framework. You can quickly launch a multi-platform release server for distributing your application by using one of these projects: -- [electron-release-server][electron-release-server]: *A fully featured, self-hosted release server for electron applications, compatible with auto-updater* -- [squirrel-updates-server][squirrel-updates-server]: *A simple node.js server for Squirrel.Mac and Squirrel.Windows which uses GitHub releases* +- [electron-release-server][electron-release-server]: *A fully featured, + self-hosted release server for electron applications, compatible with + auto-updater* +- [squirrel-updates-server][squirrel-updates-server]: *A simple node.js server + for Squirrel.Mac and Squirrel.Windows which uses GitHub releases* ## Platform notices diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md index 67f8c737a0cf..97dd2d972950 100644 --- a/docs/api/browser-window.md +++ b/docs/api/browser-window.md @@ -311,7 +311,8 @@ Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/d is invoked. These are typically related to keyboard media keys or browser commands, as well as the "Back" button built into some mice on Windows. -Commands are lowercased with underscores replaced with hyphens and the `APPCOMMAND_` prefix stripped off. +Commands are lowercased with underscores replaced with hyphens and the +`APPCOMMAND_` prefix stripped off. e.g. `APPCOMMAND_BROWSER_BACKWARD` is emitted as `browser-backward`. ```js @@ -677,9 +678,9 @@ window. ### `win.setSheetOffset(offset)` -Changes the attachment point for sheets on Mac OS X. By default, sheets are attached -just below the window frame, but you may want to display them beneath a HTML-rendered -toolbar. For example: +Changes the attachment point for sheets on Mac OS X. By default, sheets are +attached just below the window frame, but you may want to display them beneath +a HTML-rendered toolbar. For example: ``` var toolbarRect = document.getElementById('toolbar').getBoundingClientRect(); @@ -823,8 +824,8 @@ cleared * `description` String - a description that will be provided to Accessibility screen readers -Sets a 16 x 16 pixel overlay onto the current taskbar icon, usually used to convey some -sort of application status or to passively notify the user. +Sets a 16 x 16 pixel overlay onto the current taskbar icon, usually used to +convey some sort of application status or to passively notify the user. ### `win.setHasShadow(hasShadow)` _OS X_ diff --git a/docs/api/crash-reporter.md b/docs/api/crash-reporter.md index 64e5602474a9..9b7141e364e9 100644 --- a/docs/api/crash-reporter.md +++ b/docs/api/crash-reporter.md @@ -60,7 +60,8 @@ ID. ## crash-reporter Payload -The crash reporter will send the following data to the `submitURL` as a `multipart/form-data` `POST`: +The crash reporter will send the following data to the `submitURL` as +a `multipart/form-data` `POST`: * `ver` String - The version of Electron. * `platform` String - e.g. 'win32'. diff --git a/docs/api/dialog.md b/docs/api/dialog.md index 1cea9da119ad..3eb0292a4937 100644 --- a/docs/api/dialog.md +++ b/docs/api/dialog.md @@ -12,7 +12,8 @@ const dialog = require('electron').dialog; console.log(dialog.showOpenDialog({ properties: [ 'openFile', 'openDirectory', 'multiSelections' ]})); ``` -The Dialog is opened from Electron's main thread. If you want to use the dialog object from a renderer process, remember to access it using the remote: +The Dialog is opened from Electron's main thread. If you want to use the dialog +object from a renderer process, remember to access it using the remote: ```javascript const dialog = require('electron').remote.dialog; diff --git a/docs/api/frameless-window.md b/docs/api/frameless-window.md index 3c26a36b0329..8e1dd46ec56e 100644 --- a/docs/api/frameless-window.md +++ b/docs/api/frameless-window.md @@ -1,6 +1,9 @@ # Frameless Window -A frameless window is a window that has no [chrome](https://developer.mozilla.org/en-US/docs/Glossary/Chrome), the parts of the window, like toolbars, that are not a part of the web page. These are options on the [`BrowserWindow`](browser-window.md) class. +A frameless window is a window that has no +[chrome](https://developer.mozilla.org/en-US/docs/Glossary/Chrome), the parts of +the window, like toolbars, that are not a part of the web page. These are +options on the [`BrowserWindow`](browser-window.md) class. ## Create a frameless window @@ -38,7 +41,8 @@ var win = new BrowserWindow({ transparent: true, frame: false }); ### Limitations * You can not click through the transparent area. We are going to introduce an - API to set window shape to solve this, see [our issue](https://github.com/electron/electron/issues/1335) for details. + API to set window shape to solve this, see + [our issue](https://github.com/electron/electron/issues/1335) for details. * Transparent windows are not resizable. Setting `resizable` to `true` may make a transparent window stop working on some platforms. * The `blur` filter only applies to the web page, so there is no way to apply diff --git a/docs/api/menu-item.md b/docs/api/menu-item.md index 0029ba14dd4b..1b36432ab297 100644 --- a/docs/api/menu-item.md +++ b/docs/api/menu-item.md @@ -22,9 +22,10 @@ Create a new `MenuItem` with the following method: * `sublabel` String * `accelerator` [Accelerator](accelerator.md) * `icon` [NativeImage](native-image.md) - * `enabled` Boolean - If false, the menu item will be greyed out and unclickable. + * `enabled` Boolean - If false, the menu item will be greyed out and + unclickable. * `visible` Boolean - If false, the menu item will be entirely hidden. - * `checked` Boolean - Should only be specified for `checkbox` or `radio` type + * `checked` Boolean - Should only be specified for `checkbox` or `radio` type menu items. * `submenu` Menu - Should be specified for `submenu` type menu items. If `submenu` is specified, the `type: 'submenu'` can be omitted. If the value @@ -61,7 +62,8 @@ On OS X `role` can also have following additional values: * `help` - The submenu is a "Help" menu * `services` - The submenu is a "Services" menu -When specifying `role` on OS X, `label` and `accelerator` are the only options that will affect the MenuItem. All other options will be ignored. +When specifying `role` on OS X, `label` and `accelerator` are the only options +that will affect the MenuItem. All other options will be ignored. ## Instance Properties @@ -79,4 +81,3 @@ selected. You can add a `click` function to do additional work. A `radio` menu item will turn on its `checked` property when clicked, and will turn off that property for all adjacent items in the same menu. Again, you can add a `click` function for additional behavior. - diff --git a/docs/api/process.md b/docs/api/process.md index b2d9c765a03a..ce76eb2d99aa 100644 --- a/docs/api/process.md +++ b/docs/api/process.md @@ -10,8 +10,8 @@ upstream node: * `process.resourcesPath` String - Path to JavaScript source code. * `process.mas` Boolean - For Mac App Store build, this value is `true`, for other builds it is `undefined`. -* `process.windowsStore` Boolean - If the app is running as a Windows Store app (appx), this value is `true`, for - other builds it is `undefined`. +* `process.windowsStore` Boolean - If the app is running as a Windows Store app + (appx), this value is `true`, for other builds it is `undefined`. ## Events diff --git a/docs/api/session.md b/docs/api/session.md index ecc65f550ed0..b8ea23434cd3 100644 --- a/docs/api/session.md +++ b/docs/api/session.md @@ -447,8 +447,9 @@ The `callback` has to be called with an `response` object: * `cancel` Boolean * `responseHeaders` Object (optional) - When provided, the server is assumed to have responded with these headers. - * `statusLine` String (optional) - Should be provided when overriding `responseHeaders` - to change header status otherwise original response header's status will be used. + * `statusLine` String (optional) - Should be provided when overriding + `responseHeaders` to change header status otherwise original response + header's status will be used. #### `ses.webRequest.onResponseStarted([filter, ]listener)` diff --git a/docs/api/synopsis.md b/docs/api/synopsis.md index 015674c2ef6f..466b13828c41 100644 --- a/docs/api/synopsis.md +++ b/docs/api/synopsis.md @@ -11,8 +11,8 @@ both processes. The basic rule is: if a module is [GUI][gui] or low-level system related, then it should be only available in the main process. You need to be familiar with -the concept of [main process vs. renderer process](../tutorial/quick-start.md#the-main-process) scripts to be -able to use those modules. +the concept of [main process vs. renderer process](../tutorial/quick-start.md#the-main-process) +scripts to be able to use those modules. The main process script is just like a normal Node.js script: diff --git a/docs/api/web-contents.md b/docs/api/web-contents.md index 9acceadd360d..0eee6c5bf8bb 100644 --- a/docs/api/web-contents.md +++ b/docs/api/web-contents.md @@ -278,7 +278,8 @@ Emitted when media is paused or done playing. ### Event: 'did-change-theme-color' -Emitted when a page's theme color changes. This is usually due to encountering a meta tag: +Emitted when a page's theme color changes. This is usually due to encountering +a meta tag: ```html @@ -355,7 +356,8 @@ Returns whether web page is still loading resources. ### `webContents.isLoadingMainFrame()` -Returns whether the main frame (and not just iframes or frames within it) is still loading. +Returns whether the main frame (and not just iframes or frames within it) is +still loading. ### `webContents.isWaitingForResponse()` @@ -525,9 +527,10 @@ Inserts `text` to the focused element. uppercase letter followed by a lowercase or non-letter. Accepts several other intra-word matches, defaults to `false`. -Starts a request to find all matches for the `text` in the web page and returns an `Integer` -representing the request id used for the request. The result of the request can be -obtained by subscribing to [`found-in-page`](web-contents.md#event-found-in-page) event. +Starts a request to find all matches for the `text` in the web page and returns +an `Integer` representing the request id used for the request. The result of +the request can be obtained by subscribing to +[`found-in-page`](web-contents.md#event-found-in-page) event. ### `webContents.stopFindInPage(action)` diff --git a/docs/api/web-view-tag.md b/docs/api/web-view-tag.md index c77d3c690b85..214f93dbad6f 100644 --- a/docs/api/web-view-tag.md +++ b/docs/api/web-view-tag.md @@ -47,17 +47,17 @@ and displays a "loading..." message during the load time: ## CSS Styling Notes -Please note that the `webview` tag's style uses `display:flex;` internally to -ensure the child `object` element fills the full height and width of its `webview` -container when used with traditional and flexbox layouts (since v0.36.11). Please -do not overwrite the default `display:flex;` CSS property, unless specifying +Please note that the `webview` tag's style uses `display:flex;` internally to +ensure the child `object` element fills the full height and width of its `webview` +container when used with traditional and flexbox layouts (since v0.36.11). Please +do not overwrite the default `display:flex;` CSS property, unless specifying `display:inline-flex;` for inline layout. -`webview` has issues being hidden using the `hidden` attribute or using `display: none;`. -It can cause unusual rendering behaviour within its child `browserplugin` object -and the web page is reloaded, when the `webview` is un-hidden, as opposed to just -becoming visible again. The recommended approach is to hide the `webview` using -CSS by zeroing the `width` & `height` and allowing the element to shrink to the 0px +`webview` has issues being hidden using the `hidden` attribute or using `display: none;`. +It can cause unusual rendering behaviour within its child `browserplugin` object +and the web page is reloaded, when the `webview` is un-hidden, as opposed to just +becoming visible again. The recommended approach is to hide the `webview` using +CSS by zeroing the `width` & `height` and allowing the element to shrink to the 0px dimensions via `flex`. ```html @@ -70,7 +70,7 @@ dimensions via `flex`. webview.hide { flex: 0 1; width: 0px; - height: 0px; + height: 0px; } ``` diff --git a/docs/development/build-instructions-osx.md b/docs/development/build-instructions-osx.md index 02bdb72e2279..b703a75897d9 100644 --- a/docs/development/build-instructions-osx.md +++ b/docs/development/build-instructions-osx.md @@ -22,8 +22,8 @@ $ git clone https://github.com/electron/electron.git ## Bootstrapping The bootstrap script will download all necessary build dependencies and create -the build project files. Notice that we're using [ninja](https://ninja-build.org/) to build Electron so -there is no Xcode project generated. +the build project files. Notice that we're using [ninja](https://ninja-build.org/) +to build Electron so there is no Xcode project generated. ```bash $ cd electron diff --git a/docs/development/build-instructions-windows.md b/docs/development/build-instructions-windows.md index 73526b362584..3f94a18393cf 100644 --- a/docs/development/build-instructions-windows.md +++ b/docs/development/build-instructions-windows.md @@ -11,7 +11,8 @@ Follow the guidelines below for building Electron on Windows. * [Node.js](http://nodejs.org/download/) * [Git](http://git-scm.com) -If you don't currently have a Windows installation, [modern.ie](https://www.modern.ie/en-us/virtualization-tools#downloads) +If you don't currently have a Windows installation, +[modern.ie](https://www.modern.ie/en-us/virtualization-tools#downloads) has timebombed versions of Windows that you can use to build Electron. Building Electron is done entirely with command-line scripts and cannot be done diff --git a/docs/development/build-system-overview.md b/docs/development/build-system-overview.md index 61b88e14078c..bc27c1932fa6 100644 --- a/docs/development/build-system-overview.md +++ b/docs/development/build-system-overview.md @@ -1,7 +1,8 @@ # Build System Overview -Electron uses [gyp](https://gyp.gsrc.io/) for project generation and [ninja](https://ninja-build.org/) for building. Project -configurations can be found in the `.gyp` and `.gypi` files. +Electron uses [gyp](https://gyp.gsrc.io/) for project generation and +[ninja](https://ninja-build.org/) for building. Project configurations can +be found in the `.gyp` and `.gypi` files. ## Gyp Files diff --git a/docs/development/coding-style.md b/docs/development/coding-style.md index baf2a2cce7de..1840700f5237 100644 --- a/docs/development/coding-style.md +++ b/docs/development/coding-style.md @@ -45,8 +45,10 @@ Electron APIs uses the same capitalization scheme as Node.js: - When the module itself is a class like `BrowserWindow`, use `CamelCase`. - When the module is a set of APIs, like `globalShortcut`, use `mixedCase`. -- When the API is a property of object, and it is complex enough to be in a separate chapter like `win.webContents`, use `mixedCase`. -- For other non-module APIs, use natural titles, like ` Tag` or `Process Object`. +- When the API is a property of object, and it is complex enough to be in a + separate chapter like `win.webContents`, use `mixedCase`. +- For other non-module APIs, use natural titles, like ` Tag` or + `Process Object`. When creating a new API, it is preferred to use getters and setters instead of jQuery's one-function style. For example, `.getText()` and `.setText(text)` diff --git a/docs/faq/electron-faq.md b/docs/faq/electron-faq.md index 41b301d71981..02d72744e657 100644 --- a/docs/faq/electron-faq.md +++ b/docs/faq/electron-faq.md @@ -77,8 +77,8 @@ app.on('ready', function() { ## I can not use jQuery/RequireJS/Meteor/AngularJS in Electron. Due to the Node.js integration of Electron, there are some extra symbols -inserted into the DOM like `module`, `exports`, `require`. This causes problems for -some libraries since they want to insert the symbols with the same names. +inserted into the DOM like `module`, `exports`, `require`. This causes problems +for some libraries since they want to insert the symbols with the same names. To solve this, you can turn off node integration in Electron: diff --git a/docs/tutorial/debugging-main-process.md b/docs/tutorial/debugging-main-process.md index ee7fc4c5fa47..714b7100cf47 100644 --- a/docs/tutorial/debugging-main-process.md +++ b/docs/tutorial/debugging-main-process.md @@ -68,9 +68,10 @@ $ ELECTRON_RUN_AS_NODE=true path/to/electron.exe node_modules/node-inspector/bin ### 7. Load the debugger UI -Open http://127.0.0.1:8080/debug?ws=127.0.0.1:8080&port=5858 in the Chrome browser. You may have to click pause if starting with debug-brk to see the entry line. +Open http://127.0.0.1:8080/debug?ws=127.0.0.1:8080&port=5858 in the Chrome +browser. You may have to click pause if starting with debug-brk to see the +entry line. [node-inspector]: https://github.com/node-inspector/node-inspector [node-gyp-required-tools]: https://github.com/nodejs/node-gyp#installation [how-to-install-native-modules]: using-native-node-modules.md#how-to-install-native-modules - diff --git a/docs/tutorial/desktop-environment-integration.md b/docs/tutorial/desktop-environment-integration.md index 1186918799b9..110d2917ab47 100644 --- a/docs/tutorial/desktop-environment-integration.md +++ b/docs/tutorial/desktop-environment-integration.md @@ -53,8 +53,7 @@ GNOME, KDE. ### OS X Notifications are straight-forward on OS X, you should however be aware of -[Apple's Human Interface guidelines regarding -notifications](https://developer.apple.com/library/mac/documentation/UserExperience/Conceptual/OSXHIGuidelines/NotificationCenter.html). +[Apple's Human Interface guidelines regarding notifications](https://developer.apple.com/library/mac/documentation/UserExperience/Conceptual/OSXHIGuidelines/NotificationCenter.html). Note that notifications are limited to 256 bytes in size - and will be truncated if you exceed that limit. diff --git a/docs/tutorial/quick-start.md b/docs/tutorial/quick-start.md index 2a41d6356a89..ddbda3782449 100644 --- a/docs/tutorial/quick-start.md +++ b/docs/tutorial/quick-start.md @@ -147,8 +147,8 @@ working as expected. ### electron-prebuilt -If you've installed `electron-prebuilt` globally with `npm`, then you will only need -to run the following in your app's source directory: +If you've installed `electron-prebuilt` globally with `npm`, then you will only +need to run the following in your app's source directory: ```bash electron .