Zum Hauptteil springen

BaseWindowConstructorOptions Object

  • width Integer (Optional) - Fensterbreite in Pixeln. Standard: 800.
  • height Integer (Optional) - Fensterhöhe in Pixeln. Standard: 600.
  • x Integer (Optional) - (erforderlich, wenn y benutzt wird) Fenster Versatz vom Bildschirm auf der linken Seite. Standardmäßig wird das Fenster zentriert.
  • y Integer (Optional) - (erforderlich, wenn x benutzt wird) Fenster Versatz vom Bildschirm von oben. Standardmäßig wird das Fenster zentriert.
  • useContentSize boolean (Optional) - Die Breite (width) und die Höhe (height) würde als Webseitengröße benutzt werden was heißt, dass die tatsächliche Fenstergröße die Fensterrahmengröße beinhaltet und etwas größer ist. Standard: false.
  • center boolean (Optional) - Fenster in der Mitte des Bildschirms anzeigen. Standard: false.
  • minWidth Integer (Optional) - Mindestbreite des Fensters. Standard: 0.
  • minHeight Integer (Optional) - Mindesthöhe des Fensters. Standard: 0.
  • maxWidth Integer (Optional) - Maximale Breite des Fensters. Der Standardwert ist kein Limit.
  • maxHeight Integer (Optional) - Maximale Fenster höhe. Der Standardwert ist kein Limit.
  • resizable boolean (Optional) - Ob die Größe des Fensters veränderbar ist. Standard: true.
  • movable boolean (Optional) macOS Windows - Ob das Fenster verschiebbar ist. Dies ist unter Linux nicht implementiert. Standard: true.
  • minimizable boolean (Optional) macOS Windows - Ob das Fenster minimierbar ist. Dies ist unter Linux nicht implementiert. Standard: true.
  • maximizable boolean (Optional) macOS Windows - Ob das Fenster maximierbar ist. Dies ist unter Linux nicht implementiert. Standard: true.
  • closable boolean (Optional) macOS Windows - Ob das Fenster schließbar ist. Dies ist unter Linux nicht implementiert. Standard: true.
  • focusable boolean (Optional) - Ob das Fenster fokussiert werden kann. Standard: true. Unter Windows impliziert die Setzung von focusable: false auch die Setzung von skipTaskbar: true. Das Setzen von focusable: false auf Linux stoppt das Fenster von Interaktionen mit dem Fenstermanager. Das heißt, dass das Fenster in allen Arbeitsbereichen immer im Vordergrund bleibt.
  • alwaysOnTop boolean (Optional) - Ob das Fenster immer im Vordergrund angezeigt werden soll. Standard: false.
  • fullscreen boolean (Optional) - Ob das Fenster im Vollbild angezeigt werden soll. Wenn explizit auf false gesetzt, wird der Vollbildbutton auf macOS ausgeblendet oder deaktiviert. Standard: false.
  • fullscreenable boolean (Optional) - Ob das Fenster in den Vollbildmodus gesetzt werden kann. Unter macOS, auch ob der maximieren-/zoombutton den Vollbildmodus oder die Fenstermaximierung toggeln soll. Standard: true.
  • simpleFullscreen boolean (Optional) macOS - Ob auf macOS pre-Lion Vollbildmodus verwendet werden soll. Standard: false.
  • skipTaskbar boolean (Optional) macOS Windows - Ob das Fenster in der Taskleiste angezeigt werden soll. Standard: false.
  • hiddenInMissionControl boolean (Optional) macOS - Ob das Fenster versteckt werden soll, wenn der Nutzer Mission Control öffnet.
  • kiosk boolean (Optional) - Ob das Fenster im Kioskmodus ist. Standard: false.
  • title string (Optional) - Standard Fenstertitel. Standard: "Electron". Wenn der HTML Tag <title> in der HTML Datei, welche mit loadURL() geladen wurde, definiert ist, wird dieser Wert ignoriert.
  • icon (NativeImage | string) (Optional) - Das Fenstericon. Auf Windows ist es empfohlen ICO Icons zu verwenden, um die besten visuellen Effekte zu bekommen. Der Wert kann auch undefined gelassen werden, um das Icon der ausführbaren Datei zu verwenden.
  • show boolean (Optional) - Ob das Fenster angezeigt werden soll, wenn es erstellt wird. Standard: true.
  • frame boolean (Optional) - Nutze false um ein Rahmenloses Fenster zu erstellen. Standard: true.
  • parent BaseWindow (Optional) - Übergeordnetes Fenster. Standard: null.
  • modal boolean (Optional) - Ob es ein Modal Fenster ist. Dies funktioniert nur, wenn das Fenster ein untergeordnetes Fenster ist. Standard: false.
  • acceptFirstMouse boolean (Optional) macOS - Ob klicken in ein inaktives Fenster den Klick an die Website weiterleitet oder nicht. Standard auf macOS: false. Diese Option ist nicht konfigurierbar auf anderen Plattformen.
  • disableAutoHideCursor boolean (Optional) - Ob der Mauszeiger ausgeblendet werden soll während dem Schreiben. Standard: false.
  • autoHideMenuBar boolean (optional) Linux Windows - Die Menüleiste automatisch ausblenden, es sei denn, die Alt-Taste wird gedrückt. Standard: false.
  • enableLargerThanScreen boolean (Optional) macOS - Ob das Fenster größer als der Bildschirm vergrößert werden kann. Nur relevant für macOS, da andere Betriebssysteme dies standardmäßig erlauben. Standard: false.
  • backgroundColor string (Optional) - Die Hintergrundfarbe des Fensters in Hex, RGB, RGBA, HSL, HSLA oder named CSS Farbformat. Alpha in #AARRGGBB Format wird unterstützt, wenn transparent auf true gesetzt ist. Standard: #FFF (weiß). Siehe win.setBackgroundColor für mehr Informationen.
  • hasShadow boolean (Optional) - Ob das Fenster einen Schatten haben soll. Standard: true.
  • opacity number (Optional) macOS Windows - Legt die Ausgangsdeckkraft des Fensters fest. Die Deckkraft muss zwischen 0.0 (vollständig transparent) und 1.0 (völlig undurchsichtig) liegen. Dies ist nur auf Windows und macOS implementiert.
  • darkTheme boolean (Optional) - Zwingt das Fenster Darkmode zu nutzen, funktioniert nur auf manchen GTK+3 Desktopumgebungen. Standard: false.
  • transparent boolean (Optional) - Macht das Fenster transparent. Standard: false. Unter Windows funktioniert es nur, wenn das Fenster rahmenlos ist.
  • type string (Optional) - Typ des Fensters, standardmäßig ein normales Fenster. Mehr darüber weiter unten.
  • visualEffectState string (Optional) macOS - Gibt an, wie das Material Aussehen dem Aktivitätszustand auf macOS widerspiegeln soll. Muss zusammen mit der vibrancy Eigenschaft genutzt werden. Mögliche Werte sind:
    • followWindow - Der Hintergrund soll automatisch als aktiv erscheinen, wenn das Fenster aktiv ist, und inaktiv wenn nicht. This is the default.
    • active - Der Hintergrund soll immer als aktiv erscheinen.
    • inactive - Der Hintergrund sollte immer inaktiv erscheinen.
  • titleBarStyle string (Optional) - Der Stil der Titelbar des Fensters. Standard: default. Mögliche Werte sind:
    • default - Nutzt den Standard Stil der Titelbar für macOS bzw. Windows.
    • hidden - Versteckt die Titelbar und streckt das Fenster auf die volle Größe. Auf macOS hat das Fenster immer noch die Standard-Fenstersteuerung ("Ampel") oben links. Auf Windows und Linux, wenn kombiniert mit titleBarOverlay: true wird das Fenstersteuerungs-Overlay aktiviert (siehe titleBarOverlay für weitere Informationen), andernfalls werden keine Fenstersteuerungen angezeigt.
    • hiddenInset macOS - Resultiert in einer versteckten Titelleiste mit einem alternativen Aussehen, bei dem die Ampel Buttons vom Fensterrand etwas weiter nach innen gerückt wurden.
    • customButtonsOnHover macOS - Versteckt die Titelleiste und zeigt das Fenster in voller Größe. Die Ampelbuttons werden angezeigt, wenn der Benutzer den Mauszeiger oben links ins Fenster bewegt. Hinweis: Diese Option ist derzeit experimentell.
  • titleBarOverlay Objekt | Boolean (Optional) - Bei Verwendung eines rahmenlosen Fensters in Verbindung mit win. etWindowButtonVisibility(true) auf macOS oder mit titleBarStyle, so dass die Standard-Fenstersteuerung ("Ampel" auf macOS) sichtbar ist, diese Eigenschaft aktiviert das Fenstersteuerung-Overlay JavaScript APIs und CSS Environment Variables. Die Angabe von true führt zu einem Overlay mit Standard-Systemfarben. Standard: false.
    • color String (Optional) Windows Linux - Die CSS-Farbe des Fenstersteuerung-Overlay, wenn aktiviert. Standard: Systemfarbe.
    • symbolColor String (optional) Windows Linux - Die CSS-Farbe der Symbole auf dem Window Constols Overlay wenn aktiviert. Standard: Systemfarbe.
    • height Integer (optional) - The height of the title bar and Window Controls Overlay in pixels. Standard: Systemhöhe.
  • accentColor boolean | string (optional) Windows - Die Akzentfarbe für das Fenster. Folgt standardmäßig den Benutzereinstellungen in den Systemeinstellungen. Setze false um explizit zu deaktivieren, oder setze die Farbe im Hex, RGB, RGBA, HSL, HSLA oder benannten CSS-Farbformat. Alphawerte werden ignoriert.
  • trafficLightPosition Point (Optional) macOS - Setzt eine benutzerdefinierte Position für die Ampelbuttons in rahmenlosen Fenstern.
  • roundedCorners boolean (optional) macOS Windows - Ob ein rahmenloses Fenster gerundete Ecken haben soll. Standard: true. Wenn diese Eigenschaft auf false gesetzt wird, wird verhindert, dass das Fenster auf macOS in den Vollbildmodus gehen kann. Bei Windows-Versionen, die älter als Windows 11 Build 22000 sind, hat diese Eigenschaft keinen Effekt. Rahmenlose Fenster haben keine abgerundeten Ecken.
  • thickFrame boolean (Optional) - Nutze WS_THICKFRAME Stil für rahmenlose Fenster auf Windows, welches den Standard Fensterrahmen hinzufügt. Wenn dies auf false wird kein Fensterschatten oder -animationen. Standard: true.
  • vibrancy string (Optional) macOS - Fügt eine Art von "vibrancy" Effekt dem Fenster auf macOS hinzu. Kann appeance-based, titlebar, selection, menu, popover, sidebar, header, sheet, window, hud, fullscreen-ui, tooltip, content, under-window oder under-page sein.
  • backgroundMaterial string (Optional) Windows - Setzt welches System-gezeichnete Hintergrundmaterial das Fenster verwenden soll, auch hinter dem Nicht-Client-Bereich. Kann auto, keine, mica, acrylic oder tabbed sein. Siehe win.setBackgroundMaterial für weitere Informationen.
  • zoomToPageWidth boolean (Optional) macOS - Steuert das Verhalten auf macOS wenn der Benutzer auf das grüne "Ampellicht" in der Werkzeugleiste option-klickt oder durch auf das Fenster > Zoom-Menüpunkt klickt. Wenn true, wird das Fenster auf die bevorzugte Breite der Webseite beim Zoomen vergrößert. false wird dazu führen, dass es auf die Breite des Bildschirms zoomt. Dies betrifft direkte Aufrufe von maximize() ebenso. Standard: false.
  • tabbingIdentifier string (Optional) macOS - Tab-Gruppenname, erlaubt das Öffnen des Fensters als nativer Tab. Windows mit der gleichen Kennung werden zusammengefasst. Dies fügt auch einen nativen neuen Tabbutton in die Tableiste des Fensters hinzu und erlaubt der app und dem Fenster das new-window-for-tab Ereignis zu erhalten.

Wenn die minimale oder maximale Fenstergröße mit minWidth/maxWidth/ minHeight/maxHeight gesetzt wird, werden nur die Benutzer eingeschränkt. Es wird dich nicht daran hindern bei setBounds/setSize oder in einem Konstruktor von BrowserWindow, eine Größe zu anzugeben, die nicht der Größenbeschränkung folgt.

Die möglichen Werte und Verhaltensweisen der Option type sind plattformabhängig. Mögliche Werte sind:

  • Auf Linux sind folgende Typen möglich: desktop, dock, toolbar, splash und Benachrichtigung.
    • Der Typ desktop platziert das Fenster auf der Ebene des Desktop-Hintergrundfensters (kCGDesktopWindowLevel - 1). Beachte jedoch, dass ein Desktop-Fenster keinen Fokus-, Tastatur- oder Mausevents empfange kann. GlobalShortcut können weiterhin verwendet werden um wenige Eingaben erhalten.
    • Der Typ dock erzeugt ein dockähnliches Fensterverhalten.
    • Der toolbar Typ erzeugt ein Fenster mit einer Symbolleiste Aussehen.
    • Der Typ splash verhält sich auf eine bestimmte Weise. Das Fenster ist nicht Verschiebbar, auch wenn das CSS-Styling des Fensterkörpers -webkit-app-region enthält. Dieser Typ wird häufig für Splash-Screens verwendet.
    • Der notification Typ erzeugt ein Fenster, das sich wie eine Systembenachrichtigung verhält.
  • Auf macOS sind diese Typen möglich desktop, textured, panel.
    • Der Typ textured fügt das Aussehen eines metallischen Verlaufs hinzu. Diese Option ist veraltet.
    • Der Typ desktop platziert das Fenster auf der Ebene des Desktop-Hintergrundfensters (kCGDesktopWindowLevel - 1). Beachte jedoch, dass ein Desktop-Fenster keinen Fokus-, Tastatur- oder Mausevents empfange kann. GlobalShortcut können weiterhin verwendet werden um wenige Eingaben erhalten.
    • Der panel Typ erlaubt es das Fenster über die Vollbild-Apps schweben zu lassen, indem die NSWindowStyleMaskNonactivatingPanel Style-Maske hinzugefügt wird normalerweise reserviert für NSPanel, zur Laufzeit. Außerdem wird das Fenster auf allen Arbeitsflächen (desktops) angezeigt.
  • Unter Windows, ist der Typ toolbar möglich.