2015-08-20 13:17:53 +00:00
|
|
|
|
# BrowserWindow
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-04-21 22:39:12 +00:00
|
|
|
|
> Create and control browser windows.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
```javascript
|
2015-12-10 20:48:52 +00:00
|
|
|
|
// In the main process.
|
2016-06-13 13:11:40 +00:00
|
|
|
|
const {BrowserWindow} = require('electron')
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-26 01:39:25 +00:00
|
|
|
|
// Or use `remote` from the renderer process.
|
|
|
|
|
// const {BrowserWindow} = require('electron').remote
|
2015-12-10 20:48:52 +00:00
|
|
|
|
|
2016-06-13 13:11:40 +00:00
|
|
|
|
let win = new BrowserWindow({width: 800, height: 600})
|
2016-05-04 17:59:02 +00:00
|
|
|
|
win.on('closed', () => {
|
2016-06-13 13:11:40 +00:00
|
|
|
|
win = null
|
|
|
|
|
})
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-08-19 05:20:55 +00:00
|
|
|
|
// Load a remote URL
|
2016-06-13 13:11:40 +00:00
|
|
|
|
win.loadURL('https://github.com')
|
2016-08-19 05:20:55 +00:00
|
|
|
|
|
|
|
|
|
// Or load a local HTML file
|
|
|
|
|
win.loadURL(`file://${__dirname}/app/index.html`)
|
2013-08-14 22:43:35 +00:00
|
|
|
|
```
|
|
|
|
|
|
2016-06-13 13:11:40 +00:00
|
|
|
|
## Frameless window
|
|
|
|
|
|
|
|
|
|
To create a window without chrome, or a transparent window in arbitrary shape,
|
|
|
|
|
you can use the [Frameless Window](frameless-window.md) API.
|
|
|
|
|
|
|
|
|
|
## Showing window gracefully
|
|
|
|
|
|
|
|
|
|
When loading a page in window directly, users will see the progress of loading
|
|
|
|
|
page, which is not good experience for native app. To make the window display
|
|
|
|
|
without visual flash, there are two solutions for different situations.
|
|
|
|
|
|
|
|
|
|
### Using `ready-to-show` event
|
|
|
|
|
|
|
|
|
|
While loading the page, the `ready-to-show` event will be emitted when renderer
|
|
|
|
|
process has done drawing for the first time, showing window after this event
|
|
|
|
|
will have no visual flash:
|
|
|
|
|
|
|
|
|
|
```javascript
|
2016-07-26 01:39:25 +00:00
|
|
|
|
const {BrowserWindow} = require('electron')
|
2016-06-13 13:11:40 +00:00
|
|
|
|
let win = new BrowserWindow({show: false})
|
2016-06-13 13:19:44 +00:00
|
|
|
|
win.once('ready-to-show', () => {
|
2016-06-13 13:11:40 +00:00
|
|
|
|
win.show()
|
|
|
|
|
})
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
This is event is usually emitted after the `did-finish-load` event, but for
|
|
|
|
|
pages with many remote resources, it may be emitted before the `did-finish-load`
|
|
|
|
|
event.
|
|
|
|
|
|
|
|
|
|
### Setting `backgroundColor`
|
|
|
|
|
|
|
|
|
|
For a complex app, the `ready-to-show` event could be emitted too late, making
|
|
|
|
|
the app feel slow. In this case, it is recommended to show the window
|
|
|
|
|
immediately, and use a `backgroundColor` close to your app's background:
|
|
|
|
|
|
|
|
|
|
```javascript
|
2016-07-26 01:39:25 +00:00
|
|
|
|
const {BrowserWindow} = require('electron')
|
|
|
|
|
|
2016-06-13 13:11:40 +00:00
|
|
|
|
let win = new BrowserWindow({backgroundColor: '#2e2c29'})
|
|
|
|
|
win.loadURL('https://github.com')
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Note that even for apps that use `ready-to-show` event, it is still recommended
|
|
|
|
|
to set `backgroundColor` to make app feel more native.
|
2013-09-09 06:52:46 +00:00
|
|
|
|
|
2016-06-20 02:06:48 +00:00
|
|
|
|
## Parent and child windows
|
|
|
|
|
|
|
|
|
|
By using `parent` option, you can create child windows:
|
|
|
|
|
|
|
|
|
|
```javascript
|
2016-07-26 01:39:25 +00:00
|
|
|
|
const {BrowserWindow} = require('electron')
|
|
|
|
|
|
2016-06-20 02:06:48 +00:00
|
|
|
|
let top = new BrowserWindow()
|
|
|
|
|
let child = new BrowserWindow({parent: top})
|
2016-07-26 01:39:25 +00:00
|
|
|
|
child.show()
|
|
|
|
|
top.show()
|
2016-06-20 02:06:48 +00:00
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
The `child` window will always show on top of the `top` window.
|
|
|
|
|
|
|
|
|
|
### Modal windows
|
|
|
|
|
|
2016-06-20 07:00:38 +00:00
|
|
|
|
A modal window is a child window that disables parent window, to create a modal
|
|
|
|
|
window, you have to set both `parent` and `modal` options:
|
2016-06-20 02:06:48 +00:00
|
|
|
|
|
|
|
|
|
```javascript
|
2016-07-26 01:39:25 +00:00
|
|
|
|
const {BrowserWindow} = require('electron')
|
|
|
|
|
|
2016-06-20 07:00:38 +00:00
|
|
|
|
let child = new BrowserWindow({parent: top, modal: true, show: false})
|
2016-06-20 02:06:48 +00:00
|
|
|
|
child.loadURL('https://github.com')
|
|
|
|
|
child.once('ready-to-show', () => {
|
|
|
|
|
child.show()
|
|
|
|
|
})
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Platform notices
|
|
|
|
|
|
2016-06-20 07:00:38 +00:00
|
|
|
|
* On macOS the child windows will keep the relative position to parent window
|
2016-06-20 02:06:48 +00:00
|
|
|
|
when parent window moves, while on Windows and Linux child windows will not
|
|
|
|
|
move.
|
|
|
|
|
* On Windows it is not supported to change parent window dynamically.
|
|
|
|
|
* On Linux the type of modal windows will be changed to `dialog`.
|
2016-06-20 07:00:38 +00:00
|
|
|
|
* On Linux many desktop environments do not support hiding a modal window.
|
2016-06-20 02:06:48 +00:00
|
|
|
|
|
2013-08-14 22:43:35 +00:00
|
|
|
|
## Class: BrowserWindow
|
|
|
|
|
|
2013-08-29 14:37:51 +00:00
|
|
|
|
`BrowserWindow` is an
|
|
|
|
|
[EventEmitter](http://nodejs.org/api/events.html#events_class_events_eventemitter).
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
It creates a new `BrowserWindow` with native properties as set by the `options`.
|
|
|
|
|
|
2015-11-21 04:42:40 +00:00
|
|
|
|
### `new BrowserWindow([options])`
|
2015-08-20 13:17:53 +00:00
|
|
|
|
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `options` Object
|
|
|
|
|
* `width` Integer - Window's width in pixels. Default is `800`.
|
|
|
|
|
* `height` Integer - Window's height in pixels. Default is `600`.
|
2016-05-23 16:17:43 +00:00
|
|
|
|
* `x` Integer (**required** if y is used) - Window's left offset from screen.
|
|
|
|
|
Default is to center the window.
|
|
|
|
|
* `y` Integer (**required** if x is used) - Window's top offset from screen.
|
|
|
|
|
Default is to center the window.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `useContentSize` Boolean - The `width` and `height` would be used as web
|
|
|
|
|
page's size, which means the actual window's size will include window
|
|
|
|
|
frame's size and be slightly larger. Default is `false`.
|
|
|
|
|
* `center` Boolean - Show window in the center of the screen.
|
|
|
|
|
* `minWidth` Integer - Window's minimum width. Default is `0`.
|
|
|
|
|
* `minHeight` Integer - Window's minimum height. Default is `0`.
|
|
|
|
|
* `maxWidth` Integer - Window's maximum width. Default is no limit.
|
|
|
|
|
* `maxHeight` Integer - Window's maximum height. Default is no limit.
|
|
|
|
|
* `resizable` Boolean - Whether window is resizable. Default is `true`.
|
2016-01-19 15:07:51 +00:00
|
|
|
|
* `movable` Boolean - Whether window is movable. This is not implemented
|
|
|
|
|
on Linux. Default is `true`.
|
|
|
|
|
* `minimizable` Boolean - Whether window is minimizable. This is not
|
|
|
|
|
implemented on Linux. Default is `true`.
|
2016-01-22 22:31:59 +00:00
|
|
|
|
* `maximizable` Boolean - Whether window is maximizable. This is not
|
|
|
|
|
implemented on Linux. Default is `true`.
|
2016-01-19 15:07:51 +00:00
|
|
|
|
* `closable` Boolean - Whether window is closable. This is not implemented
|
|
|
|
|
on Linux. Default is `true`.
|
2016-06-13 08:10:28 +00:00
|
|
|
|
* `focusable` Boolean - Whether the window can be focused. Default is
|
2016-06-13 08:24:45 +00:00
|
|
|
|
`true`. On Windows setting `focusable: false` also implies setting
|
2016-06-13 08:53:08 +00:00
|
|
|
|
`skipTaskbar: true`. On Linux setting `focusable: false` makes the window
|
|
|
|
|
stop interacting with wm, so the window will always stay on top in all
|
|
|
|
|
workspaces.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `alwaysOnTop` Boolean - Whether the window should always stay on top of
|
|
|
|
|
other windows. Default is `false`.
|
|
|
|
|
* `fullscreen` Boolean - Whether the window should show in fullscreen. When
|
2016-05-11 22:14:17 +00:00
|
|
|
|
explicitly set to `false` the fullscreen button will be hidden or disabled
|
2016-06-18 13:26:26 +00:00
|
|
|
|
on macOS. Default is `false`.
|
2016-05-30 00:12:16 +00:00
|
|
|
|
* `fullscreenable` Boolean - Whether the window can be put into fullscreen
|
2016-06-18 13:26:26 +00:00
|
|
|
|
mode. On macOS, also whether the maximize/zoom button should toggle full
|
2016-05-26 17:06:42 +00:00
|
|
|
|
screen mode or maximize window. Default is `true`.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `skipTaskbar` Boolean - Whether to show the window in taskbar. Default is
|
|
|
|
|
`false`.
|
|
|
|
|
* `kiosk` Boolean - The kiosk mode. Default is `false`.
|
|
|
|
|
* `title` String - Default window title. Default is `"Electron"`.
|
2016-05-20 10:58:47 +00:00
|
|
|
|
* `icon` [NativeImage](native-image.md) - The window icon. On Windows it is
|
|
|
|
|
recommended to use `ICO` icons to get best visual effects, you can also
|
|
|
|
|
leave it undefined so the executable's icon will be used.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `show` Boolean - Whether window should be shown when created. Default is
|
|
|
|
|
`true`.
|
|
|
|
|
* `frame` Boolean - Specify `false` to create a
|
|
|
|
|
[Frameless Window](frameless-window.md). Default is `true`.
|
2016-06-20 07:00:38 +00:00
|
|
|
|
* `parent` BrowserWindow - Specify parent window. Default is `null`.
|
|
|
|
|
* `modal` Boolean - Whether this is a modal window. This only works when the
|
|
|
|
|
window is a child window. Default is `false`.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `acceptFirstMouse` Boolean - Whether the web view accepts a single
|
2016-01-11 05:43:24 +00:00
|
|
|
|
mouse-down event that simultaneously activates the window. Default is
|
|
|
|
|
`false`.
|
|
|
|
|
* `disableAutoHideCursor` Boolean - Whether to hide cursor when typing.
|
|
|
|
|
Default is `false`.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `autoHideMenuBar` Boolean - Auto hide the menu bar unless the `Alt`
|
|
|
|
|
key is pressed. Default is `false`.
|
|
|
|
|
* `enableLargerThanScreen` Boolean - Enable the window to be resized larger
|
|
|
|
|
than screen. Default is `false`.
|
|
|
|
|
* `backgroundColor` String - Window's background color as Hexadecimal value,
|
2016-01-23 00:20:18 +00:00
|
|
|
|
like `#66CD00` or `#FFF` or `#80FFFFFF` (alpha is supported). Default is
|
2016-04-03 04:55:33 +00:00
|
|
|
|
`#FFF` (white).
|
2016-01-23 00:15:49 +00:00
|
|
|
|
* `hasShadow` Boolean - Whether window should have a shadow. This is only
|
2016-06-18 13:26:26 +00:00
|
|
|
|
implemented on macOS. Default is `true`.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `darkTheme` Boolean - Forces using dark theme for the window, only works on
|
|
|
|
|
some GTK+3 desktop environments. Default is `false`.
|
|
|
|
|
* `transparent` Boolean - Makes the window [transparent](frameless-window.md).
|
|
|
|
|
Default is `false`.
|
|
|
|
|
* `type` String - The type of window, default is normal window. See more about
|
2016-01-15 12:43:44 +00:00
|
|
|
|
this below.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `titleBarStyle` String - The style of window title bar. See more about this
|
2016-01-15 12:43:44 +00:00
|
|
|
|
below.
|
2016-07-09 12:52:45 +00:00
|
|
|
|
* `thickFrame` Boolean - Use `WS_THICKFRAME` style for frameless windows on
|
|
|
|
|
Windows, which adds standard window frame. Setting it to `false` will remove
|
|
|
|
|
window shadow and window animations. Default is `true`.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `webPreferences` Object - Settings of web page's features. See more about
|
2016-01-15 12:43:44 +00:00
|
|
|
|
this below.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
|
2016-05-06 05:21:19 +00:00
|
|
|
|
When setting minimum or maximum window size with `minWidth`/`maxWidth`/
|
2016-07-13 04:21:25 +00:00
|
|
|
|
`minHeight`/`maxHeight`, it only constrains the users. It won't prevent you from
|
2016-05-06 05:21:19 +00:00
|
|
|
|
passing a size that does not follow size constraints to `setBounds`/`setSize` or
|
|
|
|
|
to the constructor of `BrowserWindow`.
|
|
|
|
|
|
2016-07-13 04:21:25 +00:00
|
|
|
|
The possible values and behaviors of the `type` option are platform dependent.
|
|
|
|
|
Possible values are:
|
2016-01-07 06:23:21 +00:00
|
|
|
|
|
|
|
|
|
* On Linux, possible types are `desktop`, `dock`, `toolbar`, `splash`,
|
|
|
|
|
`notification`.
|
2016-06-18 13:26:26 +00:00
|
|
|
|
* On macOS, possible types are `desktop`, `textured`.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* The `textured` type adds metal gradient appearance
|
|
|
|
|
(`NSTexturedBackgroundWindowMask`).
|
|
|
|
|
* The `desktop` type places the window at the desktop background window level
|
2015-11-20 05:06:42 +00:00
|
|
|
|
(`kCGDesktopWindowLevel - 1`). Note that desktop window will not receive
|
|
|
|
|
focus, keyboard or mouse events, but you can use `globalShortcut` to receive
|
|
|
|
|
input sparingly.
|
2016-07-12 18:02:14 +00:00
|
|
|
|
* On Windows, possible type is `toolbar`.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
|
2016-08-18 05:42:10 +00:00
|
|
|
|
Possible values of the `titleBarStyle` option are:
|
2016-01-07 06:23:21 +00:00
|
|
|
|
|
|
|
|
|
* `default` or not specified, results in the standard gray opaque Mac title
|
2015-09-14 12:15:41 +00:00
|
|
|
|
bar.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `hidden` results in a hidden title bar and a full size content window, yet
|
2015-09-14 12:15:41 +00:00
|
|
|
|
the title bar still has the standard window controls ("traffic lights") in
|
|
|
|
|
the top left.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `hidden-inset` results in a hidden title bar with an alternative look
|
2015-09-14 12:15:41 +00:00
|
|
|
|
where the traffic light buttons are slightly more inset from the window edge.
|
2016-08-15 19:36:57 +00:00
|
|
|
|
It is not supported on macOS 10.9 Mavericks, where it falls back to `hidden`.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
|
2016-07-13 04:21:25 +00:00
|
|
|
|
The `webPreferences` option is an object that can have the following properties:
|
2016-01-07 06:23:21 +00:00
|
|
|
|
|
|
|
|
|
* `nodeIntegration` 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 or off. The value should
|
|
|
|
|
be the absolute file path to the script.
|
|
|
|
|
When node integration is turned off, the preload script can reintroduce
|
|
|
|
|
Node global symbols back to the global scope. See example
|
|
|
|
|
[here](process.md#event-loaded).
|
2016-01-12 02:59:45 +00:00
|
|
|
|
* `session` [Session](session.md#class-session) - Sets the session used by the
|
|
|
|
|
page. Instead of passing the Session object directly, you can also choose to
|
|
|
|
|
use the `partition` option instead, which accepts a partition string. When
|
2016-07-13 04:21:25 +00:00
|
|
|
|
both `session` and `partition` are provided, `session` will be preferred.
|
2016-01-12 02:59:45 +00:00
|
|
|
|
Default is the default session.
|
|
|
|
|
* `partition` String - Sets the session used by the page according to the
|
|
|
|
|
session's partition string. If `partition` starts with `persist:`, the page
|
|
|
|
|
will use a persistent session available to all pages in the app with the
|
2016-07-13 04:21:25 +00:00
|
|
|
|
same `partition`. If there is no `persist:` prefix, the page will use an
|
2016-01-12 02:59:45 +00:00
|
|
|
|
in-memory session. By assigning the same `partition`, multiple pages can share
|
|
|
|
|
the same session. Default is the default session.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `zoomFactor` Number - The default zoom factor of the page, `3.0` represents
|
|
|
|
|
`300%`. Default is `1.0`.
|
|
|
|
|
* `javascript` Boolean - Enables JavaScript support. Default is `true`.
|
2016-07-13 04:21:25 +00:00
|
|
|
|
* `webSecurity` Boolean - When `false`, it will disable the
|
|
|
|
|
same-origin policy (usually using testing websites by people), and set
|
2016-01-07 06:23:21 +00:00
|
|
|
|
`allowDisplayingInsecureContent` and `allowRunningInsecureContent` to
|
|
|
|
|
`true` if these two options are not set by user. Default is `true`.
|
|
|
|
|
* `allowDisplayingInsecureContent` Boolean - Allow an https page to display
|
|
|
|
|
content like images from http URLs. Default is `false`.
|
2016-07-13 04:21:25 +00:00
|
|
|
|
* `allowRunningInsecureContent` Boolean - Allow an https page to run
|
2016-01-07 06:23:21 +00:00
|
|
|
|
JavaScript, CSS or plugins from http URLs. Default is `false`.
|
|
|
|
|
* `images` Boolean - Enables image support. Default is `true`.
|
|
|
|
|
* `textAreasAreResizable` Boolean - Make TextArea elements resizable. Default
|
|
|
|
|
is `true`.
|
|
|
|
|
* `webgl` Boolean - Enables WebGL support. Default is `true`.
|
|
|
|
|
* `webaudio` Boolean - Enables WebAudio support. Default is `true`.
|
|
|
|
|
* `plugins` Boolean - Whether plugins should be enabled. Default is `false`.
|
|
|
|
|
* `experimentalFeatures` Boolean - Enables Chromium's experimental features.
|
|
|
|
|
Default is `false`.
|
|
|
|
|
* `experimentalCanvasFeatures` Boolean - Enables Chromium's experimental
|
|
|
|
|
canvas features. Default is `false`.
|
2016-05-06 05:57:43 +00:00
|
|
|
|
* `scrollBounce` Boolean - Enables scroll bounce (rubber banding) effect on
|
2016-06-18 13:26:26 +00:00
|
|
|
|
macOS. Default is `false`.
|
2016-01-07 06:23:21 +00:00
|
|
|
|
* `blinkFeatures` String - A list of feature strings separated by `,`, like
|
2016-06-07 20:59:30 +00:00
|
|
|
|
`CSSVariables,KeyboardEventKey` to enable. The full list of supported feature
|
2016-06-07 20:56:33 +00:00
|
|
|
|
strings can be found in the [RuntimeEnabledFeatures.in][blink-feature-string]
|
|
|
|
|
file.
|
2016-06-07 20:59:30 +00:00
|
|
|
|
* `disableBlinkFeatures` String - A list of feature strings separated by `,`,
|
|
|
|
|
like `CSSVariables,KeyboardEventKey` to disable. The full list of supported
|
|
|
|
|
feature strings can be found in the
|
|
|
|
|
[RuntimeEnabledFeatures.in][blink-feature-string] file.
|
2016-01-19 14:13:23 +00:00
|
|
|
|
* `defaultFontFamily` Object - Sets the default font for the font-family.
|
|
|
|
|
* `standard` String - Defaults to `Times New Roman`.
|
|
|
|
|
* `serif` String - Defaults to `Times New Roman`.
|
|
|
|
|
* `sansSerif` String - Defaults to `Arial`.
|
|
|
|
|
* `monospace` String - Defaults to `Courier New`.
|
|
|
|
|
* `defaultFontSize` Integer - Defaults to `16`.
|
|
|
|
|
* `defaultMonospaceFontSize` Integer - Defaults to `13`.
|
|
|
|
|
* `minimumFontSize` Integer - Defaults to `0`.
|
|
|
|
|
* `defaultEncoding` String - Defaults to `ISO-8859-1`.
|
2016-04-08 06:54:33 +00:00
|
|
|
|
* `backgroundThrottling` Boolean - Whether to throttle animations and timers
|
|
|
|
|
when the page becomes background. Defaults to `true`.
|
2016-07-30 22:22:34 +00:00
|
|
|
|
* `offscreen` Boolean - Whether to enable offscreen rendering for the browser
|
|
|
|
|
window. Defaults to `false`.
|
2015-08-20 13:17:53 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
### Instance Events
|
2015-08-20 13:17:53 +00:00
|
|
|
|
|
2016-07-13 04:30:27 +00:00
|
|
|
|
Objects created with `new BrowserWindow` emit the following events:
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-01-11 05:43:24 +00:00
|
|
|
|
**Note:** Some events are only available on specific operating systems and are
|
|
|
|
|
labeled as such.
|
2015-08-26 21:14:59 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'page-title-updated'
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Returns:
|
|
|
|
|
|
2013-08-14 22:43:35 +00:00
|
|
|
|
* `event` Event
|
2016-08-15 17:06:29 +00:00
|
|
|
|
* `title` String
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2013-08-29 14:37:51 +00:00
|
|
|
|
Emitted when the document changed its title, calling `event.preventDefault()`
|
2016-07-13 04:40:46 +00:00
|
|
|
|
will prevent the native window's title from changing.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'close'
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Returns:
|
|
|
|
|
|
2013-08-14 22:43:35 +00:00
|
|
|
|
* `event` Event
|
|
|
|
|
|
2013-08-29 14:37:51 +00:00
|
|
|
|
Emitted when the window is going to be closed. It's emitted before the
|
2015-08-20 13:17:53 +00:00
|
|
|
|
`beforeunload` and `unload` event of the DOM. Calling `event.preventDefault()`
|
|
|
|
|
will cancel the close.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2013-08-29 14:37:51 +00:00
|
|
|
|
Usually you would want to use the `beforeunload` handler to decide whether the
|
|
|
|
|
window should be closed, which will also be called when the window is
|
2016-05-23 04:28:16 +00:00
|
|
|
|
reloaded. In Electron, returning any value other than `undefined` would cancel the
|
2015-08-20 13:17:53 +00:00
|
|
|
|
close. For example:
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
```javascript
|
2016-05-10 17:15:09 +00:00
|
|
|
|
window.onbeforeunload = (e) => {
|
2016-07-26 01:39:25 +00:00
|
|
|
|
console.log('I do not want to be closed')
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-05-23 04:28:16 +00:00
|
|
|
|
// Unlike usual browsers that a message box will be prompted to users, returning
|
|
|
|
|
// a non-void value will silently cancel the close.
|
|
|
|
|
// It is recommended to use the dialog API to let the user confirm closing the
|
|
|
|
|
// application.
|
2016-07-26 01:39:25 +00:00
|
|
|
|
e.returnValue = false
|
|
|
|
|
}
|
2013-08-14 22:43:35 +00:00
|
|
|
|
```
|
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'closed'
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2014-04-30 06:52:58 +00:00
|
|
|
|
Emitted when the window is closed. After you have received this event you should
|
2016-07-13 04:40:46 +00:00
|
|
|
|
remove the reference to the window and avoid using it any more.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'unresponsive'
|
2014-01-15 14:42:47 +00:00
|
|
|
|
|
2014-05-07 06:34:53 +00:00
|
|
|
|
Emitted when the web page becomes unresponsive.
|
2014-01-15 14:42:47 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'responsive'
|
2014-01-15 14:42:47 +00:00
|
|
|
|
|
|
|
|
|
Emitted when the unresponsive web page becomes responsive again.
|
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'blur'
|
2014-01-15 14:42:47 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Emitted when the window loses focus.
|
2014-01-15 14:42:47 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'focus'
|
2014-05-21 17:46:13 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Emitted when the window gains focus.
|
2014-05-21 17:46:13 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'show'
|
2016-03-08 17:36:41 +00:00
|
|
|
|
|
|
|
|
|
Emitted when the window is shown.
|
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'hide'
|
2016-03-08 17:36:41 +00:00
|
|
|
|
|
|
|
|
|
Emitted when the window is hidden.
|
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'ready-to-show'
|
2016-06-13 13:11:40 +00:00
|
|
|
|
|
|
|
|
|
Emitted when the web page has been rendered and window can be displayed without
|
2016-07-13 04:40:46 +00:00
|
|
|
|
a visual flash.
|
2016-06-13 13:11:40 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'maximize'
|
2014-11-25 06:43:11 +00:00
|
|
|
|
|
|
|
|
|
Emitted when window is maximized.
|
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'unmaximize'
|
2014-11-25 06:43:11 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Emitted when the window exits from a maximized state.
|
2014-11-25 06:43:11 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'minimize'
|
2014-11-25 06:43:11 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Emitted when the window is minimized.
|
2014-11-25 06:43:11 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'restore'
|
2014-11-25 06:43:11 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Emitted when the window is restored from a minimized state.
|
2014-11-25 06:43:11 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'resize'
|
2015-05-09 15:55:10 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Emitted when the window is being resized.
|
2015-05-09 15:55:10 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'move'
|
2015-05-09 15:55:10 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Emitted when the window is being moved to a new position.
|
2015-05-20 08:37:13 +00:00
|
|
|
|
|
2016-06-18 13:26:26 +00:00
|
|
|
|
__Note__: On macOS this event is just an alias of `moved`.
|
2015-05-27 06:57:14 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'moved' _macOS_
|
2015-05-20 08:37:13 +00:00
|
|
|
|
|
|
|
|
|
Emitted once when the window is moved to a new position.
|
2015-05-09 15:55:10 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'enter-full-screen'
|
2014-11-25 06:43:11 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Emitted when the window enters a full-screen state.
|
2014-11-25 06:43:11 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'leave-full-screen'
|
2014-11-25 06:43:11 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Emitted when the window leaves a full-screen state.
|
2014-11-25 06:43:11 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'enter-html-full-screen'
|
2015-05-16 21:01:30 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Emitted when the window enters a full-screen state triggered by HTML API.
|
2015-05-16 21:01:30 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'leave-html-full-screen'
|
2015-05-16 21:01:30 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Emitted when the window leaves a full-screen state triggered by HTML API.
|
2015-05-16 21:01:30 +00:00
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'app-command' _Windows_
|
2015-06-19 19:58:47 +00:00
|
|
|
|
|
2016-03-31 07:56:49 +00:00
|
|
|
|
Returns:
|
|
|
|
|
|
|
|
|
|
* `event` Event
|
|
|
|
|
* `command` String
|
|
|
|
|
|
2015-09-02 19:44:51 +00:00
|
|
|
|
Emitted when an [App Command](https://msdn.microsoft.com/en-us/library/windows/desktop/ms646275(v=vs.85).aspx)
|
2015-08-24 22:41:02 +00:00
|
|
|
|
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.
|
2015-06-19 19:58:47 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Commands are lowercased, underscores are replaced with hyphens, and the
|
|
|
|
|
`APPCOMMAND_` prefix is stripped off.
|
2016-03-31 07:56:49 +00:00
|
|
|
|
e.g. `APPCOMMAND_BROWSER_BACKWARD` is emitted as `browser-backward`.
|
|
|
|
|
|
2016-04-22 14:15:31 +00:00
|
|
|
|
```javascript
|
2016-07-26 01:39:25 +00:00
|
|
|
|
const {BrowserWindow} = require('electron')
|
|
|
|
|
let win = new BrowserWindow()
|
|
|
|
|
win.on('app-command', (e, cmd) => {
|
2015-06-19 19:58:47 +00:00
|
|
|
|
// Navigate the window back when the user hits their mouse back button
|
2016-07-26 01:39:25 +00:00
|
|
|
|
if (cmd === 'browser-backward' && win.webContents.canGoBack()) {
|
|
|
|
|
win.webContents.goBack()
|
2015-06-19 19:58:47 +00:00
|
|
|
|
}
|
2016-07-26 01:39:25 +00:00
|
|
|
|
})
|
2015-06-19 19:58:47 +00:00
|
|
|
|
```
|
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'scroll-touch-begin' _macOS_
|
2016-01-25 07:02:43 +00:00
|
|
|
|
|
|
|
|
|
Emitted when scroll wheel event phase has begun.
|
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'scroll-touch-end' _macOS_
|
2016-01-25 07:02:43 +00:00
|
|
|
|
|
|
|
|
|
Emitted when scroll wheel event phase has ended.
|
|
|
|
|
|
2016-07-13 04:24:22 +00:00
|
|
|
|
#### Event: 'swipe' _macOS_
|
2016-03-18 15:20:04 +00:00
|
|
|
|
|
2016-03-23 15:20:11 +00:00
|
|
|
|
Returns:
|
2016-03-18 15:20:04 +00:00
|
|
|
|
|
2016-03-23 15:20:11 +00:00
|
|
|
|
* `event` Event
|
|
|
|
|
* `direction` String
|
2016-03-18 15:20:04 +00:00
|
|
|
|
|
2016-03-23 15:20:11 +00:00
|
|
|
|
Emitted on 3-finger swipe. Possible directions are `up`, `right`, `down`, `left`.
|
2016-03-18 15:20:04 +00:00
|
|
|
|
|
2016-07-13 04:29:09 +00:00
|
|
|
|
### Static Methods
|
2015-08-20 13:17:53 +00:00
|
|
|
|
|
2016-07-13 04:28:27 +00:00
|
|
|
|
The `BrowserWindow` class has the following static methods:
|
2015-08-20 13:17:53 +00:00
|
|
|
|
|
2016-07-13 04:29:09 +00:00
|
|
|
|
#### `BrowserWindow.getAllWindows()`
|
2013-12-26 10:41:21 +00:00
|
|
|
|
|
|
|
|
|
Returns an array of all opened browser windows.
|
|
|
|
|
|
2016-07-13 04:29:09 +00:00
|
|
|
|
#### `BrowserWindow.getFocusedWindow()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-01-11 07:18:35 +00:00
|
|
|
|
Returns the window that is focused in this application, otherwise returns `null`.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:29:09 +00:00
|
|
|
|
#### `BrowserWindow.fromWebContents(webContents)`
|
2014-04-25 09:15:26 +00:00
|
|
|
|
|
2015-09-10 19:19:37 +00:00
|
|
|
|
* `webContents` [WebContents](web-contents.md)
|
2014-04-25 09:15:26 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Find a window according to the `webContents` it owns.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:29:09 +00:00
|
|
|
|
#### `BrowserWindow.fromId(id)`
|
2014-05-22 01:56:04 +00:00
|
|
|
|
|
|
|
|
|
* `id` Integer
|
|
|
|
|
|
|
|
|
|
Find a window according to its ID.
|
|
|
|
|
|
2016-07-13 04:29:09 +00:00
|
|
|
|
#### `BrowserWindow.addDevToolsExtension(path)`
|
2014-08-28 08:33:27 +00:00
|
|
|
|
|
|
|
|
|
* `path` String
|
|
|
|
|
|
2015-09-09 21:11:06 +00:00
|
|
|
|
Adds DevTools extension located at `path`, and returns extension's name.
|
2014-08-28 08:33:27 +00:00
|
|
|
|
|
|
|
|
|
The extension will be remembered so you only need to call this API once, this
|
2016-06-03 21:30:55 +00:00
|
|
|
|
API is not for programming use. If you try to add an extension that has already
|
|
|
|
|
been loaded, this method will not return and instead log a warning to the
|
|
|
|
|
console.
|
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
The method will also not return if the extension's manifest is missing or incomplete.
|
2014-08-28 08:33:27 +00:00
|
|
|
|
|
2016-06-17 22:01:16 +00:00
|
|
|
|
**Note:** This API cannot be called before the `ready` event of the `app` module
|
|
|
|
|
is emitted.
|
|
|
|
|
|
2016-07-13 04:29:09 +00:00
|
|
|
|
#### `BrowserWindow.removeDevToolsExtension(name)`
|
2014-08-28 08:33:27 +00:00
|
|
|
|
|
|
|
|
|
* `name` String
|
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Remove a DevTools extension by name.
|
2014-08-28 08:33:27 +00:00
|
|
|
|
|
2016-06-17 22:01:16 +00:00
|
|
|
|
**Note:** This API cannot be called before the `ready` event of the `app` module
|
|
|
|
|
is emitted.
|
|
|
|
|
|
2016-07-13 04:29:09 +00:00
|
|
|
|
#### `BrowserWindow.getDevToolsExtensions()`
|
2016-06-09 17:05:09 +00:00
|
|
|
|
|
2016-06-10 16:29:26 +00:00
|
|
|
|
Returns an Object where the keys are the extension names and each value is
|
|
|
|
|
an Object containing `name` and `version` properties.
|
|
|
|
|
|
|
|
|
|
To check if a DevTools extension is installed you can run the following:
|
2016-06-09 17:05:09 +00:00
|
|
|
|
|
2016-06-10 16:29:26 +00:00
|
|
|
|
```javascript
|
2016-07-26 01:39:25 +00:00
|
|
|
|
const {BrowserWindow} = require('electron')
|
|
|
|
|
|
2016-06-10 16:34:34 +00:00
|
|
|
|
let installed = BrowserWindow.getDevToolsExtensions().hasOwnProperty('devtron')
|
2016-07-26 01:39:25 +00:00
|
|
|
|
console.log(installed)
|
2016-06-10 16:29:26 +00:00
|
|
|
|
```
|
2016-06-09 17:05:09 +00:00
|
|
|
|
|
2016-06-17 22:01:16 +00:00
|
|
|
|
**Note:** This API cannot be called before the `ready` event of the `app` module
|
|
|
|
|
is emitted.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
### Instance Properties
|
2015-08-20 13:17:53 +00:00
|
|
|
|
|
2015-09-09 20:57:35 +00:00
|
|
|
|
Objects created with `new BrowserWindow` have the following properties:
|
2015-08-26 21:14:59 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
```javascript
|
2016-07-26 01:39:25 +00:00
|
|
|
|
const {BrowserWindow} = require('electron')
|
2015-08-20 13:17:53 +00:00
|
|
|
|
// In this example `win` is our instance
|
2016-07-26 01:39:25 +00:00
|
|
|
|
let win = new BrowserWindow({width: 800, height: 600})
|
|
|
|
|
win.loadURL('https://github.com')
|
2015-08-20 13:17:53 +00:00
|
|
|
|
```
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.webContents`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
The `WebContents` object this window owns. All web page related events and
|
2015-08-20 13:17:53 +00:00
|
|
|
|
operations will be done via it.
|
|
|
|
|
|
2015-08-24 22:41:02 +00:00
|
|
|
|
See the [`webContents` documentation](web-contents.md) for its methods and
|
|
|
|
|
events.
|
2014-04-25 09:15:26 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.id`
|
2015-09-09 20:57:35 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
The unique ID of the window.
|
2015-09-09 20:57:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
### Instance Methods
|
2015-09-09 20:57:35 +00:00
|
|
|
|
|
|
|
|
|
Objects created with `new BrowserWindow` have the following instance methods:
|
|
|
|
|
|
2016-01-11 05:43:24 +00:00
|
|
|
|
**Note:** Some methods are only available on specific operating systems and are
|
|
|
|
|
labeled as such.
|
2015-09-09 20:57:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.destroy()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2014-04-30 06:52:58 +00:00
|
|
|
|
Force closing the window, the `unload` and `beforeunload` event won't be emitted
|
2015-08-20 13:17:53 +00:00
|
|
|
|
for the web page, and `close` event will also not be emitted
|
|
|
|
|
for this window, but it guarantees the `closed` event will be emitted.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.close()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Try to close the window. This has the same effect as a user manually clicking
|
|
|
|
|
the close button of the window. The web page may cancel the close though. See
|
2015-04-01 00:24:39 +00:00
|
|
|
|
the [close event](#event-close).
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.focus()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-06-22 05:56:51 +00:00
|
|
|
|
Focuses on the window.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.blur()`
|
2016-03-11 05:45:51 +00:00
|
|
|
|
|
2016-06-22 05:56:51 +00:00
|
|
|
|
Removes focus from the window.
|
2016-03-11 05:45:51 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isFocused()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Returns a boolean, whether the window is focused.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-08-03 21:54:36 +00:00
|
|
|
|
#### `win.isDestroyed()`
|
|
|
|
|
|
|
|
|
|
Returns a boolean, whether the window is destroyed.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.show()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2014-10-17 14:46:00 +00:00
|
|
|
|
Shows and gives focus to the window.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.showInactive()`
|
2014-10-17 14:46:00 +00:00
|
|
|
|
|
|
|
|
|
Shows the window but doesn't focus on it.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.hide()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Hides the window.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isVisible()`
|
2013-10-03 00:27:59 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Returns a boolean, whether the window is visible to the user.
|
2013-10-03 00:27:59 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isModal()`
|
2016-06-20 02:06:48 +00:00
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
Returns a boolean, whether current window is a modal window.
|
2016-06-20 02:06:48 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.maximize()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Maximizes the window.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.unmaximize()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Unmaximizes the window.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isMaximized()`
|
2014-05-14 21:58:49 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Returns a boolean, whether the window is maximized.
|
2014-05-14 21:58:49 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.minimize()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2013-08-29 14:37:51 +00:00
|
|
|
|
Minimizes the window. On some platforms the minimized window will be shown in
|
|
|
|
|
the Dock.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.restore()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Restores the window from minimized state to its previous state.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isMinimized()`
|
2014-07-26 05:58:26 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Returns a boolean, whether the window is minimized.
|
2014-07-26 05:58:26 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setFullScreen(flag)`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
* `flag` Boolean
|
|
|
|
|
|
|
|
|
|
Sets whether the window should be in fullscreen mode.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isFullScreen()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Returns a boolean, whether the window is in fullscreen mode.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setAspectRatio(aspectRatio[, extraSize])` _macOS_
|
2015-07-22 14:23:31 +00:00
|
|
|
|
|
2016-07-29 09:53:01 +00:00
|
|
|
|
* `aspectRatio` Float - The aspect ratio to maintain for some portion of the
|
2015-08-24 22:41:02 +00:00
|
|
|
|
content view.
|
2015-08-24 22:55:53 +00:00
|
|
|
|
* `extraSize` Object (optional) - The extra size not to be included while
|
2016-02-16 04:11:05 +00:00
|
|
|
|
maintaining the aspect ratio.
|
2015-07-22 14:23:31 +00:00
|
|
|
|
* `width` Integer
|
|
|
|
|
* `height` Integer
|
|
|
|
|
|
2016-07-13 04:40:46 +00:00
|
|
|
|
This will make a window maintain an aspect ratio. The extra size allows a
|
2015-08-26 20:57:42 +00:00
|
|
|
|
developer to have space, specified in pixels, not included within the aspect
|
|
|
|
|
ratio calculations. This API already takes into account the difference between a
|
2015-08-24 22:41:02 +00:00
|
|
|
|
window's size and its content size.
|
2015-07-22 14:23:31 +00:00
|
|
|
|
|
2015-08-24 22:41:02 +00:00
|
|
|
|
Consider a normal window with an HD video player and associated controls.
|
|
|
|
|
Perhaps there are 15 pixels of controls on the left edge, 25 pixels of controls
|
|
|
|
|
on the right edge and 50 pixels of controls below the player. In order to
|
|
|
|
|
maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within
|
|
|
|
|
the player itself we would call this function with arguments of 16/9 and
|
|
|
|
|
[ 40, 50 ]. The second argument doesn't care where the extra width and height
|
|
|
|
|
are within the content view--only that they exist. Just sum any extra width and
|
|
|
|
|
height areas you have within the overall content view.
|
2015-07-22 14:23:31 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setBounds(options[, animate])`
|
2015-05-01 10:50:53 +00:00
|
|
|
|
|
2016-02-16 04:11:05 +00:00
|
|
|
|
* `options` Object
|
2016-01-15 16:31:31 +00:00
|
|
|
|
* `x` Integer
|
|
|
|
|
* `y` Integer
|
|
|
|
|
* `width` Integer
|
|
|
|
|
* `height` Integer
|
2016-06-18 13:26:26 +00:00
|
|
|
|
* `animate` Boolean (optional) _macOS_
|
2015-05-01 10:50:53 +00:00
|
|
|
|
|
|
|
|
|
Resizes and moves the window to `width`, `height`, `x`, `y`.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.getBounds()`
|
2015-05-01 10:50:53 +00:00
|
|
|
|
|
|
|
|
|
Returns an object that contains window's width, height, x and y values.
|
|
|
|
|
|
2016-08-04 19:15:24 +00:00
|
|
|
|
#### `win.setContentBounds(options[, animate])`
|
|
|
|
|
|
|
|
|
|
* `options` Object
|
|
|
|
|
* `x` Integer
|
|
|
|
|
* `y` Integer
|
|
|
|
|
* `width` Integer
|
|
|
|
|
* `height` Integer
|
|
|
|
|
* `animate` Boolean (optional) _macOS_
|
|
|
|
|
|
|
|
|
|
Resizes and moves the window's client area (e.g. the web page) to
|
|
|
|
|
`width`, `height`, `x`, `y`.
|
|
|
|
|
|
2016-07-29 16:44:39 +00:00
|
|
|
|
#### `win.getContentBounds()`
|
|
|
|
|
|
|
|
|
|
Returns an object that contains the window's client area (e.g. the web page)
|
|
|
|
|
width, height, x and y values.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setSize(width, height[, animate])`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
* `width` Integer
|
|
|
|
|
* `height` Integer
|
2016-06-18 13:26:26 +00:00
|
|
|
|
* `animate` Boolean (optional) _macOS_
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Resizes the window to `width` and `height`.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.getSize()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Returns an array that contains window's width and height.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setContentSize(width, height[, animate])`
|
2014-05-18 13:33:31 +00:00
|
|
|
|
|
|
|
|
|
* `width` Integer
|
|
|
|
|
* `height` Integer
|
2016-06-18 13:26:26 +00:00
|
|
|
|
* `animate` Boolean (optional) _macOS_
|
2014-05-18 13:33:31 +00:00
|
|
|
|
|
|
|
|
|
Resizes the window's client area (e.g. the web page) to `width` and `height`.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.getContentSize()`
|
2014-05-18 13:33:31 +00:00
|
|
|
|
|
|
|
|
|
Returns an array that contains window's client area's width and height.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setMinimumSize(width, height)`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
* `width` Integer
|
|
|
|
|
* `height` Integer
|
|
|
|
|
|
|
|
|
|
Sets the minimum size of window to `width` and `height`.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.getMinimumSize()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Returns an array that contains window's minimum width and height.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setMaximumSize(width, height)`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
* `width` Integer
|
|
|
|
|
* `height` Integer
|
|
|
|
|
|
|
|
|
|
Sets the maximum size of window to `width` and `height`.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.getMaximumSize()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Returns an array that contains window's maximum width and height.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setResizable(resizable)`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
* `resizable` Boolean
|
|
|
|
|
|
|
|
|
|
Sets whether the window can be manually resized by user.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isResizable()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Returns whether the window can be manually resized by user.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setMovable(movable)` _macOS_ _Windows_
|
2016-01-19 15:07:51 +00:00
|
|
|
|
|
|
|
|
|
* `movable` Boolean
|
|
|
|
|
|
|
|
|
|
Sets whether the window can be moved by user. On Linux does nothing.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isMovable()` _macOS_ _Windows_
|
2016-01-19 15:07:51 +00:00
|
|
|
|
|
|
|
|
|
Returns whether the window can be moved by user. On Linux always returns
|
|
|
|
|
`true`.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setMinimizable(minimizable)` _macOS_ _Windows_
|
2016-01-19 15:07:51 +00:00
|
|
|
|
|
|
|
|
|
* `minimizable` Boolean
|
|
|
|
|
|
|
|
|
|
Sets whether the window can be manually minimized by user. On Linux does
|
|
|
|
|
nothing.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isMinimizable()` _macOS_ _Windows_
|
2016-01-19 15:07:51 +00:00
|
|
|
|
|
|
|
|
|
Returns whether the window can be manually minimized by user. On Linux always
|
|
|
|
|
returns `true`.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setMaximizable(maximizable)` _macOS_ _Windows_
|
2016-01-22 22:31:59 +00:00
|
|
|
|
|
|
|
|
|
* `maximizable` Boolean
|
|
|
|
|
|
|
|
|
|
Sets whether the window can be manually maximized by user. On Linux does
|
|
|
|
|
nothing.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isMaximizable()` _macOS_ _Windows_
|
2016-01-22 22:31:59 +00:00
|
|
|
|
|
|
|
|
|
Returns whether the window can be manually maximized by user. On Linux always
|
|
|
|
|
returns `true`.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setFullScreenable(fullscreenable)`
|
2016-01-22 22:31:59 +00:00
|
|
|
|
|
|
|
|
|
* `fullscreenable` Boolean
|
|
|
|
|
|
|
|
|
|
Sets whether the maximize/zoom window button toggles fullscreen mode or
|
2016-02-22 09:23:56 +00:00
|
|
|
|
maximizes the window.
|
2016-01-22 22:31:59 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isFullScreenable()`
|
2016-01-22 22:31:59 +00:00
|
|
|
|
|
|
|
|
|
Returns whether the maximize/zoom window button toggles fullscreen mode or
|
2016-02-22 09:23:56 +00:00
|
|
|
|
maximizes the window.
|
2016-01-22 22:31:59 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setClosable(closable)` _macOS_ _Windows_
|
2016-01-19 15:07:51 +00:00
|
|
|
|
|
|
|
|
|
* `closable` Boolean
|
|
|
|
|
|
|
|
|
|
Sets whether the window can be manually closed by user. On Linux does nothing.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isClosable()` _macOS_ _Windows_
|
2016-01-19 15:07:51 +00:00
|
|
|
|
|
|
|
|
|
Returns whether the window can be manually closed by user. On Linux always
|
|
|
|
|
returns `true`.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setAlwaysOnTop(flag)`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
* `flag` Boolean
|
|
|
|
|
|
2013-08-29 14:37:51 +00:00
|
|
|
|
Sets whether the window should show always on top of other windows. After
|
|
|
|
|
setting this, the window is still a normal window, not a toolbox window which
|
|
|
|
|
can not be focused on.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isAlwaysOnTop()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Returns whether the window is always on top of other windows.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.center()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Moves window to the center of the screen.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setPosition(x, y[, animate])`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
* `x` Integer
|
|
|
|
|
* `y` Integer
|
2016-06-18 13:26:26 +00:00
|
|
|
|
* `animate` Boolean (optional) _macOS_
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Moves window to `x` and `y`.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.getPosition()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Returns an array that contains window's current position.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setTitle(title)`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
* `title` String
|
|
|
|
|
|
|
|
|
|
Changes the title of native window to `title`.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.getTitle()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Returns the title of the native window.
|
|
|
|
|
|
2013-08-29 14:37:51 +00:00
|
|
|
|
**Note:** The title of web page can be different from the title of the native
|
2014-08-22 07:14:49 +00:00
|
|
|
|
window.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setSheetOffset(offsetY[, offsetX])` _macOS_
|
2016-04-19 05:39:12 +00:00
|
|
|
|
|
2016-07-29 09:53:01 +00:00
|
|
|
|
* `offsetY` Float
|
|
|
|
|
* `offsetX` Float (optional)
|
|
|
|
|
|
2016-06-18 13:26:26 +00:00
|
|
|
|
Changes the attachment point for sheets on macOS. By default, sheets are
|
2016-04-22 13:53:26 +00:00
|
|
|
|
attached just below the window frame, but you may want to display them beneath
|
|
|
|
|
a HTML-rendered toolbar. For example:
|
2016-04-19 05:39:12 +00:00
|
|
|
|
|
2016-04-22 14:15:31 +00:00
|
|
|
|
```javascript
|
2016-07-26 01:39:25 +00:00
|
|
|
|
const {BrowserWindow} = require('electron')
|
|
|
|
|
let win = new BrowserWindow()
|
|
|
|
|
|
|
|
|
|
let toolbarRect = document.getElementById('toolbar').getBoundingClientRect()
|
|
|
|
|
win.setSheetOffset(toolbarRect.height)
|
2016-04-19 05:39:12 +00:00
|
|
|
|
```
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.flashFrame(flag)`
|
2014-08-28 08:00:29 +00:00
|
|
|
|
|
2014-08-23 05:20:47 +00:00
|
|
|
|
* `flag` Boolean
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2014-08-23 05:20:47 +00:00
|
|
|
|
Starts or stops flashing the window to attract user's attention.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setSkipTaskbar(skip)`
|
2014-06-16 02:51:45 +00:00
|
|
|
|
|
|
|
|
|
* `skip` Boolean
|
|
|
|
|
|
2015-06-09 14:49:44 +00:00
|
|
|
|
Makes the window not show in the taskbar.
|
2014-06-16 02:51:45 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setKiosk(flag)`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
* `flag` Boolean
|
|
|
|
|
|
|
|
|
|
Enters or leaves the kiosk mode.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isKiosk()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
|
|
|
|
Returns whether the window is in kiosk mode.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.getNativeWindowHandle()`
|
2016-01-07 21:17:23 +00:00
|
|
|
|
|
2016-01-11 05:43:24 +00:00
|
|
|
|
Returns the platform-specific handle of the window as `Buffer`.
|
|
|
|
|
|
2016-06-18 13:26:26 +00:00
|
|
|
|
The native type of the handle is `HWND` on Windows, `NSView*` on macOS, and
|
2016-01-11 05:43:24 +00:00
|
|
|
|
`Window` (`unsigned long`) on Linux.
|
2016-01-07 21:17:23 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.hookWindowMessage(message, callback)` _Windows_
|
2015-10-27 12:00:08 +00:00
|
|
|
|
|
|
|
|
|
* `message` Integer
|
|
|
|
|
* `callback` Function
|
|
|
|
|
|
|
|
|
|
Hooks a windows message. The `callback` is called when
|
|
|
|
|
the message is received in the WndProc.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isWindowMessageHooked(message)` _Windows_
|
2015-10-27 12:00:08 +00:00
|
|
|
|
|
|
|
|
|
* `message` Integer
|
|
|
|
|
|
|
|
|
|
Returns `true` or `false` depending on whether the message is hooked.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.unhookWindowMessage(message)` _Windows_
|
2015-10-27 12:00:08 +00:00
|
|
|
|
|
|
|
|
|
* `message` Integer
|
|
|
|
|
|
|
|
|
|
Unhook the window message.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.unhookAllWindowMessages()` _Windows_
|
2015-10-27 12:00:08 +00:00
|
|
|
|
|
|
|
|
|
Unhooks all of the window messages.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setRepresentedFilename(filename)` _macOS_
|
2014-05-27 06:15:34 +00:00
|
|
|
|
|
|
|
|
|
* `filename` String
|
|
|
|
|
|
2014-12-19 20:48:53 +00:00
|
|
|
|
Sets the pathname of the file the window represents, and the icon of the file
|
|
|
|
|
will show in window's title bar.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.getRepresentedFilename()` _macOS_
|
2014-07-18 13:42:26 +00:00
|
|
|
|
|
2014-12-19 20:48:53 +00:00
|
|
|
|
Returns the pathname of the file the window represents.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setDocumentEdited(edited)` _macOS_
|
2014-05-27 06:15:34 +00:00
|
|
|
|
|
|
|
|
|
* `edited` Boolean
|
|
|
|
|
|
2014-12-19 20:48:53 +00:00
|
|
|
|
Specifies whether the window’s document has been edited, and the icon in title
|
2016-02-15 05:51:20 +00:00
|
|
|
|
bar will become gray when set to `true`.
|
2014-12-19 20:48:53 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isDocumentEdited()` _macOS_
|
2014-07-24 07:48:33 +00:00
|
|
|
|
|
2014-12-19 20:48:53 +00:00
|
|
|
|
Whether the window's document has been edited.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.focusOnWebView()`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.blurWebView()`
|
2013-11-22 06:39:10 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.capturePage([rect, ]callback)`
|
2013-11-22 06:39:10 +00:00
|
|
|
|
|
2016-08-25 17:52:19 +00:00
|
|
|
|
* `rect` Object (optional) - The area of the page to be captured
|
|
|
|
|
* `x` Integer
|
|
|
|
|
* `y` Integer
|
|
|
|
|
* `width` Integer
|
|
|
|
|
* `height` Integer
|
|
|
|
|
* `callback` Function
|
|
|
|
|
|
2016-07-06 00:26:05 +00:00
|
|
|
|
Same as `webContents.capturePage([rect, ]callback)`.
|
2013-11-22 06:39:10 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.loadURL(url[, options])`
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-08-25 17:52:19 +00:00
|
|
|
|
* `url` URL
|
|
|
|
|
* `options` Object (optional)
|
|
|
|
|
* `httpReferrer` String - A HTTP Referrer url.
|
|
|
|
|
* `userAgent` String - A user agent originating the request.
|
|
|
|
|
* `extraHeaders` String - Extra headers separated by "\n"
|
|
|
|
|
|
2015-11-13 08:03:40 +00:00
|
|
|
|
Same as `webContents.loadURL(url[, options])`.
|
2013-08-14 22:43:35 +00:00
|
|
|
|
|
2016-08-19 20:31:57 +00:00
|
|
|
|
The `url` can be a remote address (e.g. `http://`) or a path to a local
|
2016-08-19 05:20:55 +00:00
|
|
|
|
HTML file using the `file://` protocol.
|
|
|
|
|
|
2016-08-19 20:31:57 +00:00
|
|
|
|
To ensure that file URLs are properly formatted, it is recommended to use
|
|
|
|
|
Node's [`url.format`](https://nodejs.org/api/url.html#url_url_format_urlobject)
|
|
|
|
|
method:
|
|
|
|
|
|
|
|
|
|
```javascript
|
|
|
|
|
let url = require('url').format({
|
|
|
|
|
protocol: 'file',
|
|
|
|
|
slashes: true,
|
2016-08-22 21:25:48 +00:00
|
|
|
|
pathname: require('path').join(__dirname, 'index.html')
|
2016-08-19 20:31:57 +00:00
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
win.loadURL(url)
|
|
|
|
|
```
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.reload()`
|
2014-05-15 12:21:37 +00:00
|
|
|
|
|
2015-08-20 13:17:53 +00:00
|
|
|
|
Same as `webContents.reload`.
|
2014-05-14 16:06:56 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setMenu(menu)` _Linux_ _Windows_
|
2014-05-14 16:19:30 +00:00
|
|
|
|
|
2014-05-27 06:20:22 +00:00
|
|
|
|
* `menu` Menu
|
|
|
|
|
|
2015-06-04 08:12:29 +00:00
|
|
|
|
Sets the `menu` as the window's menu bar, setting it to `null` will remove the
|
|
|
|
|
menu bar.
|
2014-05-14 16:19:30 +00:00
|
|
|
|
|
2016-08-08 22:44:48 +00:00
|
|
|
|
#### `win.setProgressBar(progress[, options])`
|
2014-09-18 11:29:23 +00:00
|
|
|
|
|
|
|
|
|
* `progress` Double
|
2016-08-08 22:44:48 +00:00
|
|
|
|
* `options` Object (optional)
|
|
|
|
|
* `mode` String _Windows_ - Mode for the progres bar (`none`, `normal`, `indeterminate`, `error`, or `paused`)
|
2014-09-18 11:29:23 +00:00
|
|
|
|
|
|
|
|
|
Sets progress value in progress bar. Valid range is [0, 1.0].
|
|
|
|
|
|
|
|
|
|
Remove progress bar when progress < 0;
|
|
|
|
|
Change to indeterminate mode when progress > 1.
|
|
|
|
|
|
|
|
|
|
On Linux platform, only supports Unity desktop environment, you need to specify
|
|
|
|
|
the `*.desktop` file name to `desktopName` field in `package.json`. By default,
|
2014-09-18 14:58:17 +00:00
|
|
|
|
it will assume `app.getName().desktop`.
|
2014-09-18 11:29:23 +00:00
|
|
|
|
|
2016-08-19 05:20:55 +00:00
|
|
|
|
On Windows, a mode can be passed. Accepted values are `none`, `normal`,
|
2016-08-08 22:44:48 +00:00
|
|
|
|
`indeterminate`, `error`, and `paused`. If you call `setProgressBar` without a
|
|
|
|
|
mode set (but with a value within the valid range), `normal` will be assumed.
|
|
|
|
|
|
2016-07-15 00:32:14 +00:00
|
|
|
|
#### `win.setOverlayIcon(overlay, description)` _Windows_
|
2015-02-07 01:11:54 +00:00
|
|
|
|
|
2015-02-12 05:52:28 +00:00
|
|
|
|
* `overlay` [NativeImage](native-image.md) - the icon to display on the bottom
|
2015-06-09 14:49:44 +00:00
|
|
|
|
right corner of the taskbar icon. If this parameter is `null`, the overlay is
|
2015-02-12 05:52:28 +00:00
|
|
|
|
cleared
|
|
|
|
|
* `description` String - a description that will be provided to Accessibility
|
|
|
|
|
screen readers
|
2015-02-07 01:11:54 +00:00
|
|
|
|
|
2016-04-22 13:53:26 +00:00
|
|
|
|
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.
|
2015-02-07 01:11:54 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setHasShadow(hasShadow)` _macOS_
|
2016-01-23 00:15:49 +00:00
|
|
|
|
|
2016-06-23 21:13:03 +00:00
|
|
|
|
* `hasShadow` Boolean
|
2016-01-23 00:15:49 +00:00
|
|
|
|
|
|
|
|
|
Sets whether the window should have a shadow. On Windows and Linux does
|
|
|
|
|
nothing.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.hasShadow()` _macOS_
|
2016-01-23 00:15:49 +00:00
|
|
|
|
|
|
|
|
|
Returns whether the window has a shadow. On Windows and Linux always returns
|
|
|
|
|
`true`.
|
2015-02-07 01:11:54 +00:00
|
|
|
|
|
2016-07-15 00:32:14 +00:00
|
|
|
|
#### `win.setThumbarButtons(buttons)` _Windows_
|
2015-08-20 13:17:53 +00:00
|
|
|
|
|
2016-02-16 04:11:05 +00:00
|
|
|
|
* `buttons` Array
|
2015-08-05 05:47:59 +00:00
|
|
|
|
|
|
|
|
|
Add a thumbnail toolbar with a specified set of buttons to the thumbnail image
|
|
|
|
|
of a window in a taskbar button layout. Returns a `Boolean` object indicates
|
|
|
|
|
whether the thumbnail has been added successfully.
|
2015-08-02 05:07:55 +00:00
|
|
|
|
|
2015-08-05 05:47:59 +00:00
|
|
|
|
The number of buttons in thumbnail toolbar should be no greater than 7 due to
|
|
|
|
|
the limited room. Once you setup the thumbnail toolbar, the toolbar cannot be
|
|
|
|
|
removed due to the platform's limitation. But you can call the API with an empty
|
|
|
|
|
array to clean the buttons.
|
2015-08-02 05:07:55 +00:00
|
|
|
|
|
2016-02-16 04:11:05 +00:00
|
|
|
|
The `buttons` is an array of `Button` objects:
|
|
|
|
|
|
|
|
|
|
* `Button` Object
|
|
|
|
|
* `icon` [NativeImage](native-image.md) - The icon showing in thumbnail
|
|
|
|
|
toolbar.
|
|
|
|
|
* `click` Function
|
|
|
|
|
* `tooltip` String (optional) - The text of the button's tooltip.
|
|
|
|
|
* `flags` Array (optional) - Control specific states and behaviors of the
|
|
|
|
|
button. By default, it is `['enabled']`.
|
|
|
|
|
|
|
|
|
|
The `flags` is an array that can include following `String`s:
|
|
|
|
|
|
|
|
|
|
* `enabled` - The button is active and available to the user.
|
|
|
|
|
* `disabled` - The button is disabled. It is present, but has a visual state
|
|
|
|
|
indicating it will not respond to user action.
|
|
|
|
|
* `dismissonclick` - When the button is clicked, the thumbnail window closes
|
|
|
|
|
immediately.
|
|
|
|
|
* `nobackground` - Do not draw a button border, use only the image.
|
|
|
|
|
* `hidden` - The button is not shown to the user.
|
|
|
|
|
* `noninteractive` - The button is enabled but not interactive; no pressed
|
|
|
|
|
button state is drawn. This value is intended for instances where the button
|
|
|
|
|
is used in a notification.
|
|
|
|
|
|
2016-07-14 22:54:57 +00:00
|
|
|
|
#### `win.setThumbnailClip(region)` _Windows_
|
|
|
|
|
|
2016-08-22 18:47:55 +00:00
|
|
|
|
* `region` Object - Region of the window
|
2016-07-14 23:02:06 +00:00
|
|
|
|
* `x` Integer - x-position of region
|
|
|
|
|
* `y` Integer - y-position of region
|
|
|
|
|
* `width` Integer - width of region
|
|
|
|
|
* `height` Integer - height of region
|
2016-07-14 22:54:57 +00:00
|
|
|
|
|
|
|
|
|
Sets the region of the window to show as the thumbnail image displayed when
|
2016-07-15 16:30:42 +00:00
|
|
|
|
hovering over the window in the taskbar. You can reset the thumbnail to be
|
|
|
|
|
the entire window by specifying an empty region:
|
|
|
|
|
`{x: 0, y: 0, width: 0, height: 0}`.
|
2016-07-14 22:54:57 +00:00
|
|
|
|
|
2016-08-07 17:23:42 +00:00
|
|
|
|
#### `win.setThumbnailToolTip(toolTip)` _Windows_
|
|
|
|
|
|
|
|
|
|
* `toolTip` String
|
|
|
|
|
|
|
|
|
|
Sets the toolTip that is displayed when hovering over the window thumbnail
|
|
|
|
|
in the taskbar.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.showDefinitionForSelection()` _macOS_
|
2014-12-18 23:40:35 +00:00
|
|
|
|
|
2016-06-07 20:09:54 +00:00
|
|
|
|
Same as `webContents.showDefinitionForSelection()`.
|
2014-12-19 20:48:53 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setIcon(icon)` _Windows_ _Linux_
|
2016-05-20 13:22:15 +00:00
|
|
|
|
|
|
|
|
|
* `icon` [NativeImage](native-image.md)
|
|
|
|
|
|
|
|
|
|
Changes window icon.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setAutoHideMenuBar(hide)`
|
2014-11-12 12:49:38 +00:00
|
|
|
|
|
|
|
|
|
* `hide` Boolean
|
|
|
|
|
|
|
|
|
|
Sets whether the window menu bar should hide itself automatically. Once set the
|
|
|
|
|
menu bar will only show when users press the single `Alt` key.
|
|
|
|
|
|
|
|
|
|
If the menu bar is already visible, calling `setAutoHideMenuBar(true)` won't
|
|
|
|
|
hide it immediately.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isMenuBarAutoHide()`
|
2014-11-12 12:49:38 +00:00
|
|
|
|
|
|
|
|
|
Returns whether menu bar automatically hides itself.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setMenuBarVisibility(visible)`
|
2014-11-12 12:49:38 +00:00
|
|
|
|
|
|
|
|
|
* `visible` Boolean
|
|
|
|
|
|
|
|
|
|
Sets whether the menu bar should be visible. If the menu bar is auto-hide, users
|
|
|
|
|
can still bring up the menu bar by pressing the single `Alt` key.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isMenuBarVisible()`
|
2014-11-12 12:49:38 +00:00
|
|
|
|
|
|
|
|
|
Returns whether the menu bar is visible.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setVisibleOnAllWorkspaces(visible)`
|
2015-03-26 10:59:24 +00:00
|
|
|
|
|
|
|
|
|
* `visible` Boolean
|
|
|
|
|
|
|
|
|
|
Sets whether the window should be visible on all workspaces.
|
|
|
|
|
|
2015-03-27 11:41:07 +00:00
|
|
|
|
**Note:** This API does nothing on Windows.
|
2015-03-26 10:59:24 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.isVisibleOnAllWorkspaces()`
|
2015-03-26 10:59:24 +00:00
|
|
|
|
|
|
|
|
|
Returns whether the window is visible on all workspaces.
|
|
|
|
|
|
2015-03-29 12:40:02 +00:00
|
|
|
|
**Note:** This API always returns false on Windows.
|
2015-12-09 04:05:47 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setIgnoreMouseEvents(ignore)`
|
2015-12-09 04:05:47 +00:00
|
|
|
|
|
|
|
|
|
* `ignore` Boolean
|
|
|
|
|
|
2016-06-07 11:32:52 +00:00
|
|
|
|
Makes the window ignore all mouse events.
|
|
|
|
|
|
2016-06-08 02:03:01 +00:00
|
|
|
|
All mouse events happened in this window will be passed to the window below
|
2016-06-07 11:32:52 +00:00
|
|
|
|
this window, but if this window has focus, it will still receive keyboard
|
|
|
|
|
events.
|
2016-01-07 06:10:18 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setContentProtection(enable)` _macOS_ _Windows_
|
2016-06-22 08:40:01 +00:00
|
|
|
|
|
2016-08-25 17:52:19 +00:00
|
|
|
|
* `enable` Boolean
|
|
|
|
|
|
2016-06-22 08:40:01 +00:00
|
|
|
|
Prevents the window contents from being captured by other apps.
|
|
|
|
|
|
|
|
|
|
On macOS it sets the NSWindow's sharingType to NSWindowSharingNone.
|
2016-08-18 05:42:10 +00:00
|
|
|
|
On Windows it calls SetWindowDisplayAffinity with `WDA_MONITOR`.
|
2016-06-22 08:40:01 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setFocusable(focusable)` _Windows_
|
2016-06-12 18:20:25 +00:00
|
|
|
|
|
2016-06-13 08:24:45 +00:00
|
|
|
|
* `focusable` Boolean
|
2016-06-13 07:40:02 +00:00
|
|
|
|
|
2016-06-13 08:24:45 +00:00
|
|
|
|
Changes whether the window can be focused.
|
2016-06-12 18:20:25 +00:00
|
|
|
|
|
2016-06-07 20:55:44 +00:00
|
|
|
|
[blink-feature-string]: https://cs.chromium.org/chromium/src/third_party/WebKit/Source/platform/RuntimeEnabledFeatures.in
|
2016-06-20 02:06:48 +00:00
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.setParentWindow(parent)` _Linux_ _macOS_
|
2016-06-20 02:06:48 +00:00
|
|
|
|
|
|
|
|
|
* `parent` BrowserWindow
|
|
|
|
|
|
|
|
|
|
Sets `parent` as current window's parent window, passing `null` will turn
|
|
|
|
|
current window into a top-level window.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.getParentWindow()`
|
2016-06-20 02:06:48 +00:00
|
|
|
|
|
|
|
|
|
Returns the parent window.
|
|
|
|
|
|
2016-07-13 04:42:08 +00:00
|
|
|
|
#### `win.getChildWindows()`
|
2016-06-20 02:06:48 +00:00
|
|
|
|
|
|
|
|
|
Returns all child windows.
|