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

Standardize window-open

Browse source
This commit is contained in:
Jessica Lord 2015-08-28 23:21:09 -07:00
parent 8d40714f78
commit 955ae78e33
1 changed files with 19 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
docs/api/window-open.md
View file

@ -1,22 +1,22 @@
# `window.open` function # The `window.open` function
When `window.open` is called to create a new window in web page, a new instance 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 of `BrowserWindow` will be created for the `url` and a proxy will be returned
to `window.open` to let the page have limited control over it. to `window.open` to let the page have limited control over it.
The proxy only has some limited standard functionality implemented to be The proxy has limited standard functionality implemented to be
compatible with traditional web pages, for full control of the created window compatible with traditional web pages. For full control of the new window
you should create a `BrowserWindow` directly. you should create a `BrowserWindow` directly.
## window.open(url, [frameName[, features]]) ### `window.open(url[, frameName][, features])`
* `url` String * `url` String
* `frameName` String * `frameName` String (optional)
* `features` String * `features` String (optional)
Creates a new window and returns an instance of `BrowserWindowProxy` class. Creates a new window and returns an instance of `BrowserWindowProxy` class.
## window.opener.postMessage(message, targetOrigin) ### `window.opener.postMessage(message, targetOrigin)`
* `message` String * `message` String
* `targetOrigin` String * `targetOrigin` String
@ -26,29 +26,32 @@ origin preference.
## Class: BrowserWindowProxy ## Class: BrowserWindowProxy
### BrowserWindowProxy.blur() The `BrowserWindowProxy` object is returned from `window.open` and provides
limited functionality with the child window.
### `BrowserWindowProxy.blur()`
Removes focus from the child window. Removes focus from the child window.
### BrowserWindowProxy.close() ### `BrowserWindowProxy.close()`
Forcefully closes the child window without calling its unload event. Forcefully closes the child window without calling its unload event.
### BrowserWindowProxy.closed ### `BrowserWindowProxy.closed`
Set to true after the child window gets closed. Set to true after the child window gets closed.
### BrowserWindowProxy.eval(code) ### `BrowserWindowProxy.eval(code)`
* `code` String * `code` String
Evaluates the code in the child window. Evaluates the code in the child window.
### BrowserWindowProxy.focus() ### `BrowserWindowProxy.focus()`
Focuses the child window (brings the window to front). Focuses the child window (brings the window to front).
### BrowserWindowProxy.postMessage(message, targetOrigin) ### `BrowserWindowProxy.postMessage(message, targetOrigin)`
* `message` String * `message` String
* `targetOrigin` String * `targetOrigin` String
@ -57,4 +60,4 @@ Sends a message to the child window with the specified origin or `*` for no
origin preference. origin preference.
In addition to these methods, the child window implements `window.opener` object In addition to these methods, the child window implements `window.opener` object
with no properties and a single method: with no properties and a single method.