mirrors/electron
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: tidy up docs markdown (#26666)

Browse source
This commit is contained in:
David Sanders 2020-11-24 18:52:46 -08:00 committed by GitHub
parent 6761814f14
commit 87e20f2b97
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
docs/api/web-contents.md
View file

@ -195,29 +195,30 @@ myBrowserWindow.webContents.on('new-window', (event, url, frameName, disposition
#### Event: 'did-create-window' #### Event: 'did-create-window'
Returns: Returns:
* `window` BrowserWindow * `window` BrowserWindow
* `details` Object * `details` Object
* `url` String - URL for the created window. * `url` String - URL for the created window.
* `frameName` String - Name given to the created window in the * `frameName` String - Name given to the created window in the
`window.open()` call. `window.open()` call.
* `options` BrowserWindowConstructorOptions - The options used to create the * `options` BrowserWindowConstructorOptions - The options used to create the
BrowserWindow. They are merged in increasing precedence: options inherited BrowserWindow. They are merged in increasing precedence: options inherited
from the parent, parsed options from the `features` string from from the parent, parsed options from the `features` string from
`window.open()`, and options given by `window.open()`, and options given by
[`webContents.setWindowOpenHandler`](web-contents.md#contentssetwindowopenhandlerhandler). [`webContents.setWindowOpenHandler`](web-contents.md#contentssetwindowopenhandlerhandler).
Unrecognized options are not filtered out. Unrecognized options are not filtered out.
* `additionalFeatures` String[] - The non-standard features (features not * `additionalFeatures` String[] - The non-standard features (features not
handled Chromium or Electron) _Deprecated_ handled Chromium or Electron) _Deprecated_
* `referrer` [Referrer](structures/referrer.md) - The referrer that will be * `referrer` [Referrer](structures/referrer.md) - The referrer that will be
passed to the new window. May or may not result in the `Referer` header passed to the new window. May or may not result in the `Referer` header
being sent, depending on the referrer policy. being sent, depending on the referrer policy.
* `postBody` [PostBody](structures/post-body.md) (optional) - The post data * `postBody` [PostBody](structures/post-body.md) (optional) - The post data
that will be sent to the new window, along with the appropriate headers that will be sent to the new window, along with the appropriate headers
that will be set. If no post data is to be sent, the value will be `null`. that will be set. If no post data is to be sent, the value will be `null`.
Only defined when the window is being created by a form that set Only defined when the window is being created by a form that set
`target=_blank`. `target=_blank`.
* `disposition` String - Can be `default`, `foreground-tab`, * `disposition` String - Can be `default`, `foreground-tab`,
`background-tab`, `new-window`, `save-to-disk` and `other`. `background-tab`, `new-window`, `save-to-disk` and `other`.
Emitted _after_ successful creation of a window via `window.open` in the renderer. Emitted _after_ successful creation of a window via `window.open` in the renderer.
Not emitted if the creation of the window is canceled from Not emitted if the creation of the window is canceled from