electron/docs/api/browser-window.md

941 lines
28 KiB
Markdown
Raw Normal View History

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
// In the main process.
const {BrowserWindow} = require('electron');
2013-08-14 22:43:35 +00:00
// Or in the renderer process.
const {BrowserWindow} = require('electron').remote;
let win = new BrowserWindow({width: 800, height: 600, show: false});
win.on('closed', () => {
2013-08-14 22:43:35 +00:00
win = null;
});
2015-11-13 08:03:40 +00:00
win.loadURL('https://github.com');
2013-08-14 22:43:35 +00:00
win.show();
```
2015-08-20 17:03:53 +00:00
You can also create a window without chrome by using
2013-09-09 06:52:46 +00:00
[Frameless Window](frameless-window.md) API.
2013-08-14 22:43:35 +00:00
## Class: BrowserWindow
`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
* `options` Object
* `width` Integer - Window's width in pixels. Default is `800`.
* `height` Integer - Window's height in pixels. Default is `600`.
* `x` Integer - Window's left offset from screen. Default is to center the
window.
* `y` Integer - Window's top offset from screen. Default is to center the
window.
* `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`.
* `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
on OS X. Default is `false`.
2016-01-22 22:31:59 +00:00
* `fullscreenable` Boolean - Whether the maximize/zoom button on OS X should
toggle full screen mode or maximize window. Default is `true`.
* `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.
* `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`.
* `acceptFirstMouse` Boolean - Whether the web view accepts a single
mouse-down event that simultaneously activates the window. Default is
`false`.
* `disableAutoHideCursor` Boolean - Whether to hide cursor when typing.
Default is `false`.
* `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).
* `hasShadow` Boolean - Whether window should have a shadow. This is only
2016-01-23 00:37:05 +00:00
implemented on OS X. Default is `true`.
* `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.
* `titleBarStyle` String - The style of window title bar. See more about this
2016-01-15 12:43:44 +00:00
below.
* `webPreferences` Object - Settings of web page's features. See more about
2016-01-15 12:43:44 +00:00
this below.
When setting minimum or maximum window size with `minWidth`/`maxWidth`/
`minHeight`/`maxHeight`, it only constrains the users, it won't prevent you from
passing a size that does not follow size constraints to `setBounds`/`setSize` or
to the constructor of `BrowserWindow`.
The possible values and behaviors of `type` option are platform dependent,
supported values are:
* On Linux, possible types are `desktop`, `dock`, `toolbar`, `splash`,
`notification`.
* On OS X, possible types are `desktop`, `textured`.
* 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.
The `titleBarStyle` option is only supported on OS X 10.10 Yosemite and newer.
Possible values are:
* `default` or not specified, results in the standard gray opaque Mac title
bar.
* `hidden` results in a hidden title bar and a full size content window, yet
the title bar still has the standard window controls ("traffic lights") in
the top left.
* `hidden-inset` results in a hidden title bar with an alternative look
where the traffic light buttons are slightly more inset from the window edge.
The `webPreferences` option is an object that can have following properties:
* `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
both `session` and `partition` are provided, `session` would be preferred.
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
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. Default is the default session.
* `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`.
* `webSecurity` Boolean - When setting `false`, it will disable the
same-origin policy (Usually using testing websites by people), and set
`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`.
* `allowRunningInsecureContent` Boolean - Allow a https page to run
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`.
* `directWrite` Boolean - Enables DirectWrite font rendering system on
Windows. Default is `true`.
* `scrollBounce` Boolean - Enables scroll bounce (rubber banding) effect on
OS X. Default is `false`.
* `blinkFeatures` String - A list of feature strings separated by `,`, like
`CSSVariables,KeyboardEventKey`. The full list of supported feature strings
can be found in the [setFeatureEnabledFromString][blink-feature-string]
function.
* `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`.
* `backgroundThrottling` Boolean - Whether to throttle animations and timers
when the page becomes background. Defaults to `true`.
2015-08-20 13:17:53 +00:00
## Events
The `BrowserWindow` object emits the following events:
2013-08-14 22:43:35 +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
2013-08-14 22:43:35 +00:00
### Event: 'page-title-updated'
2015-08-20 13:17:53 +00:00
Returns:
2013-08-14 22:43:35 +00:00
* `event` Event
Emitted when the document changed its title, calling `event.preventDefault()`
would prevent the native window's title to change.
2013-08-14 22:43:35 +00:00
### Event: 'close'
2015-08-20 13:17:53 +00:00
Returns:
2013-08-14 22:43:35 +00:00
* `event` Event
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
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
2015-04-16 03:31:12 +00:00
reloaded. In Electron, returning an empty string or `false` would cancel the
2015-08-20 13:17:53 +00:00
close. For example:
2013-08-14 22:43:35 +00:00
```javascript
window.onbeforeunload = (e) => {
2013-08-14 22:43:35 +00:00
console.log('I do not want to be closed');
// Unlike usual browsers, in which a string should be returned and the user is
// prompted to confirm the page unload, Electron gives developers more options.
// Returning empty string or false would prevent the unloading now.
// You can also use the dialog API to let the user confirm closing the application.
e.returnValue = false;
2013-08-14 22:43:35 +00:00
};
```
### Event: 'closed'
Emitted when the window is closed. After you have received this event you should
remove the reference to the window and avoid using it anymore.
2013-08-14 22:43:35 +00:00
2014-01-15 14:42:47 +00:00
### Event: 'unresponsive'
2014-05-07 06:34:53 +00:00
Emitted when the web page becomes unresponsive.
2014-01-15 14:42:47 +00:00
### Event: 'responsive'
Emitted when the unresponsive web page becomes responsive again.
### Event: 'blur'
2015-08-20 13:17:53 +00:00
Emitted when the window loses focus.
2014-01-15 14:42:47 +00:00
### Event: 'focus'
2015-08-20 13:17:53 +00:00
Emitted when the window gains focus.
### Event: 'show'
Emitted when the window is shown.
### Event: 'hide'
Emitted when the window is hidden.
2014-11-25 06:43:11 +00:00
### Event: 'maximize'
Emitted when window is maximized.
### Event: 'unmaximize'
2015-08-20 13:17:53 +00:00
Emitted when the window exits from maximized state.
2014-11-25 06:43:11 +00:00
### Event: 'minimize'
2015-08-20 13:17:53 +00:00
Emitted when the window is minimized.
2014-11-25 06:43:11 +00:00
### Event: 'restore'
2015-08-20 13:17:53 +00:00
Emitted when the window is restored from minimized state.
2014-11-25 06:43:11 +00:00
2015-05-09 15:55:10 +00:00
### Event: 'resize'
2015-08-20 13:17:53 +00:00
Emitted when the window is getting resized.
2015-05-09 15:55:10 +00:00
### Event: 'move'
2015-05-20 08:37:13 +00:00
Emitted when the window is getting moved to a new position.
__Note__: On OS X this event is just an alias of `moved`.
2015-08-26 21:05:47 +00:00
### Event: 'moved' _OS X_
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
2014-11-25 06:43:11 +00:00
### Event: 'enter-full-screen'
2015-08-20 13:17:53 +00:00
Emitted when the window enters full screen state.
2014-11-25 06:43:11 +00:00
### Event: 'leave-full-screen'
2015-08-20 13:17:53 +00:00
Emitted when the window leaves full screen state.
2014-11-25 06:43:11 +00:00
### Event: 'enter-html-full-screen'
2015-08-20 13:17:53 +00:00
Emitted when the window enters full screen state triggered by html api.
### Event: 'leave-html-full-screen'
2015-08-20 13:17:53 +00:00
Emitted when the window leaves full screen state triggered by html api.
2015-11-18 00:43:28 +00:00
### Event: 'app-command' _Windows_
2015-06-19 19:58:47 +00:00
Returns:
* `event` Event
* `command` String
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
Commands are lowercased with underscores replaced with hyphens and the
`APPCOMMAND_` prefix stripped off.
e.g. `APPCOMMAND_BROWSER_BACKWARD` is emitted as `browser-backward`.
2016-04-22 14:15:31 +00:00
```javascript
someWindow.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
2015-06-26 03:20:12 +00:00
if (cmd === 'browser-backward' && someWindow.webContents.canGoBack()) {
2015-06-19 19:58:47 +00:00
someWindow.webContents.goBack();
}
});
```
2016-01-25 07:02:43 +00:00
### Event: 'scroll-touch-begin' _OS X_
Emitted when scroll wheel event phase has begun.
### Event: 'scroll-touch-end' _OS X_
Emitted when scroll wheel event phase has ended.
### Event: 'swipe' _OS X_
Returns:
* `event` Event
* `direction` String
Emitted on 3-finger swipe. Possible directions are `up`, `right`, `down`, `left`.
2015-08-20 13:17:53 +00:00
## Methods
The `BrowserWindow` object has the following methods:
### `BrowserWindow.getAllWindows()`
Returns an array of all opened browser windows.
2015-08-20 13:17:53 +00:00
### `BrowserWindow.getFocusedWindow()`
2013-08-14 22:43:35 +00:00
Returns the window that is focused in this application, otherwise returns `null`.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +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
2015-08-20 13:17:53 +00:00
### `BrowserWindow.fromId(id)`
2014-05-22 01:56:04 +00:00
* `id` Integer
Find a window according to its ID.
2015-08-20 13:17:53 +00:00
### `BrowserWindow.addDevToolsExtension(path)`
* `path` String
2015-09-09 21:11:06 +00:00
Adds DevTools extension located at `path`, and returns extension's name.
The extension will be remembered so you only need to call this API once, this
API is not for programming use.
2015-08-20 13:17:53 +00:00
### `BrowserWindow.removeDevToolsExtension(name)`
* `name` String
2015-09-09 21:11:06 +00:00
Remove the DevTools extension whose name is `name`.
2015-09-09 20:57:35 +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
// In this example `win` is our instance
let win = new BrowserWindow({width: 800, height: 600});
2015-08-20 13:17:53 +00:00
```
2015-09-09 20:57:35 +00:00
### `win.webContents`
2013-08-14 22:43:35 +00:00
2014-04-25 09:15:26 +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
2015-09-09 20:57:35 +00:00
### `win.id`
The unique ID of this window.
## Instance Methods
Objects created with `new BrowserWindow` have the following instance methods:
**Note:** Some methods are only available on specific operating systems and are
labeled as such.
2015-09-09 20:57:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.destroy()`
2013-08-14 22:43:35 +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
2015-08-20 13:17:53 +00:00
### `win.close()`
2013-08-14 22:43:35 +00:00
Try to close the window, this has the same effect with 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
2015-08-20 13:17:53 +00:00
### `win.focus()`
2013-08-14 22:43:35 +00:00
Focus on the window.
2016-03-11 05:45:51 +00:00
### `win.blur()`
Remove focus on the window.
2015-08-20 13:17:53 +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
2015-08-20 13:17:53 +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.
2015-08-20 13:17:53 +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
2015-08-20 13:17:53 +00:00
### `win.hide()`
2013-08-14 22:43:35 +00:00
Hides the window.
2015-08-20 13:17:53 +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
2015-08-20 13:17:53 +00:00
### `win.maximize()`
2013-08-14 22:43:35 +00:00
Maximizes the window.
2015-08-20 13:17:53 +00:00
### `win.unmaximize()`
2013-08-14 22:43:35 +00:00
Unmaximizes the window.
2015-08-20 13:17:53 +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
2015-08-20 13:17:53 +00:00
### `win.minimize()`
2013-08-14 22:43:35 +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
2015-08-20 13:17:53 +00:00
### `win.restore()`
2013-08-14 22:43:35 +00:00
Restores the window from minimized state to its previous state.
2015-08-20 13:17:53 +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
2015-08-20 13:17:53 +00:00
### `win.setFullScreen(flag)`
2013-08-14 22:43:35 +00:00
* `flag` Boolean
Sets whether the window should be in fullscreen mode.
2015-08-20 13:17:53 +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
2015-08-24 22:55:53 +00:00
### `win.setAspectRatio(aspectRatio[, extraSize])` _OS X_
2015-08-24 22:41:02 +00:00
* `aspectRatio` The aspect ratio we want to maintain for some portion of the
content view.
2015-08-24 22:55:53 +00:00
* `extraSize` Object (optional) - The extra size not to be included while
maintaining the aspect ratio.
* `width` Integer
* `height` Integer
2015-08-24 22:41:02 +00:00
This will have a window maintain an aspect ratio. The extra size allows a
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-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.
2016-01-15 04:54:12 +00:00
### `win.setBounds(options[, animate])`
* `options` Object
* `x` Integer
* `y` Integer
* `width` Integer
* `height` Integer
* `animate` Boolean (optional) _OS X_
Resizes and moves the window to `width`, `height`, `x`, `y`.
2015-08-20 13:17:53 +00:00
### `win.getBounds()`
Returns an object that contains window's width, height, x and y values.
2016-01-15 04:54:12 +00:00
### `win.setSize(width, height[, animate])`
2013-08-14 22:43:35 +00:00
* `width` Integer
* `height` Integer
2016-01-15 04:54:12 +00:00
* `animate` Boolean (optional) _OS X_
2013-08-14 22:43:35 +00:00
Resizes the window to `width` and `height`.
2015-08-20 13:17:53 +00:00
### `win.getSize()`
2013-08-14 22:43:35 +00:00
Returns an array that contains window's width and height.
2016-01-15 04:54:12 +00:00
### `win.setContentSize(width, height[, animate])`
* `width` Integer
* `height` Integer
2016-01-15 04:54:12 +00:00
* `animate` Boolean (optional) _OS X_
Resizes the window's client area (e.g. the web page) to `width` and `height`.
2015-08-20 13:17:53 +00:00
### `win.getContentSize()`
Returns an array that contains window's client area's width and height.
2015-08-20 13:17:53 +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`.
2015-08-20 13:17:53 +00:00
### `win.getMinimumSize()`
2013-08-14 22:43:35 +00:00
Returns an array that contains window's minimum width and height.
2015-08-20 13:17:53 +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`.
2015-08-20 13:17:53 +00:00
### `win.getMaximumSize()`
2013-08-14 22:43:35 +00:00
Returns an array that contains window's maximum width and height.
2015-08-20 13:17:53 +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.
2015-08-20 13:17:53 +00:00
### `win.isResizable()`
2013-08-14 22:43:35 +00:00
Returns whether the window can be manually resized by user.
2016-01-19 15:07:51 +00:00
### `win.setMovable(movable)` _OS X_ _Windows_
* `movable` Boolean
Sets whether the window can be moved by user. On Linux does nothing.
### `win.isMovable()` _OS X_ _Windows_
Returns whether the window can be moved by user. On Linux always returns
`true`.
### `win.setMinimizable(minimizable)` _OS X_ _Windows_
* `minimizable` Boolean
Sets whether the window can be manually minimized by user. On Linux does
nothing.
### `win.isMinimizable()` _OS X_ _Windows_
Returns whether the window can be manually minimized by user. On Linux always
returns `true`.
2016-01-22 22:31:59 +00:00
### `win.setMaximizable(maximizable)` _OS X_ _Windows_
* `maximizable` Boolean
Sets whether the window can be manually maximized by user. On Linux does
nothing.
### `win.isMaximizable()` _OS X_ _Windows_
Returns whether the window can be manually maximized by user. On Linux always
returns `true`.
### `win.setFullScreenable(fullscreenable)`
2016-01-22 22:31:59 +00:00
* `fullscreenable` Boolean
Sets whether the maximize/zoom window button toggles fullscreen mode or
maximizes the window.
2016-01-22 22:31:59 +00:00
### `win.isFullScreenable()`
2016-01-22 22:31:59 +00:00
Returns whether the maximize/zoom window button toggles fullscreen mode or
maximizes the window.
2016-01-22 22:31:59 +00:00
2016-01-19 15:07:51 +00:00
### `win.setClosable(closable)` _OS X_ _Windows_
* `closable` Boolean
Sets whether the window can be manually closed by user. On Linux does nothing.
### `win.isClosable()` _OS X_ _Windows_
Returns whether the window can be manually closed by user. On Linux always
returns `true`.
2015-08-20 13:17:53 +00:00
### `win.setAlwaysOnTop(flag)`
2013-08-14 22:43:35 +00:00
* `flag` Boolean
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
2015-08-20 13:17:53 +00:00
### `win.isAlwaysOnTop()`
2013-08-14 22:43:35 +00:00
Returns whether the window is always on top of other windows.
2015-08-20 13:17:53 +00:00
### `win.center()`
2013-08-14 22:43:35 +00:00
Moves window to the center of the screen.
2016-01-15 04:54:12 +00:00
### `win.setPosition(x, y[, animate])`
2013-08-14 22:43:35 +00:00
* `x` Integer
* `y` Integer
2016-01-15 04:54:12 +00:00
* `animate` Boolean (optional) _OS X_
2013-08-14 22:43:35 +00:00
Moves window to `x` and `y`.
2015-08-20 13:17:53 +00:00
### `win.getPosition()`
2013-08-14 22:43:35 +00:00
Returns an array that contains window's current position.
2015-08-20 13:17:53 +00:00
### `win.setTitle(title)`
2013-08-14 22:43:35 +00:00
* `title` String
Changes the title of native window to `title`.
2015-08-20 13:17:53 +00:00
### `win.getTitle()`
2013-08-14 22:43:35 +00:00
Returns the title of the native window.
**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-05-20 03:26:46 +00:00
### `win.setSheetOffset(offsetY[, offsetX])` _OS X_
Changes the attachment point for sheets on Mac OS X. By default, sheets are
attached just below the window frame, but you may want to display them beneath
a HTML-rendered toolbar. For example:
2016-04-22 14:15:31 +00:00
```javascript
let toolbarRect = document.getElementById('toolbar').getBoundingClientRect();
win.setSheetOffset(toolbarRect.height);
```
2015-08-20 13:17:53 +00:00
### `win.flashFrame(flag)`
2014-08-28 08:00:29 +00:00
* `flag` Boolean
2013-08-14 22:43:35 +00:00
Starts or stops flashing the window to attract user's attention.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.setSkipTaskbar(skip)`
* `skip` Boolean
Makes the window not show in the taskbar.
2015-08-20 13:17:53 +00:00
### `win.setKiosk(flag)`
2013-08-14 22:43:35 +00:00
* `flag` Boolean
Enters or leaves the kiosk mode.
2015-08-20 13:17:53 +00:00
### `win.isKiosk()`
2013-08-14 22:43:35 +00:00
Returns whether the window is in kiosk mode.
2016-01-07 21:17:23 +00:00
### `win.getNativeWindowHandle()`
Returns the platform-specific handle of the window as `Buffer`.
The native type of the handle is `HWND` on Windows, `NSView*` on OS X, and
`Window` (`unsigned long`) on Linux.
2016-01-07 21:17:23 +00:00
2015-11-18 19:01:50 +00:00
### `win.hookWindowMessage(message, callback)` _Windows_
* `message` Integer
* `callback` Function
Hooks a windows message. The `callback` is called when
the message is received in the WndProc.
2015-11-18 19:01:50 +00:00
### `win.isWindowMessageHooked(message)` _Windows_
* `message` Integer
Returns `true` or `false` depending on whether the message is hooked.
2015-11-18 19:01:50 +00:00
### `win.unhookWindowMessage(message)` _Windows_
* `message` Integer
Unhook the window message.
2015-11-18 19:01:50 +00:00
### `win.unhookAllWindowMessages()` _Windows_
Unhooks all of the window messages.
2015-08-26 21:05:47 +00:00
### `win.setRepresentedFilename(filename)` _OS X_
* `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.
2015-08-26 21:05:47 +00:00
### `win.getRepresentedFilename()` _OS X_
2014-12-19 20:48:53 +00:00
Returns the pathname of the file the window represents.
2015-08-26 21:05:47 +00:00
### `win.setDocumentEdited(edited)` _OS X_
* `edited` Boolean
2014-12-19 20:48:53 +00:00
Specifies whether the windows 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
### `win.isDocumentEdited()` _OS X_
2014-12-19 20:48:53 +00:00
Whether the window's document has been edited.
2015-08-20 13:17:53 +00:00
### `win.focusOnWebView()`
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.blurWebView()`
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.capturePage([rect, ]callback)`
* `rect` Object (optional) - The area of page to be captured
2014-08-22 07:14:49 +00:00
* `x` Integer
* `y` Integer
* `width` Integer
* `height` Integer
* `callback` Function
Captures a snapshot of the page within `rect`. Upon completion `callback` will
be called with `callback(image)`. The `image` is an instance of
2015-08-20 13:17:53 +00:00
[NativeImage](native-image.md) that stores data of the snapshot. Omitting
`rect` will capture the whole visible page.
2015-08-20 13:17:53 +00:00
### `win.print([options])`
2014-08-22 07:14:49 +00:00
2015-08-20 13:17:53 +00:00
Same as `webContents.print([options])`
2015-05-23 13:39:59 +00:00
2015-08-20 13:17:53 +00:00
### `win.printToPDF(options, callback)`
2015-08-20 13:17:53 +00:00
Same as `webContents.printToPDF(options, callback)`
2015-11-13 08:03:40 +00:00
### `win.loadURL(url[, options])`
2013-08-14 22:43:35 +00:00
2015-11-13 08:03:40 +00:00
Same as `webContents.loadURL(url[, options])`.
2013-08-14 22:43:35 +00:00
2015-08-20 13:17:53 +00:00
### `win.reload()`
2015-08-20 13:17:53 +00:00
Same as `webContents.reload`.
2014-05-14 16:06:56 +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
2015-08-20 13:17:53 +00:00
### `win.setProgressBar(progress)`
2014-09-18 11:29:23 +00:00
* `progress` Double
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,
it will assume `app.getName().desktop`.
2014-09-18 11:29:23 +00:00
2015-08-26 21:05:47 +00:00
### `win.setOverlayIcon(overlay, description)` _Windows 7+_
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
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
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
### `win.setHasShadow(hasShadow)` _OS X_
* `hasShadow` (Boolean)
Sets whether the window should have a shadow. On Windows and Linux does
nothing.
### `win.hasShadow()` _OS X_
Returns whether the window has a shadow. On Windows and Linux always returns
`true`.
2015-02-07 01:11:54 +00:00
2015-08-26 21:05:47 +00:00
### `win.setThumbarButtons(buttons)` _Windows 7+_
2015-08-20 13:17:53 +00:00
* `buttons` Array
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.
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.
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.
2015-08-24 22:45:54 +00:00
### `win.showDefinitionForSelection()` _OS X_
2014-12-19 20:48:53 +00:00
Shows pop-up dictionary that searches the selected word on the page.
2016-05-20 13:22:15 +00:00
### `win.setIcon(icon)` _Windows_ _Linux_
* `icon` [NativeImage](native-image.md)
Changes window icon.
2015-08-20 13:17:53 +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.
2015-08-20 13:17:53 +00:00
### `win.isMenuBarAutoHide()`
2014-11-12 12:49:38 +00:00
Returns whether menu bar automatically hides itself.
2015-08-20 13:17:53 +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.
2015-08-20 13:17:53 +00:00
### `win.isMenuBarVisible()`
2014-11-12 12:49:38 +00:00
Returns whether the menu bar is visible.
2015-08-20 13:17:53 +00:00
### `win.setVisibleOnAllWorkspaces(visible)`
* `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-08-20 13:17:53 +00:00
### `win.isVisibleOnAllWorkspaces()`
Returns whether the window is visible on all workspaces.
**Note:** This API always returns false on Windows.
2015-12-09 04:05:47 +00:00
### `win.setIgnoreMouseEvents(ignore)` _OS X_
* `ignore` Boolean
Ignore all moused events that happened in the window.
2016-01-07 06:10:18 +00:00
[blink-feature-string]: https://code.google.com/p/chromium/codesearch#chromium/src/out/Debug/gen/blink/platform/RuntimeEnabledFeatures.cpp&sq=package:chromium&type=cs&l=576