本文へスキップ

BaseWindowConstructorOptions オブジェクト

  • width 整数 (オプション) - ウィンドウの幅（ピクセル単位）。デフォルトは800。
  • height 整数 (オプション) - ウィンドウの高さ（ピクセル単位）。デフォルトは600。
  • x 整数 (オプション) - (y が使用されている場合は必須) 画面からのウィンドウの左側のオフセット。デフォルトではウィンドウを中央に配置します。
  • y 整数 (オプション) - (x が使用されている場合は必須) 画面からのウィンドウの上側のオフセット。デフォルトではウィンドウを中央に配置します。
  • useContentSize ブール値 (オプション) - width と height はウェブページのサイズとして使用されます。つまり、実際のウィンドウのサイズはウィンドウフレームのサイズを含み、わずかに大きくなります。デフォルトはfalse。
  • center ブール値 (オプション) - ウィンドウを画面の中央に表示します。デフォルトはfalse。
  • minWidth 整数 (オプション) - ウィンドウの最小幅。デフォルトは0。
  • minHeight 整数 (オプション) - ウィンドウの最小高さ。デフォルトは0。
  • maxWidth 整数 (オプション) - ウィンドウの最大幅。デフォルトは制限なし。
  • maxHeight 整数 (オプション) - ウィンドウの最大高さ。デフォルトは制限なし。
  • resizable ブール値 (オプション) - ウィンドウがサイズ変更可能かどうか。デフォルトはtrue。
  • movable ブール値 (オプション) macOS Windows - ウィンドウが移動可能かどうか。Linuxでは実装されていません。デフォルトはtrue。
  • minimizable ブール値 (オプション) macOS Windows - ウィンドウが最小化可能かどうか。Linuxでは実装されていません。デフォルトはtrue。
  • maximizable ブール値 (オプション) macOS Windows - ウィンドウが最大化可能かどうか。Linuxでは実装されていません。デフォルトはtrue。
  • closable ブール値 (オプション) macOS Windows - ウィンドウが閉じられるかどうか。Linuxでは実装されていません。デフォルトはtrue。
  • focusable ブール値 (オプション) - ウィンドウにフォーカスできるかどうか。デフォルトはtrue。Windowsでは、focusable: false を設定すると、skipTaskbar: true も設定されます。Linuxでは、focusable: false を設定すると、ウィンドウはwmとの相互作用を停止するため、ウィンドウは常にすべてのワークスペースで最前面に表示されます。
  • alwaysOnTop ブール値 (オプション) - ウィンドウを常に他のウィンドウの上に表示するかどうか。デフォルトはfalse。
  • fullscreen ブール値 (オプション) - ウィンドウをフルスクリーンで表示するかどうか。明示的にfalseに設定すると、macOSではフルスクリーンボタンが非表示または無効になります。デフォルトはfalse。
  • fullscreenable ブール値 (オプション) - ウィンドウをフルスクリーンモードにできるかどうか。macOSでは、最大化/ズームボタンがフルスクリーンモードを切り替えるか、ウィンドウを最大化するかも決定します。デフォルトはtrue。
  • simpleFullscreen ブール値 (オプション) macOS - macOSでLion以前のフルスクリーンを使用します。デフォルトはfalse。
  • skipTaskbar ブール値 (オプション) macOS Windows - タスクバーにウィンドウを表示するかどうか。デフォルトはfalse。
  • hiddenInMissionControl ブール値 (オプション) macOS - ユーザーがMission Controlに切り替えたときにウィンドウを非表示にするかどうか。
  • kiosk ブール値 (オプション) - ウィンドウがキオスクモードかどうか。デフォルトはfalse。
  • title 文字列 (オプション) - デフォルトのウィンドウタイトル。デフォルトは"Electron"。loadURL()で読み込まれたHTMLファイルでHTMLタグ<title>が定義されている場合、このプロパティは無視されます。
  • icon (NativeImage | 文字列) (オプション) - ウィンドウアイコン。Windowsでは、最適な視覚効果を得るためにICOアイコンを使用することをお勧めします。実行ファイルのアイコンを使用することもできます。
  • show ブール値 (オプション) - 作成時にウィンドウを表示するかどうか。デフォルトはtrue。
  • frame ブール値 (オプション) - フレームレスウィンドウを作成するにはfalseを指定します。デフォルトはtrue。
  • parent BaseWindow (オプション) - 親ウィンドウを指定します。デフォルトはnull。
  • modal ブール値 (オプション) - モーダルウィンドウかどうか。これは、ウィンドウが子ウィンドウの場合にのみ機能します。デフォルトはfalse。
  • acceptFirstMouse ブール値 (オプション) macOS - 非アクティブなウィンドウをクリックすると、ウェブコンテンツにもクリックが伝わるかどうか。macOSではデフォルトはfalseです。このオプションは他のプラットフォームでは設定できません。
  • disableAutoHideCursor ブール値 (オプション) - 入力中にカーソルを非表示にするかどうか。デフォルトはfalse。
  • autoHideMenuBar ブール値 (オプション) - Altキーが押されていない限り、メニューバーを自動的に非表示にします。デフォルトはfalse。
  • enableLargerThanScreen ブール値 (オプション) macOS - ウィンドウを画面よりも大きくサイズ変更できるようにします。他のOSではデフォルトで画面よりも大きなウィンドウが許可されているため、macOSでのみ関連します。デフォルトはfalse。
  • backgroundColor 文字列 (オプション) - ウィンドウの背景色（16進数、RGB、RGBA、HSL、HSLA、または名前付きCSSカラー形式）。transparentがtrueに設定されている場合、#AARRGGBB形式のアルファがサポートされます。デフォルトは#FFF（白）。詳細はwin.setBackgroundColorを参照してください。
  • hasShadow ブール値 (オプション) - ウィンドウに影をつけるかどうか。デフォルトはtrue。
  • opacity 数値 (オプション) macOS Windows - ウィンドウの初期の不透明度を0.0（完全に透明）から1.0（完全に不透明）の範囲で設定します。これはWindowsとmacOSでのみ実装されています。
  • darkTheme ブール値 (オプション) - ウィンドウでダークテーマを強制的に使用します。一部のGTK+3デスクトップ環境でのみ機能します。デフォルトはfalse。
  • transparent ブール値 (オプション) - ウィンドウを透明にします。デフォルトはfalse。Windowsでは、ウィンドウがフレームレスでない限り機能しません。
  • type 文字列 (オプション) - ウィンドウの種類。デフォルトは通常のウィンドウです。詳細は下記を参照してください。
  • visualEffectState 文字列 (オプション) macOS - macOSでマテリアル表示がウィンドウのアクティビティ状態をどのように反映するかを指定します。vibrancyプロパティと組み合わせて使用する必要があります。可能な値は
    • followWindow - バックドロップは、ウィンドウがアクティブなときは自動的にアクティブになり、アクティブでないときは非アクティブになります。これがデフォルトです。
    • active - バックドロップは常にアクティブになります。
    • inactive - バックドロップは常に非アクティブになります。
  • titleBarStyle 文字列 (オプション) - ウィンドウタイトルバーのスタイル。デフォルトはdefaultです。可能な値は
    • default - それぞれmacOSまたはWindowsの標準的なタイトルバーになります。
    • hidden - タイトルバーを非表示にし、コンテンツウィンドウをフルサイズにします。macOSでは、ウィンドウの左上に標準的なウィンドウコントロール（「信号機」）が依然として表示されます。WindowsとLinuxでは、titleBarOverlay: trueと組み合わせると、ウィンドウコントロールオーバーレイが有効になります（詳細はtitleBarOverlayを参照）。それ以外の場合は、ウィンドウコントロールは表示されません。
    • hiddenInset macOS - タイトルバーを非表示にし、信号機ボタンがウィンドウの端からわずかに内側に配置された代替の外観になります。
    • customButtonsOnHover macOS - タイトルバーを非表示にし、コンテンツウィンドウを全画面サイズにします。ウィンドウの左上に配置された信号機ボタンは、ホバー時に表示されます。注記: このオプションは現在実験段階です。
  • titleBarOverlay オブジェクト | ブール値 (オプション) - macOSでwin.setWindowButtonVisibility(true) を使用する場合、または標準のウィンドウコントロール（macOSの「信号機」）が表示されるようなtitleBarStyleを使用する場合、フレームレスウィンドウで使用します。このプロパティは、ウィンドウコントロールオーバーレイJavaScript APIとCSS環境変数を有効にします。trueを指定すると、デフォルトのシステムカラーのオーバーレイが表示されます。デフォルトはfalseです。
    • color 文字列 (オプション) Windows Linux - ウィンドウコントロールオーバーレイが有効になっている場合のCSSカラー。デフォルトはシステムカラーです。
    • symbolColor 文字列 (オプション) Windows - ウィンドウコントロールオーバーレイが有効になっている場合のシンボルのCSSカラー。デフォルトはシステムカラーです。
    • height 整数 (オプション) - タイトルバーとウィンドウコントロールオーバーレイの高さをピクセル単位で指定します。デフォルトはシステムの高さです。
  • trafficLightPosition Point (オプション) macOS - フレームレスウィンドウで信号機ボタンのカスタム位置を設定します。
  • roundedCorners ブール値 (オプション) macOS - macOSのフレームレスウィンドウで角を丸めるかどうかを指定します。デフォルトはtrueです。このプロパティをfalseに設定すると、ウィンドウを全画面表示できなくなります。
  • thickFrame ブール値 (オプション) - WindowsのフレームレスウィンドウにWS_THICKFRAMEスタイルを使用します。これにより、標準のウィンドウフレームが追加されます。falseに設定すると、ウィンドウの影とアニメーションが削除されます。デフォルトはtrueです。
  • vibrancy 文字列 (オプション) macOS - macOSでのみ、ウィンドウに様々なビブランシー効果を追加します。appearance-based、titlebar、selection、menu、popover、sidebar、header、sheet、window、hud、fullscreen-ui、tooltip、content、under-window、under-pageを指定できます。
  • backgroundMaterial 文字列 (オプション) Windows - クライアント領域以外の部分も含め、ウィンドウのシステム描画バックグラウンドマテリアルを設定します。auto、none、mica、acrylic、tabbedを指定できます。win.setBackgroundMaterialで詳細を確認してください。
  • zoomToPageWidth ブール値 (オプション) macOS - ツールバーの緑色の信号機ボタンをOptionキーを押しながらクリックした場合、または「ウィンドウ」>「ズーム」メニュー項目をクリックした場合のmacOSでの動作を制御します。trueの場合、ウィンドウはズーム時にウェブページの推奨幅に拡大されます。falseの場合、画面幅にズームされます。これは、maximize()を直接呼び出した場合の動作にも影響します。デフォルトはfalseです。
  • tabbingIdentifier 文字列 (オプション) 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型は、ドックのようなウィンドウの動作を作成します。
    • toolbar型は、ツールバーのような外観のウィンドウを作成します。
    • splash型は特定の方法で動作します。ウィンドウのボディのCSSスタイルに-webkit-app-region: dragが含まれていても、ドラッグできません。この型は、通常、スプラッシュスクリーンに使用されます。
    • notification型は、システム通知のように動作するウィンドウを作成します。
  • macOSでは、可能な型はdesktop、textured、panelです。
    • textured型は、メタルグラデーションの外観（NSWindowStyleMaskTexturedBackground）を追加します。
    • desktop型は、ウィンドウをデスクトップバックグラウンドウィンドウレベル（kCGDesktopWindowLevel - 1）に配置します。デスクトップウィンドウはフォーカス、キーボード、またはマウスイベントを受信しませんが、globalShortcutを使用して、入力回数を制限することができます。
    • panel型は、通常NSPanel用に予約されているNSWindowStyleMaskNonactivatingPanelスタイルマスクをランタイムに追加することにより、ウィンドウが全画面表示アプリの上にフロートできるようにします。また、ウィンドウはすべてのスペース（デスクトップ）に表示されます。
  • Windowsでは、可能な型はtoolbarです。