Merge pull request #6576 from electron/browser-window-proxy-docs

Fix BrowserWindowProxy documentation
This commit is contained in:
Cheng Zhao 2016-07-25 16:55:49 +09:00 committed by GitHub
commit 729b84f2ca

View file

@ -10,8 +10,8 @@ The proxy has limited standard functionality implemented to be
compatible with traditional web pages. For full control of the new 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.
The newly created `BrowserWindow` will inherit parent window's options by The newly created `BrowserWindow` will inherit the parent window's options by
default, to override inherited options you can set them in the `features` default. To override inherited options you can set them in the `features`
string. string.
### `window.open(url[, frameName][, features])` ### `window.open(url[, frameName][, features])`
@ -45,33 +45,33 @@ limited functionality with the child window.
The `BrowserWindowProxy` object has the following instance methods: The `BrowserWindowProxy` object has the following instance methods:
#### `BrowserWindowProxy.blur()` #### `win.blur()`
Removes focus from the child window. Removes focus from the child window.
#### `BrowserWindowProxy.close()` #### `win.close()`
Forcefully closes the child window without calling its unload event. Forcefully closes the child window without calling its unload event.
#### `BrowserWindowProxy.closed` #### `win.closed`
Set to true after the child window gets closed. Set to true after the child window gets closed.
#### `BrowserWindowProxy.eval(code)` #### `win.eval(code)`
* `code` String * `code` String
Evaluates the code in the child window. Evaluates the code in the child window.
#### `BrowserWindowProxy.focus()` #### `win.focus()`
Focuses the child window (brings the window to front). Focuses the child window (brings the window to front).
#### `BrowserWindowProxy.print()` #### `win.print()`
Invokes the print dialog on the child window. Invokes the print dialog on the child window.
#### `BrowserWindowProxy.postMessage(message, targetOrigin)` #### `win.postMessage(message, targetOrigin)`
* `message` String * `message` String
* `targetOrigin` String * `targetOrigin` String