Aller au contenu principal

Objet BrowserWindowConstructorOptions

  • width Integer (facultatif) - Largeur de la fenêtre en pixels. La valeur par défaut est 800.
  • height Integer(facultatif) - Hauteur de la fenêtre en pixels. La valeur par défaut est 600.
  • x Integer (facultatif) - (obligatoire si y est utilisé) Décalage gauche de la fenêtre à partir de l'écran. La valeur par défaut est de centrer la fenêtre.
  • y Integer (facultatif) - (obligatoire si x est utilisé) Décalage supérieur de la fenêtre par rapport à l'écran. La valeur par défaut est de centrer la fenêtre.
  • useContentSize Boolean (facultatif) - La largeur (width) et la hauteur (height) seront utilisées pour définir la taille de la page Web, ce qui signifie que la taille de la fenêtre réelle inclura la taille du cadre de celle-ci et sera légèrement plus grande. false par défaut.
  • center boolean (facultatif) - Affiche la fenêtre au centre de l’écran. false par défaut.
  • minWidth Integer (facultatif) - Largeur minimum de la fenêtre. La valeur par défaut est 0.
  • minHeight Integer (facultatif) - Hauteur minimale de la fenêtre. La valeur par défaut est 0.
  • maxWidth Integer (facultatif) - Largeur maximale de la fenêtre. Il n'y a pas de limite par défaut.
  • maxHeight Integer (facultatif) - Hauteur maximale de la fenêtre. Il n'y a pas de limite par défaut.
  • <code>resizable</code> boolean (facultatif) - Indique si la fenêtre est redimensionnable. true` par défaut.
  • movable boolean (facultatif) macOS Windows - Indique si la fenêtre est déplaçable. Ceci n'est pas implémenté sous Linux. true par défaut.
  • minimizable boolean (facultatif) macOS Windows - Indique si la fenêtre est minimisable. Ceci n'est pas implémenté sous Linux. true par défaut.
  • maximizable boolean (facultatif) macOS Windows - Indique si la fenêtre est maximizable. Ceci n'est pas implémenté sous Linux. true par défaut.
  • closable boolean (optional) macOS Windows - Indique si la fenêtre est closable. Ceci n'est pas implémenté sous Linux. true par défaut.
  • focusable boolean (facultatif) - Indique que la fenêtre pourra ou non prendre le focus. True par défaut. Sous Windows, définir focusable: falseimplique également de définirskipTaskbar: true`. Sur Linux, mettre focusable: false fait que la fenêtre arrête d'interragir avec wm, par conséquent la fenêtre restera toujours au dessus dans tous les espaces de travail.
  • alwaysOnTop boolean (facultatif) - Indique si la fenêtre doit toujours rester au-dessus des autres fenêtres. false par défaut.
  • fullscreen boolean (facultatif) - Indique si la fenêtre doit s'afficher en plein écran. Quand explicitement mit a false, le bouton plein écran sera caché ou désactivé sur macOS. false par défaut.
  • fullscreenable boolean (facultatif) - Indique si la fenêtre peut s'afficher en plein écran. Sur macOS, indique également si le bouton de maximizer/zoom doit faire basculer en mode plein écran ou agrandir la fenêtre. true par défaut.
  • simpleFullscreen boolean (facultatif) macOS - Utilise fullscreen sur macOS pre-Lion . false par défaut.
  • skipTaskbar boolean (facultatif) macOS Windows - Indique si il faut afficher la fenêtre dans la barre des tâches. false par défaut.
  • `hiddenInMissionControl boolean (facultatif) macOS - Indique si la fenêtre doit être masquée lorsque l'utilisateur bascule sur Mission Control.
  • kiosk boolean (facultatif) - Indique si la fenêtre est en mode kiosque. false par défaut.
  • titlestring (facultatif) - Titre par défaut de la fenêtre. La valeur par défaut est "Electron". Si la balise HTML <title> est définie dans le fichier HTML chargé par loadURL(), cette propriété sera ignorée.
  • icon (NativeImage | string) (facultatif) - L'icône de fenêtre. Sur Windows, il est recommandé d'utiliser des icônes ICO pour avoir un rendu optimal, vous pouvez aussi le laisser indéfini pour que l'icône de l'exécutable soit utilisé.
  • boolean (facultatif) -Détermine si la fenêtre doit s'afficher ou non à la création. True par défaut.
  • frame boolean (facultatif) - Spécifiez false pour créer une fenêtre sans cadre. true par défaut.
  • parent BaseWindow (facultatif) - Indique la fenêtre parente. false par défaut.
  • modal boolean (facultatif) - Indique si il s'agit d'une fenêtre modale. Cela ne fonctionne que lorsque la fenêtre est une fenêtre enfant. false par défaut.
  • acceptFirstMouse boolean (facultatif) macOS - Indique si un click sur une fenêtre inactive passera à travers pour être transmis au contenu Web. La valeur par défaut est false sur macOS. Et cette option n'est pas configurable sur les autres plateformes.
  • disableAutoHideCursor boolean (facultatif) - Permet de masquer le curseur lors de la saisie. false par défaut.
  • autoHideMenuBar boolean (facultatif) - Masque la barre de menu sauf si la touche Alt est enfoncée. false par défaut.
  • enableLargerThanScreen booléen (facultatif) macOS - Permet à la fenêtre d'être redimensionnée en étant plus grande que l'écran. Seulement pertinent pour macOS, les autres systèmes d'exploitation autorisant par défaut des fenêtres plus grandes que l'écran par défaut. false par défaut.
  • backgroundColor string (facultatif) - Couleur de l'arrière-plan de la fenêtre en Hex, RGB, RGBA, HSL, HSLA ou avec un format CSS nommé. L'alpha au format #AARRGGBB est pris en charge si transparent est défini à true. La valeur par défaut est #FFF (blanc). Voir win.setBackgroundColor pour plus d'informations.
  • hasShadow boolean (facultatif) - Indique si la fenêtre doit avoir une ombre. true par défaut.
  • opacity number (facultatif) macOS Windows - Définit l'opacité initiale de la fenêtre, entre 0.0 (complètement transparent) et 1.0 (complètement opaque). Ceci est uniquement implément sur Windows et macOS.
  • darkTheme boolean (facultatif) - Force l'utilisation du thème sombre pour la fenêtre, ne fonctionne que sur certains environnements de bureau GTK+3. false par défaut.
  • transparent boolean (facultatif) - Rend la fenêtre transparent. false par défaut. Ne fonctionne pas sous Windows à moins que la fenêtre soit sans bordure. Lorsque vous ajoutez une View à une BaseWindow, vous devrez appeler view.setBackgroundColor avec une couleur d'arrière-plan transparent sur cette vue pour rendre son arrière-plan transparent également.
  • string (facultatif) - Type de fenêtre, par défaut normal. Voir ci-dessous pour en savoir plus.
  • visualEffectState string (facultatif) macOS - Spécifie comment sur macOS l'apparence de la fenêtre doit refléter son état d'activité. Doit être utilisé avec la propriété vibrancy. Les valeurs possibles étant:
    • followWindow - L'arrière-plan doit automatiquement apparaître comme actif lorsque la fenêtre est active et inactif quand elle ne l'est pas. C'est le comportement par défaut.
    • active - L'arrière-plan devrait toujours apparaître comme actif.
    • inactive - L'arrière-plan devrait toujours apparaître comme inactif.
  • titleBarStyle string (facultatif) - Le style de barre de titre de la fenêtre. false par défaut. Les valeurs possibles étant:
    • default - Produit la barre de titre standard pour macOS ou Windows respectivement.
    • hidden- Produit une barre de titre cachée et une fenêtre de contenu en pleine taille. Sur macOS, la fenêtre aura toujours les commandes standard des fenêtres (« feux de circulation ») en haut à gauche. Sur Windows et Linux, lorsque combiné avec titleBarOverlay: true, cela activera la Superposition des Contrôles de Fenêtre (voir titleBarOverlay pour plus d'informations), autrement, aucun contrôle de fenêtre ne sera affiché.
    • hiddenInset - Résultats dans une barre de titre cachée avec un aspect alternatif où les boutons du feu de circulation sont légèrement plus en retrait à partir du bord de la fenêtre.
    • customButtonsOnHover macOS - Se traduit par une barre de titre cachée et une fenêtre de contenu en pleine taille, les boutons du feu de signalisation s'afficheront lors de leur survol en haut à gauche de la fenêtre. Remarque : Cette option est actuellement expérimentale.
  • titleBarOverlay Object | Boolean (facultatif) - Lors de l'utilisation d'une fenêtre sans cadre et avec win.setWindowButtonVisibility(true) sur macOS ou en utilisant un titleBarStyle tel que la fenêtre de contrôle standard ("feux de signalisation" sur macOS) sont visibles, cette propriété active la Superposition des Commandes de Fenêtre APIs JavaScript et Variables d'Environnement CSS. Définir true entraînera un overlay avec les couleurs par défaut du système. false par défaut.
    • color String (facultatif) Windows Linux - La couleur CSS de la fenêtre de contrôle superposée lorsque activée. La couleur par défaut est la couleur du système.
    • symbolColor String (facultatif) Windows - Couleur CSS des symboles de l'overlay des contrôles lorsqu'il est activé. La couleur par défaut est la couleur du système.
    • height Integer (optional) - The height of the title bar and Window Controls Overlay in pixels. La valeur par défaut est la hauteur du système.
  • accentColor boolean | string (facultatif) Windows - La couleur d'accentuation de la fenêtre. Suit par défaut la préférence de l’utilisateur des paramètres système. A définir à false pour désactiver explicitement, ou avec la couleur dans un des formats Hex, RGB, RGBA, HSL, HSLA ou une couleur nommée CSS. Les valeurs alpha seront ignorées.
  • trafficLightPosition Point (facultatif) macOS - Définit une position personnalisée pour les boutons de feux de circulation dans les fenêtres sans cadres.
  • roundedCorners boolean (facultatif) macOS - Indique si la fenêtre sans bordure doit avoir des coins arrondis. true par défaut. Sur les versions de Windows antérieures à Windows 11 Build 22000 cette propriété n'a aucun effet, et les fenêtres sans cadre n'auront pas de coins arrondis. Sous Linux, les coins arrondis sont dessinés quand l'environnement bureau prend en charge des décorations côté client.
  • thickFrame boolean (facultatif) - Utilise le style WS_THICKFRAME pour les fenêtres sans cadre sous Windows et qui ajoute une image standard de fenêtre. La mise à false supprimera les animations d'ombre et de fenêtre de fenêtre, et désactivera le redimensionnement de la fenêtre par glissement des bords de la fenêtre. true par défaut.
  • string (facultatif) macOS - Ajoute un type d'effet de vibrance à la fenêtre, uniquement sur macOS. Peut être appearance-based, titlebar, selection, menu, popover, sidebar, header, sheet, window, hud, fullscreen-ui, tooltip, content, under-window, ou under-page.
  • backgroundMaterial string (facultatif) Windows - Définit le contenu d'arrière-plan du système de la fenêtre, y compris derrière la zone non-client. Peut être auto, none, mica, acrylic ou tabbed. Voir win.setBackgroundMaterial pour plus d'informations.
  • zoomToPageWidth boolean (optional) macOS - Controls the behavior on macOS when option-clicking the green stoplight button on the toolbar or by clicking the Window > Zoom menu item. If true, the window will grow to the preferred width of the web page when zoomed, false will cause it to zoom to the width of the screen. This will also affect the behavior when calling maximize() directly. false par défaut.
  • tabbingIdentifier string (optional) macOS - Tab group name, allows opening the window as a native tab. Windows with the same tabbing identifier will be grouped together. This also adds a native new tab button to your window's tab bar and allows your app and window to receive the new-window-for-tab event.

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 the type option are platform dependent. Les valeurs possibles étant:

  • Sous Linux, les types possibles sont desktop, dock, toolbar, splash, notification.
    • Le type desktop place la fenêtre au niveau de la fenêtre de fond de bureau (kCGDesktopWindowLevel - 1). Cependant, notez qu’une fenêtre de bureau ne recevra pas les événements de focus, de clavier ou de souris. Vous pouvez toujours utiliser globalRaccourci vers recevoir des entrées avec modération.
    • The dock type creates a dock-like window behavior.
    • The toolbar type creates a window with a toolbar appearance.
    • The splash type behaves in a specific way. It is not draggable, even if the CSS styling of the window's body contains -webkit-app-region: drag. Ce type est couramment utilisé pour les écrans de démarrage.
    • The notification type creates a window that behaves like a system notification.
  • On macOS, possible types are desktop, textured, panel.
    • The textured type adds metal gradient appearance. This option is deprecated.
    • The desktop type places the window at the desktop background window level (kCGDesktopWindowLevel - 1). Note that desktop window will not receive focus, keyboard or mouse events, but you can use globalShortcut to receive input sparingly.
    • 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. Also, the window will appear on all spaces (desktops).
  • On Windows, possible type is toolbar.