docs: preload, node-integration, zoom-factor have been moved

This commit is contained in:
Cheng Zhao 2015-09-05 23:22:38 +08:00
parent 0b1a3f3ef3
commit 2454dccde0
2 changed files with 26 additions and 20 deletions

View file

@ -48,8 +48,6 @@ Properties `width` and `height` are required.
* `fullscreen` Boolean - Whether the window should show in fullscreen. When * `fullscreen` Boolean - Whether the window should show in fullscreen. When
set to `false` the fullscreen button will also be hidden on OS X. set to `false` the fullscreen button will also be hidden on OS X.
* `skip-taskbar` Boolean - Whether to show the window in taskbar. * `skip-taskbar` Boolean - Whether to show the window in taskbar.
* `zoom-factor` Number - The default zoom factor of the page, `3.0` represents
`300%`.
* `kiosk` Boolean - The kiosk mode. * `kiosk` Boolean - The kiosk mode.
* `title` String - Default window title. * `title` String - Default window title.
* `icon` [NativeImage](native-image.md) - The window icon, when omitted on * `icon` [NativeImage](native-image.md) - The window icon, when omitted on
@ -57,8 +55,6 @@ Properties `width` and `height` are required.
* `show` Boolean - Whether window should be shown when created. * `show` Boolean - Whether window should be shown when created.
* `frame` Boolean - Specify `false` to create a * `frame` Boolean - Specify `false` to create a
[Frameless Window](frameless-window.md). [Frameless Window](frameless-window.md).
* `node-integration` Boolean - Whether node integration is enabled. Default
is `true`.
* `accept-first-mouse` Boolean - Whether the web view accepts a single * `accept-first-mouse` Boolean - Whether the web view accepts a single
mouse-down event that simultaneously activates the window. mouse-down event that simultaneously activates the window.
* `disable-auto-hide-cursor` Boolean - Whether to hide cursor when typing. * `disable-auto-hide-cursor` Boolean - Whether to hide cursor when typing.
@ -68,10 +64,6 @@ Properties `width` and `height` are required.
than screen. than screen.
* `dark-theme` Boolean - Forces using dark theme for the window, only works on * `dark-theme` Boolean - Forces using dark theme for the window, only works on
some GTK+3 desktop environments. some GTK+3 desktop environments.
* `preload` String - Specifies a script that will be loaded before other
scripts run in the window. This script will always have access to node APIs
no matter whether node integration is turned on for the window, and the path
of `preload` script has to be absolute path.
* `transparent` Boolean - Makes the window [transparent](frameless-window.md). * `transparent` Boolean - Makes the window [transparent](frameless-window.md).
* `type` String - Specifies the type of the window, possible types are * `type` String - Specifies the type of the window, possible types are
`desktop`, `dock`, `toolbar`, `splash`, `notification`. This only works on `desktop`, `dock`, `toolbar`, `splash`, `notification`. This only works on
@ -79,11 +71,25 @@ Properties `width` and `height` are required.
* `standard-window` Boolean - Uses the OS X's standard window instead of the * `standard-window` Boolean - Uses the OS X's standard window instead of the
textured window. Defaults to `true`. textured window. Defaults to `true`.
* `web-preferences` Object - Settings of web page's features, properties: * `web-preferences` Object - Settings of web page's features, properties:
* `node-integration` Boolean - Whether node integration is enabled. Default
is `true`.
* `preload` String - Specifies a script that will be loaded before other
scripts run in the page. This script will always have access to node APIs
no matter whether node integration is turned on for the page, and the path
of `preload` script has to be absolute path.
* `partition` String - Sets the session used by the page. If `partition`
starts with `persist:`, the page will use a persistent session available to
all pages in the app with the same `partition`. if there is no `persist:`
prefix, the page will use an in-memory session. By assigning the same
`partition`, multiple pages can share the same session. If the `partition`
is unset then default session of the app will be used.
* `zoom-factor` Number - The default zoom factor of the page, `3.0` represents
`300%`.
* `javascript` Boolean * `javascript` Boolean
* `web-security` Boolean - When setting `false`, it will disable the * `web-security` Boolean - When setting `false`, it will disable the
same-origin policy (Usually using testing websites by people), and set `allow_displaying_insecure_content` same-origin policy (Usually using testing websites by people), and set
and `allow_running_insecure_content` to `true` if these two options are not `allow_displaying_insecure_content` and `allow_running_insecure_content` to
set by user. `true` if these two options are not set by user.
* `allow-displaying-insecure-content` Boolean - Allow an https page to display * `allow-displaying-insecure-content` Boolean - Allow an https page to display
content like images from http URLs. content like images from http URLs.
* `allow-running-insecure-content` Boolean - Allow a https page to run * `allow-running-insecure-content` Boolean - Allow a https page to run

View file

@ -138,16 +138,16 @@ If "on", the guest page will have web security disabled.
<webview src="http://electron.atom.io" partition="electron"></webview> <webview src="http://electron.atom.io" partition="electron"></webview>
``` ```
Sets the storage partition used by the `webview`. If the storage partition ID starts with `persist:`, Sets the session used by the page. If `partition` starts with `persist:`, the
the `webview` will use a persistent storage partition available to all `webview` in the app with page will use a persistent session available to all pages in the app with the
the same storage partition ID. if there is no `persist:` prefix, the `webview` will same `partition`. if there is no `persist:` prefix, the page will use an
use an in-memory storage partition. By assigning the same partition ID, multiple `webview` in-memory session. By assigning the same `partition`, multiple pages can share
can share the same storage partition. If the storage partition ID is unset then default storage the same session. If the `partition` is unset then default session of the app
of the app will be used. will be used.
This value can only be modified before the first navigation, since the storage partition of an active This value can only be modified before the first navigation, since the session
renderer process cannot change. Subsequent attempts to modify the value will fail with a of an active renderer process cannot change. Subsequent attempts to modify the
DOM exception. value will fail with a DOM exception.
## Methods ## Methods