BaseWindowConstructorOptions オブジェクト

• width Integer (任意) - ピクセル単位でのウインドウの幅。 省略値は 800 です。
• height Integer (任意) - ピクセル単位でのウインドウの高さ。 省略値は 600 です。
• x Integer (任意) - (y が使われている場合は 必須) ウインドウの画面左側のオフセット。 省略すると、ウインドウは中央に配置されます。
• y Integer (任意) - (x が使われている場合は 必須) ウインドウの画面上側のオフセット。 省略すると、ウインドウは中央に配置されます。
• useContentSize Boolean (任意) - width と height を、ウェブページのサイズに使用します。このとき、実際のウインドウのサイズにはウインドウ枠のサイズが含まれるので、若干大きくなります。 省略値は false です。
• center boolean (任意) - ウインドウを画面中央に表示します。 省略値は false です。
• minWidth Integer (任意) - ウインドウの最小の幅。 省略値は 0 です。
• minHeight Integer (任意) - ウィンドウの最小の高さ。 省略値は 0 です。
• minWidth Integer (任意) - ウインドウの最小の幅。 省略すると無制限です。
• maxHeight Integer (任意) - ウインドウの最大の高さ。 省略すると無制限です。
• resizable boolean (任意) - ウインドウがリサイズ可能かどうか。 省略値は true です。
• movable boolean (任意) macOS Windows - ウインドウが移動可能かどうか。 これは Linux では実装されていません。 省略値は true です。
• minimizable boolean (任意) macOS Windows - ウインドウが最小化可能かどうか。 これは Linux では実装されていません。 省略値は true です。
• maximizable boolean (任意) macOS Windows - ウインドウが最大化可能かどうか。 これは Linux では実装されていません。 省略値は true です。
• closable boolean (任意) macOS Windows - ウインドウが閉じられるかどうか。 これは Linux では実装されていません。 省略値は true です。
• focusable boolean (任意) - ウインドウにフォーカスを当てられるかどうか。 省略値は true です。 Windows では、focusable: false と設定することは、skipTaskbar: true と設定することにもなります。 Linuxでは、focusable: false と設定することは、ウインドウがウインドウマネージャとのやり取りを停止することになるため、ウインドウがすべてのワークスペースで常に前面に表示されます。
• alwaysOnTop boolean (任意) - ウインドウを常に他のウインドウの前面に表示させるかどうか。 省略値は false です。
• fullscreen boolean (任意) - ウインドウをフルスクリーンで表示させるかどうか。 明示的に false を設定した場合、macOS では、フルスクリーンボタンが非表示または無効になります。 省略値は false です。
• fullscreenable boolean (任意) - ウインドウをフルスクリーンモードにできるかどうか。 macOS では、最大化/ズームボタンでフルスクリーンモードを切り替えるか、それともウィンドウの最大化をするのかも意味します。 省略値は true です。
• simpleFullscreen boolean (任意) macOS - macOS で Lion 以前のフルスクリーンを使用します。 省略値は false です。
• skipTaskbar boolean (任意) macOS Windows - タスクバー内でウインドウを表示するかどうか。 省略値は false です。
• hiddenInMissionControl boolean (任意) macOS - ユーザが Mission Control に切り替えたときに、ウインドウを隠すかどうか。
• kiosk boolean (任意) - ウインドウがキオスクモードかどうか。 省略値は false です。
• title string (任意) - デフォルトのウインドウのタイトル。 省略値は "Electron" です。 HTML タグの <title> が loadURL() でロードされた HTML ファイル内で定義されている場合、このプロパティは無視されます。
• icon (NativeImage | string) (optional) - The window icon. Windows では、最高の視覚効果を得るために ICO アイコンを使用することを推奨します。また、undefined のままにして、実行形式のアイコンを使用することもできます。
• show boolean (任意) - 生成時にウインドウを表示するかどうか。 省略値は true です。
• frame boolean (optional) - Specify false to create a frameless window. 省略値は true です。
• parent BaseWindow (任意) - 親ウインドウを指定します。 省略値は null です。
• modal boolean (任意) - このウインドウをモーダルにするかどうか。 これは、このウインドウが子ウインドウの場合にのみ機能します。 省略値は false です。
• acceptFirstMouse boolean (任意) macOS - 非アクティブなウィンドウをクリックすると、ウェブコンテンツにもクリックスルーするかどうか。 macOS での既定値は false です。 このオプションは他プラットフォームでは設定できません。
• disableAutoHideCursor boolean (任意) - タイプ中にカーソルを非表示にするかどうか。 省略値は false です。
• autoHideMenuBar boolean (optional) Linux Windows - Auto hide the menu bar unless the Alt key is pressed. 省略値は false です。
• enableLargerThanScreen boolean (任意) macOS - ウインドウを画面より大きいサイズへとリサイズできるようにします。 他の OS はデフォルトで画面よりも大きなウインドウを許可するため、これは macOS にのみ影響します。 省略値は false です。
• backgroundColor string (任意) - 16 進数、RGB、RGBA、HSL、HSLA、または名前付き CSS 色形式で表したウインドウの背景色。 #AARRGGBB 形式のアルファ値は transparent を true に設定した場合にサポートされます。 省略値は #FFF (白) です。 詳細は win.setBackgroundColor をご覧ください。
• hasShadow boolean (任意) - ウインドウに影を付けるかどうか。 省略値は true です。
• opacity number (任意) macOS Windows - ウインドウの初期不透明度を 0.0 (完全透明) と 1.0 (完全不透明) の間で設定します。 これは Windows と macOS でのみ実装されています。
• darkTheme boolean (任意) - ウインドウに対してダークテーマの使用を強制します。いくつかの GTK+3 デスクトップ環境でしか動作しません。 省略値は false です。
• transparent boolean (optional) - Makes the window transparent. 省略値は false です。 Windows では、ウィンドウがフレームレスでない限り機能しません。
• type string (任意) - ウインドウのタイプで、省略すると通常のウインドウになります。 詳しくは後述します。
• visualEffectState string (任意) macOS - macOS でウインドウの動作状態をマテリアルの見た目にどう反映させるかを指定します。 これは vibrancy プロパティと共に使用する必要があります。 以下は取りうる値です。
  • followWindow - 背景を、ウィンドウがアクティブなときにはアクティブに、そうでないときには非アクティブになるよう自動的に表示します。 これが既定値です。
  • active - 背景を常にアクティブに表示します。
  • inactive - 背景を常に非アクティブに表示します。
• titleBarStyle string (任意) - ウインドウのタイトルバーのスタイル。 省略値は default です。 以下は取りうる値です。
  • default - macOS や Windows それぞれの標準的なタイトルバーになります。
  • hidden - タイトルバーが隠れて、フルサイズのコンテンツのウインドウになります。 macOS では、ウインドウの左上に標準ウインドウコントロール ("信号機ボタン") が付きます。 Windows および Linux では、titleBarOverlay: true と組み合わせるとウィンドウコントロールオーバーレイがアクティブになります (詳細は titleBarOverlay を参照)。それ以外の場合、ウィンドウコントロールは非表示です。
  • hiddenInset macOS - タイトルバーが非表示になり、信号機ボタンがウィンドウの端から少し内側に配置される別種の見た目になります。
  • customButtonsOnHover macOS - タイトルバーが非表示になり、コンテンツウィンドウがフルサイズで表示されます。ウィンドウの左上にマウスを移動すると、信号機ボタンが表示されます。 注: 現在、このオプションは実験的なものです。
• titleBarOverlay Object | Boolean (任意) - macOS で win.setWindowButtonVisibility(true) と組み合わせてフレームレスウインドウを使用する場合、または titleBarStyle を使用して標準のウインドウコントロール (macOS では「信号機ボタン」) が表示されるようにする場合、このプロパティによってウインドウコントロールオーバーレイの JavaScript API と CSS 環境変数 が有効になります。 true を指定すると、オーバーレイはデフォルトのシステムカラーになります。 省略値は false です。
  • color String (任意) Windows Linux - 有効になっている場合のウインドウコントロールオーバーレイの CSS カラー。 既定値はシステムカラーです。
  • symbolColor String (optional) Windows Linux - The CSS color of the symbols on the Window Controls Overlay when enabled. 既定値はシステムカラーです。
  • height Integer (任意) - ピクセル単位のタイトルバーとウインドウコントロールオーバーレイの高さ。 既定値はシステムの高さです。
• accentColor boolean | string (optional) Windows - The accent color for the window. By default, follows user preference in System Settings. Set to false to explicitly disable, or set the color in Hex, RGB, RGBA, HSL, HSLA or named CSS color format. Alpha values will be ignored.
• trafficLightPosition Point (optional) macOS - Set a custom position for the traffic light buttons in frameless windows.
• roundedCorners boolean (optional) macOS Windows - Whether frameless window should have rounded corners. 省略値は true です。 Setting this property to false will prevent the window from being fullscreenable on macOS. On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have rounded corners.
• thickFrame boolean (任意) - Windows で WS_THICKFRAME スタイルのフレームレスウインドウを使用します。これにより、標準のウィンドウ フレームが追加されます。 false に設定すると、ウインドウの影とウインドウのアニメーションがなくなります。 省略値は true です。
• vibrancy string (任意) macOS - macOS でのみ、ウインドウにくもりガラスのエフェクトを追加します。 appearance-based, titlebar, selection, menu, popover, sidebar, header, sheet, window, hud, fullscreen-ui, tooltip, content, under-window, under-page のいずれかにできます。
• backgroundMaterial string (任意) Windows - 非クライアント領域の背後を含む、ウインドウのシステム描画の背景マテリアルを設定します。 auto, none, mica, acrylic, tabbed のいずれかです。 詳細は win.setBackgroundMaterial をご覧ください。
• zoomToPageWidth boolean (任意) macOS - ツールバーの緑色の信号機ボタンを option キーを押しながらクリックしたとき、またはウインドウ > ズームのメニュー項目をクリックしたときの macOS の動作を制御します。 true の場合、ズームしたときウインドウはウェブページの最適な幅に拡大されます。false では画面の幅にズームされます。 これは、maximize() を直接呼び出したときの動作にも影響を与えます。 省略値は false です。
• tabbingIdentifier string (任意) macOS - タブグループ名。これはウインドウをネイティブのタブとして開けるようにします。 同一のタブ識別子を持つウインドウは、まとめてグループ化されます。 これはネイティブのタブボタンをウインドウのタブバーに追加し、app とウインドウが new-window-for-tab イベントを受け取ることができるようになります。

minWidth/maxWidth/minHeight/maxHeight で最小もしくは最大のウインドウサイズを設定するのは、ユーザを束縛するだけです。 サイズ制約に従わないサイズを setBounds/setSize や BrowserWindow のコンストラクタに渡しても構いません。

type オプションに設定できる値と動作は、プラットフォーム依存です。 以下は取りうる値です。

• Linux では、設定できる値は desktop, dock, toolbar, splash, notification です。
  • desktop タイプは、ウインドウをデスクトップのバックグラウンドウインドウのレベル (kCGDesktopWindowLevel - 1) に配置します。 ただし、デスクトップウインドウはフォーカス、キーボード、マウスのイベントを受け取らないことに注意してください。 globalShortcut を使用すれば、辛うじて入力を受け取れます。
  • dock タイプは、Dock のようなウインドウの動作を生成します。
  • toolbar タイプは、ツールバーの見た目でウインドウを生成します。
  • splash タイプは特殊な動作をします。 たとえウインドウ本文の CSS スタイルが -webkit-app-region: drag であっても、ドラッグできません。 このタイプは主にスプラッシュスクリーンで使用されます。
  • notification タイプはシステム通知の様に動作するウインドウを作成します。
• macOS では、設定できるタイプは desktop, textured, panel です。
  • The textured type adds metal gradient appearance. This option is deprecated.
  • desktop タイプは、ウインドウをデスクトップのバックグラウンドウインドウのレベル (kCGDesktopWindowLevel - 1) に配置します。 デスクトップウインドウはフォーカス、キーボードやマウスイベントを受け付けないことに注意してください。しかし globalShortcut を使って、かろうじて入力を受け付けることはできます。
  • The panel type enables the window to float on top of full-screened apps by adding the NSWindowStyleMaskNonactivatingPanel style mask, normally reserved for NSPanel, at runtime. また、すべてのスペース (デスクトップ) にそのウインドウが表示されます。
• Windows では、設定できるタイプは toolbar です。