Electron BrowserWindow 模块

OStack程序员社区-中国程序员成长平台 › 门户 › 编程› 开发工具›Electron 中文文档

原作者: [db:作者] 来自: [db:来源] 收藏邀请

BrowserWindow 类让你有创建一个浏览器窗口的权力。例如:

// In the main process.
const BrowserWindow = require('electron').BrowserWindow;

// Or in the renderer process.
const BrowserWindow = require('electron').remote.BrowserWindow;

var win = new BrowserWindow({ width: 800, height: 600, show: false });
win.on('closed', function() {
  win = null;
});

win.loadURL('https://github.com');
win.show();

你也可以不通过chrome创建窗口，使用 Frameless Window API.

Class: BrowserWindow

BrowserWindow 是一个 EventEmitter.

通过 options 可以创建一个具有本质属性的 BrowserWindow 。

new BrowserWindow([options])

options Object
- width Integer - 窗口宽度,单位像素. 默认是 800。
- height Integer - 窗口高度,单位像素. 默认是 600。
- x Integer - 窗口相对于屏幕的左偏移位置.默认居中。
- y Integer - 窗口相对于屏幕的顶部偏移位置.默认居中。
- useContentSize Boolean - width 和 height 使用web网页size, 这意味着实际窗口的size应该包括窗口框架的size，稍微会大一点，默认为 false。
- center Boolean - 窗口屏幕居中。
- minWidth Integer - 窗口最小宽度，默认为 0。
- minHeight Integer - 窗口最小高度，默认为 0。
- maxWidth Integer - 窗口最大宽度，默认无限制。
- maxHeight Integer - 窗口最大高度，默认无限制。
- resizable Boolean - 是否可以改变窗口size，默认为 true。
- movable Boolean - 窗口是否可以拖动. 在 Linux 上无效. 默认为 true。
- minimizable Boolean - 窗口是否可以最小化. 在 Linux 上无效. 默认为 true。
- maximizable Boolean - 窗口是否可以最大化. 在 Linux 上无效. 默认为 true。
- closable Boolean - 窗口是否可以关闭. 在 Linux 上无效. 默认为 true。
- alwaysOnTop Boolean - 窗口是否总是显示在其他窗口之前. 在 Linux 上无效. 默认为 false。
- fullscreen Boolean - 窗口是否可以全屏幕. 当明确设置值为When false ，全屏化按钮将会隐藏，在 OS X 将禁用. 默认 false。
- fullscreenable Boolean - 在 OS X 上，全屏化按钮是否可用，默认为 true。
- skipTaskbar Boolean - 是否在任务栏中显示窗口. 默认是false。
- kiosk Boolean - kiosk 方式. 默认为 false。
- title String - 窗口默认title. 默认 "Electron"。
- icon NativeImage - 窗口图标, 如果不设置，窗口将使用可用的默认图标。
- show Boolean - 窗口创建的时候是否显示. 默认为 true。
- frame Boolean - 指定 false 来创建一个 Frameless Window. 默认为 true。
- acceptFirstMouse Boolean - 是否允许单击web view来激活窗口。默认为 false。
- disableAutoHideCursor Boolean - 当 typing 时是否隐藏鼠标.默认 false。
- autoHideMenuBar Boolean - 除非点击 Alt，否则隐藏菜单栏.默认为 false。
- enableLargerThanScreen Boolean - 是否允许允许改变窗口大小大于屏幕. 默认是 false。
- backgroundColor String -窗口的 background color 值为十六进制，如 #66CD00 或 #FFF 或 #80FFFFFF (支持透明度)。默认为在 Linux 和 Windows 上为 #000 (黑色)，Mac上为 #FFF(或透明)。
- hasShadow Boolean - 窗口是否有阴影。只在 OS X 上有效. 默认为 true。
- darkTheme Boolean - 为窗口使用 dark 主题，只在一些拥有 GTK+3 桌面环境上有效. 默认为 false。
- transparent Boolean - 窗口透明。默认为 false。
- type String - 窗口type，默认普通窗口，下面查看更多。
- titleBarStyle String - 窗口标题栏样式，下面查看更多。
- webPreferences Object - 设置界面特性，下面查看更多。

type 的值和效果不同平台展示效果不同，具体:

Linux，可用值为 desktop， dock， toolbar， splash， notification。
OS X，可用值为 desktop， textured。
- textured type 添加金属梯度效果 (NSTexturedBackgroundWindowMask)。
- desktop 设置窗口在桌面背景窗口水平 (kCGDesktopWindowLevel - 1)。注意桌面窗口不可聚焦，不可不支持键盘和鼠标事件，但是可以使用 globalShortcut 来解决输入问题。

titleBarStyle 只在 OS X 10.10 Yosemite 或更新版本上支持，可用值：

default 以及无值, 显示在 Mac 标题栏上为不透明的标准灰色。
hidden 隐藏标题栏，内容充满整个窗口, 然后它依然在左上角，仍然受标准窗口控制。
hidden-inset主体隐藏，显示小的控制按钮在窗口边缘。

webPreferences 参数是个对象，它的属性：

nodeIntegration Boolean - 是否完整支持node。默认为 true。
preload String - 界面的其它脚本运行之前预先加载一个指定脚本。这个脚本将一直可以使用 node APIs 无论 node integration 是否开启。脚本路径为绝对路径。当 node integration 关闭，预加载的脚本将从全局范围重新引入node的全局引用标志。查看例子 here。
session Session - 设置界面session。而不是直接忽略session对象，也可用 partition 来代替，它接受一个 partition 字符串。当同时使用 session 和 partition， session 优先级更高. 默认使用默认 session。
partition String - 通过session的partition字符串来设置界面session. 如果 partition 以 persist:开头, 这个界面将会为所有界面使用相同的 partition. 如果没有 persist: 前缀, 界面使用历史session. 通过分享同一个 partition，所有界面使用相同的session. 默认使用默认 session.
zoomFactor Number - 界面默认缩放值，3.0 表示 300%. 默认 1.0.
javascript Boolean - 开启javascript支持. 默认为true.
webSecurity Boolean - 当设置为 false，它将禁用相同地方的规则 (通常测试服), 并且如果有2个非用户设置的参数，就设置 allowDisplayingInsecureContent 和 allowRunningInsecureContent 的值为true. 默认为 true.
allowDisplayingInsecureContent Boolean -允许一个使用 https的界面来展示由 http URLs 传过来的资源. 默认false.
allowRunningInsecureContent Boolean - Boolean -允许一个使用 https的界面来渲染由 http URLs 提交的html,css,javascript. 默认为 false。
images Boolean - 开启图片使用支持. 默认 true.
textAreasAreResizable Boolean - textArea 可以编辑. 默认为 true.
webgl Boolean - 开启 WebGL 支持. 默认为 true.
webaudio Boolean - 开启 WebAudio 支持. 默认为 true.
plugins Boolean - 是否开启插件支持. 默认为 false.
experimentalFeatures Boolean - 开启 Chromium 的可测试特性. 默认为 false.
experimentalCanvasFeatures Boolean - 开启 Chromium 的 canvas 可测试特性. 默认为 false.
directWrite Boolean - 开启窗口的 DirectWrite font 渲染系统. 默认为 true.
blinkFeatures String - 以 , 分隔的特性列表, 如 CSSVariables,KeyboardEventKey. 被支持的所有特性可在 setFeatureEnabledFromString 中找到.
defaultFontFamily Object - 设置 font-family 默认字体.
- standard String - 默认为 Times New Roman.
- serif String - 默认为 Times New Roman.
- sansSerif String - 默认为 Arial.
- monospace String - 默认为 Courier New.
defaultFontSize Integer - 默认为 16.
defaultMonospaceFontSize Integer - 默认为 13.
minimumFontSize Integer - 默认为 0.
defaultEncoding String - 默认为 ISO-8859-1.