BrowserWindow
Création et gestion des fenêtres navigateur.
Processus : Main
Ce module ne peut pas être utilisé tant que l'événement ready du module app n'est pas émis.
// Dans le processus main.
const { BrowserWindow } = require('electron')
const win = new BrowserWindow({ width: 800, height: 600 })
// Charge à partir d'une URL distante
win.loadURL('https://github.com')
// Ou à partir d'un fichier HTML local
win.loadFile('index.html')
Personnalisation de la fenêtre
La classe BrowserWindow permet de modifier l'apparence et le comportement des fenêtres de votre application de diverses façons. Pour plus de détails, voir le tutoriel Personnalisation de la fenêtre .
Affichage gracieux de la fenêtre
Lors du chargement direct d’une page dans la fenêtre, les utilisateurs peuvent voir la page se charger progressivement, ce qui ne fait pas bonne impression pour une application native. Pour afficher la fenêtre sans ce flash visuel, il existe deux solutions pour des situations différentes.
À l'aide de l'événement ready-to-show
Pendant le chargement de la page, l'événement ready-to-show sera émis lorsque le processus de rendu aura affiché la page pour la première fois si la fenêtre n'a pas encore été rendue. Afficher la fenêtre après cet événement permettre d'éviter tout flash visuel :
const { BrowserWindow } = require('electron')
const win = new BrowserWindow({ show: false })
win.once('ready-to-show', () => {
win.show()
})
Cet événement est généralement émis après l’événement did-finish-load, mais pour les pages accédant à beaucoup de ressources distantes, il peut être émis avant l’événement did-finish-load.
Veuillez noter que l'utilisation de cet événement implique que le moteur de rendu est présumé "visible" et rafraîchit, même si show est à false. Cet événement ne se déclenchera jamais si vous utilisez paintWhenInitiallyHidden: false
Définition de la propriété backgroundColor
Pour une application complexe, l’événement ready-to-show peut être émis trop tard, donnant une impression de lenteur. Dans ce cas, il est recommandé d'afficher la fenêtre immédiatement et d'utiliser un backgroundColor proche de la couleur de fond de votre application :
const { BrowserWindow } = require('electron')
const win = new BrowserWindow({ backgroundColor: '#2e2c29' })
win.loadURL('https://github.com')
Notez que même pour les applications qui utilisent l'événement ready-to-show , il est tout de même recommandé de définir backgroundColor pour que l'application semble plus native.
Voici quelques exemples de valeurs de backgroundColor :
const win = new BrowserWindow()
win.setBackgroundColor('hsl(230, 100%, 50%)')
win.setBackgroundColor('rgb(255, 145, 145)')
win.setBackgroundColor('#ff00a3')
win.setBackgroundColor('blueviolet')
Pour plus d’informations sur les différents formats de couleurs, consultez les options valides dans win.setBackgroundColor.
Fenêtres parent et enfant
En utilisant l'option parent, vous pouvez créer une fenêtre enfant:
const { BrowserWindow } = require('electron')
const top = new BrowserWindow()
const child = new BrowserWindow({ parent: top })
child.show()
top.show()
La fenêtre child sera toujours au dessus de la fenêtre top.
Fenêtres modales
Une fenêtre modale est une fenêtre enfant qui désactive la fenêtre parent. Pour créer une fenêtre modale, il faut définir les options parent et modal :
const { BrowserWindow } = require('electron')
const top = new BrowserWindow()
const child = new BrowserWindow({ parent: top, modal: true, show: false })
child.loadURL('https://github.com')
child.once('ready-to-show', () => {
child.show()
})
Visibilité de la page
L'API Page Visibility fonctionne comme indiqué ci-dessous :
- Sur toutes les plateformes, l'état de visibilité suit l'état de la fenêtre cachée/minimisée ou pas.
- De plus, sur macOS, l'état de visibilité suit également l'état d'occlusion de la fenêtre. Si la fenêtre est occultée (c'est-à-dire entièrement recouverte) par une autre fenêtre, l'état de visibilité sera
hidden. Sur les autres plateformes, l'état de visibilité serahiddenseulement lorsque la fenêtre est minimisée ou cachée explicitement avecwin.hide(). - Si une
BrowserWindowest crée avecshow:false, l'état de visibilité initial seravisiblemême si la fenêtre est cachée. - Si
backgroundThrottlingest désactivé, l'état de visibilité resteravisiblemême si la fenêtre est minimisée, occultée ou cachée.
Il est recommandé de mettre en pause les opérations coûteuses lorsque l'état de visibilité est hidden afin de minimiser la consommation d'énergie.
Avertissement sur les plateformes
- Sur macOS, les fenêtres modales seront affichés comme des feuilles attachées à la fenêtre parent.
- Sur macOS, la fenêtre enfant va garder la position relative à la fenêtre parent lorsque la fenêtre parent bouge. Sur Windows et Linux, la fenêtre enfant ne bougera pas.
- Sur Linux, le type des fenêtre modales sera remplacé par
dialog. - Sur Linux, beaucoup d'environnements bureau ne peuvent pas cacher une fenêtre modale.
Classe : BrowserWindow
Création et gestion des fenêtres navigateur.
Processus : Main
BrowserWindow est un EventEmitter.
Cela crée une nouvelle BrowserWindow avec les propriétés natives définies par les options.
new BrowserWindow([options])
Lorsque l'on définie une taille minimum ou maximum pour la fenêtre avec minWidth/maxWidth/ minHeight/maxHeight, cela contraint les utilisateurs uniquement. Cela ne vous empêche pas de passer une taille qui ne suit pas les contraintes de tailles à setBounds/setSize ou au constructeur de BrowserWindow.
Les valeurs et comportements possibles de l'option type dépendent de la plateforme. Les valeurs possibles étant:
- Sur Linux, les types possible sont
desktop,dock,toolbar,splash,notification.- Le type
desktopplace la fenêtre au niveau de la fenêtre d'arrière-plan du 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. - Le type
dockcrée comportement de fenêtre semblable à celui d'un dock. - Le type
toolbarcrée une fenêtre avec une apparence de barre d'outils. - Le type
splashprovoque un comporterment spécifique. Il n'est pas déplaçacle, même si le style CSS du corps de la fenêtre contient -webkit-app-region : drag. Ce type est couramment utilisé pour les écrans de démarrage. - Le type
notificationcrée une fenêtre qui se comporte comme une notification système.
- Le type
- Sur macOS, les types possibles sont
desktop,textured,panel.- Le type
texturedajoute un aspect métal dégradé (NSWindowStyleMaskTexturedBackground). - Le type
desktopplace les fenêtre au niveau de l'arière plan. (kCGDesktopWindowLevel - 1). Remarque, la fenêtre du Bureau ne recevra pas le focus ni les évennements souris ou clavier, mais il est possible d'utiliserglobalShortcutpour recevoir des entrées avec modération. - Le type
panelpermet à la fenêtre de flotter au-dessus des applications plein écran en ajoutant à l'exécution le masque de styleNSWindowStyleMaskNonactivatingPanel, normalement réservé à NSPanel, . De plus, la fenêtre apparaîtra sur tous les espaces (bureaux).
- Le type
- Sur Windows, le seul type possible est
toolbar.
Événements d’instance
Les objets crées avec new BrowserWindow émettent les évennements suivants :
Remarque : Certains événements sont seulement disponibles sur des systèmes d'exploitation spécifiques et sont étiquetés comme tels.
Événement : 'page-title-updated'
Retourne :
eventEventtitlestringexplicitSetboolean
Émis lorsque le document a modifié son titre, l'appel à event.preventDefault() empêchera le titre de la fenêtre native de changer. explicitSet est faux lorsque le titre est synthétisé à partir de l'URL du fichier.
Événement : 'close'
Retourne :
eventEvent
Emis lorsque la fenêtre va être fermée. Émis avant les événements beforeunload et unload du DOM. L'appel à event.preventDefault() annulera la fermeture.
Normalement, vous devriez utiliser le gestionnaire de beforeunload pour décider si une fenêtre doit être fermée, celui-ci sera aussi appelé lorsque la fenêtre est rechargée. Dans Electron, n'importe quelle valeur retournée autre que undefined annulera la fermeture. Par exemple :
window.onbeforeunload = (e) => {
console.log('I do not want to be closed')
// Unlike usual browsers that a message box will be prompted to users, returning
// a non-void value will silently cancel the close.
// Il est recommandé d'utiliser l'API de dialogue afin de laisser l'utilisateur confirmer la fermeture de
// l'application.
e.returnValue = false
}
Note: Il existe une différence subtile entre les comportements de window.onbeforeunload = handler et de window.addEventListener('beforeunload', handler). Il est recommendé de toujours spécifier l' event.returnValue explicitement, plutôt que de seulement retourner une valeur, cette méthode fonctionne mieux avec Electron.
Événement : 'closed'
Il est emis lorsque la fenêtre est fermée. Après avoir reçu cet événement, vous devez supprimer la référence vers la fenêtre et éviter de la ré-utiliser.
Événement : 'session-end' Windows
Émis lorsque la session va se terminer à cause d'un redémarrage, un arrêt forcé ou une déconnexion.
Événement : 'unresponsive'
Émis lorsque la page web cesse de répondre.
Événement : 'responsive'
Émis lorsque la page web répond à nouveau.
Événement : 'blur'
Émis lorsque la fenêtre perd le focus.
Événement : 'focus'
Émis lorsque la fenêtre obtient le focus.
Événement : 'show'
Émis lorsque la fenêtre est affichée.
Événement : 'hide'
Émis lorsque la fenêtre est masquée.
Événement : 'ready-to-show'
Émis lorsque la page web à été chargée (tout en n'étant pas affichée) et la fenêtre peut être affichée sans flash visuel.
Veuillez noter que l'utilisation de cet événement implique que le moteur de rendu est présumé "visible" et rafraîchit, même si show est à false. Cet événement ne se déclenchera jamais si vous utilisez paintWhenInitiallyHidden: false
Événement : 'maximize'
Émis lorsque la fenêtre est agrandie.
Événement : 'unmaximize'
Émis lorsque la fenêtre quitte un état maximisé.
Événement : 'minimize'
Émis lorsque la fenêtre est minimisée.
Événement : 'restore'
Émis lorsque la fenêtre est restaurée à partir d’un état réduit.
Événement : 'will-resize' macOS Windows
Retourne :
eventEventnewBoundsRectangle - Taille de la fenêtre en cours de redimensionnage.- Objet
detailsedge(string) - Bord de la fenêtre manipulé pour redimensionner. Peut êtrebottom,left,right,top-left,top-right,bottom-leftoubottom-right.
Émis avant que la fenêtre ne soit redimensionnée. L’appel à event.preventDefault() empêchera le redimensionnement de la fenêtre.
Notez que cet événement n'est émis que lorsque la fenêtre est redimensionnée manuellement. Le redimensionnement de la fenêtre avec setBounds/setSize n’émettra donc pas cet événement.
Les valeurs et comportements possibles de l'option edge dépendent de la plateforme. Les valeurs possibles étant:
- Sous Windows, ces valeurs sont
bottom,top,left,right,top-left,top-right,bottom-left,bottom-right. - Sous macOS, les valeurs possibles ne sont
bottometright.- La valeur
bottomest utilisée pour indiquer un redimensionnement vertical. - La valeur
rightest utilisée pour indiquer un redimensionnement horizontal.
- La valeur
Événement : 'resize'
Émis après que la fenêtre soit redimensionnée.
Événement : 'resized' macOS Windows
Émis une fois que la fenêtre a fini d'être redimensionnée.
Généralement émis lorsque la fenêtre a été redimensionnée manuellement. Sur macOS, le redimensionnement de la fenêtre avec setBounds/setSize et le réglage du paramètre animate à true émettra également cet événement une fois le redimensionnement terminé.
Événement : 'will-move' macOS Windows
Retourne :
eventEventnewBoundsRectangle - Emplacement où la fenêtre est en cours de déplacement.
Émis juste avant que la fenêtre ne soit déplacée. Sous Windows, l'appel à event.preventDefault() empêchera le déplacement de la fenêtre.
Notez bien qu'il ne sera émis que lorsque la fenêtre est déplacée manuellement. Donc un déplacement de fenêtre utilisant setPosition/setBounds/center n'émettra pas cet événement.
Événement : 'move'
Émis lorsque la fenêtre est déplacée vers une nouvelle position.
Événement : 'moved' macOS Windows
Émis une fois lorsque la fenêtre est déplacée vers une nouvelle position.
Note : Sous macOS, cet événement est un alias de move.
Événement : 'enter-full-screen'
Émis lorsque la fenêtre passe à un état de plein écran.
Événement : 'leave-full-screen'
Émis lorsque la fenêtre revient d'un état de plein écran.
Événement : 'enter-html-full-screen'
Émis lorsque la fenêtre entre dans un état de plein écran déclenchée par l’API HTML.
Événement : 'leave-html-full-screen'
Émis lorsque la fenêtre revient d'un état de plein écran déclenchée par l’API HTML.
Événement : 'always-on-top-changed'
Retourne :
eventEventisAlwaysOnTopboolean
Émis lorsque la fenêtre est définie ou non définie pour toujours afficher au dessus des autres fenêtres.
Événement : 'app-command' Windows Linux
Retourne :
eventEventcommandstring
Émis lorsqu'une App Command est appelée. Généralement lié aux touches multimédia du clavier ou aux commandes du navigateur, ainsi que le bouton "Retour" intégré à certaines souris sous Windows.
Les commandes sont en minuscules, les traits de soulignement sont remplacés par des traits d'union, et le préfixe APPCOMMAND_ est supprimé. par exemple APPCOMMAND_BROWSER_BACKWARD est émis sous la forme browser-backward.
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
win.on('app-command', (e, cmd) => {
// Navigate the window back when the user hits their mouse back button
if (cmd === 'browser-backward' && win.webContents.canGoBack()) {
win.webContents.goBack()
}
})
Les commandes d'application suivantes sont explicitement prises en charge sur Linux :
browser-backwardbrowser-forward
Événement : 'scroll-touch-begin' macOS Déprécié
Émis lorsque l’événement scroll de la souris a commencé.
Note Cet événement est déprécié depuis Electron 22.0.0. Voir Changements majeurs avec rupture de compatibilité pour plus de détails sur la façon de migrer vers l'utilisation de l'événement WebContents
input-event.
Événement : 'scroll-touch-end' macOS Déprécié
Émis lorsque l’événement scroll de la molette de la souris est terminée.
Note Cet événement est déprécié depuis Electron 22.0.0. Voir Changements majeurs avec rupture de compatibilité pour plus de détails sur la façon de migrer vers l'utilisation de l'événement WebContents
input-event.
Événement : 'will-move' macOS Déprécié
Émis lorsque l’événement scroll de la molette de la souris arrive au bord d'un élément.
Note Cet événement est déprécié depuis Electron 22.0.0. Voir Changements majeurs avec rupture de compatibilité pour plus de détails sur la façon de migrer vers l'utilisation de l'événement WebContents
input-event.
Événement : 'swipe' macOS
Retourne :
eventEventdirectionstring
Émis sur un balayage à 3 doigts. Les directions possibles sont up, right, down, left.
La méthode sous-jacente à cet événement est construite afin de pouvoir gérer les glissements sur trackpad selon le styles des 'anciens macOS, où le contenu sur l'écran ne se déplace pas avec le glissement. La plupart des trackpads sur macOS ne sont pas configurés pour continuer à permettre ce type de glissement donc pour que la préférence 'Swipe between pages' dans System Preferences > Trackpad > More Gestures doit être définie à 'Swipe with two or three fingers'.
Événement : 'rotate-gesture' macOS
Retourne :
eventEventrotationFloat
Émis lors du mouvement de rotation du trackpad. Émission continue jusqu'à la fin du geste de rotation. La valeur rotation sur chaque émission est l'angle en degrés tourné depuis la dernière émission. Le dernier événement émis lors d'un geste de rotation sera toujours de la valeur 0. Les valeurs de rotation dans le sens inverse des aiguilles d'une montre sont positives, tandis que les valeurs dans le sens horaire sont négatives.
Événement : 'sheet-begin' macOS
Émis lorsque la fenêtre ouvre une feuille.
Événement : 'sheet-end' macOS
Émis lorsque la fenêtre a fermé une feuille.
Événement : 'new-window-for-tab' macOS
Émis lorsque le bouton natif du nouvel onglet est cliqué.
Événement : 'system-context-menu' Windows
Retourne :
eventEventpointPoint - Coordonnées à l'écran du point ou a été déclenchée la demande de menu contextuel
Émis lorsque le menu contextuel du système est déclenché dans la fenêtre, ceci est normalement uniquement déclenché lorsque l'utilisateur fait un clic droit sur la zone non-client de votre fenêtre. Dans une fenêtre sans bordure c'est la barre de titre de la fenêtre ou n'importe quelle zone que vous avez déclaré en tant que -webkit-app-region: drag.
L'appel à event.preventDefault() empêchera l'affichage du menu.
Méthodes statiques
La classe BrowserWindow dispose des méthodes statiques suivantes :
BrowserWindow.getAllWindows()
Retourne BrowserWindow[] - Un tableau de toutes les fenêtres ouvertes.
BrowserWindow.getFocusedWindow()
Retourne BrowserWindow | null - Fenêtre ayant le focus dans cette application, sinon retourne null.
BrowserWindow.fromWebContents(webContents)
webContentsWebContents
Retourne BrowserWindow | null - Fenêtre propriétaire du webContents ou null si celui-ci n'est possédé par aucune fenêtre.
BrowserWindow.fromBrowserView(browserView)
browserViewBrowserView
Retourne BrowserWindow | null - Fenêtre possèdant la browserView. Retournera null. si la vue n'est attachée à aucune fenêtre.
BrowserWindow.fromId(id)
idInteger
Retourne BrowserWindow | null - La fenêtre avec l'id donné.
Propriétés d'instance
Les objets créés avec new BrowserWindow ont les propriétés suivantes :
const { BrowserWindow } = require('electron')
// Dans cet exemple `win` est notre instance
const win = new BrowserWindow({ width: 800, height: 600 })
win.loadURL('https://github.com')
win.webContents Readonly
Objet WebContents possèdé par cette fenêtre. Tous les événements liés à la page web et les opérations se feront par son intermédiaire.
Voir la documentation sur webContents pour ses méthodes et ses événements.
win.id Readonly
Propriété de type Integer représentant l'ID unique de la fenêtre. Chaque ID est unique parmi ceux des instances de BrowserWindow de l'application Electron.
win.autoHideMenuBar
Propriété de type boolean qui détermine si la barre de menu de la fenêtre doit se cacher automatiquement. Une fois définie, la barre de menu ne s'affichera que lorsque les utilisateurs appuient sur la touche Alt seule.
Si la barre de menu est déjà visible, l'assignation à true de cette propriété ne cachera pas immédiatement la fenêtre.
win.simpleFullScreen
Propriété de type boolean déterminant si la fenêtre est en mode plein écran simple (pré-Lion).
win.fullScreen
Propriété de type boolean déterminant si la fenêtre est en mode plein écran.
win.focusable Windows macOS
Propriété de type boolean déterminant si cette fenêtre peut prendre le focus.
win.visibleOnAllWorkspaces macOS Linux
Propriété de type boolean déterminant si la fenêtre est visible sur tous les espaces de travail.
Note: Renvoie toujours false sur Windows.
win.shadow
Propriété de type boolean déterminant si la fenêtre est ombrée.
win.menuBarVisible Windows Linux
Propriété de type boolean déterminant si la barre de menu doit être visible.
Note: Si la barre de menu est masquée automatiquement, les utilisateurs peuvent toujours afficher la barre de menu en appuyant seulement sur la touche Alt.
win.kiosk
Propriété de type boolean déterminant si la fenêtre est en mode kiosque.
win.documentEdited macOS
Propriété de type boolean indiquant si le document de la fenêtre a été modifié.
Lorsque sa valeur est à true l'icône dans la barre de titre devient grisée.
win.representedFilename macOS
Propriété de type string qui détermine le chemin d'accès du fichier que la fenêtre représente, l'icône du fichier s'affichera dans la barre de titre de la fenêtre.
win.title
Propriété de type string déterminant le titre de la fenêtre native.
Note: : Le titre de la page web peut être différent du titre de la fenêtre native.
win.minimizable macOS Windows
Propriété de type boolean déterminant si la fenêtre peut être minimisée manuellement par l'utilisateur.
Sur Linux, le setter est un no-op, bien que le getter retourne true.
win.maximizable macOS Windows
Propriété de type boolean déterminant si la fenêtre peut être agrandie manuellement par l'utilisateur.
Sur Linux, le setter est un no-op, bien que le getter retourne true.
win.fullScreenable
Une propriété boolean qui détermine si le bouton maximiser/zoom de la fenêtre active le mode plein écran ou maximise la fenêtre.
win.resizable
Propriété de type boolean déterminant si la fenêtre peut être redimensionnée manuellement par l'utilisateur.
win.closable macOS Windows
Une propriété boolean qui détermine si la fenêtre peut être fermée manuellement par l'utilisateur.
Sur Linux, le setter est un no-op, bien que le getter retourne true.
win.movable macOS Windows
Une propriété boolean qui détermine si la fenêtre peut être déplacée par l'utilisateur.
Sur Linux, le setter est un no-op, bien que le getter retourne true.
win.excludedFromShownWindowsMenu macOS
Propriété boolean qui détermine si la fenêtre est exclue du menu Windows de l'application. false par défaut.
const win = new BrowserWindow({ height: 600, width: 600 })
const template = [
{
role: 'windowmenu'
}
]
gagne. xcludedFromShownWindowsMenu = true
const menu = Menu.buildFromTemplate(template)
Menu.setApplicationMenu(menu)
win.accessibleTitle
Propriété de type string définissant un titre alternatif fourni uniquement aux outils d'accessibilité tels que les lecteurs d'écran. Cette chaîne n'est pas directement visible par les utilisateurs.
Méthodes d’instance
Les objets créés avec new BrowserWindow disposent des méthodes d'instance suivantes :
Note : Certaines méthodes sont seulement disponibles sur des systèmes d'exploitation spécifiques et sont étiquetés comme tels.
win.destroy()
Force la fermeture de la fenêtre, les événement unload et beforeunload ne seront pas émises pour la page web, et l'évènement close ne sera pas non plus émis pour cette fenêtre, mais l'événement closed est garantit d'être émis.
win.close()
Essaye de fermer la fenêtre. Ceci a le même effet qu'un utilisateur cliquant manuellement sur le bouton de fermeture de la fenêtre. La page Web peut cependant annuler la fermeture. Voir l'événement close event.
win.focus()
Donne le focus à la fenêtre.
win.blur()
Retire le focus de la fenêtre.
win.isFocused()
Retourne boolean - Indique si la fenêtre à le focus.
win.isDestroyed()
Retourne boolean - Indique si la fenêtre est détruite.
win.show()
Affiche la fenêtre et lui donne le focus.
win.showInactive()
Affiche la fenêtre, mais ne la ramène pas au premier plan.
win.hide()
Masque la fenêtre.
win.isVisible()
Retourne un boolean - Indique si la fenêtre est visible par l'utilisateur au premier plan de l'application.
win.isModal()
Retourne boolean - Indique si la fenêtre actuelle est une fenêtre modale ou non.
win.maximize()
Maximise la fenêtre. Cela affichera également la fenêtre (mais sans lui donner le focus) si elle n'est pas déjà affichée.
win.unmaximize()
Réduit la fenêtre à sa taille initiale.
win.isMaximized()
Retourne boolean - Indique si la taille de la fenêtre est maximisée ou non.
win.minimize()
Minimise les fenêtres. Sur certaines plates-formes, la fenêtre réduite sera affichée dans le Dock.
win.restore()
Restaure la fenêtre depuis l'état réduit à son état précédent.
win.isMinimized()
Retourne boolean - Indique si la taille de la fenêtre est minimisée ou non.
win.setFullScreen(flag)
flagboolean
Définit si la fenêtre doit être en mode plein écran.
Remarque : Sur macOS, les transitions vers le plein écran se déroulent de manière asynchrone. Si d’autres actions dépendent de l’état plein écran, utilisez les événements 'enter-full-screen' ou 'leave-full-screen'.
win.isFullScreen()
Retourne boolean - Indique si la fenêtre est en plein écran ou non.
win.setSimpleFullScreen(flag) macOS
flagboolean
Entre ou sort du mode plein-écran simple.
Le mode plein-écran simple émule le comportement en plein-écran natif trouvé sur les versions de Mac OS X antérieures à Lion (10.7).
win.isSimpleFullScreen() macOS
Retourne boolean - Indique si la fenêtre est en mode plein-écran simple (pré-Lion) ou non.
win.isNormal()
Retourne boolean - Indique si la fenêtre est dans son état normal (ni maximisée, ni minimisée, ni en plein écran).
win.setAspectRatio(aspectRatio[, extraSize])
aspectRatioFloat - L'aspect ratio à maintenir pour une partie de la vue de contenu .extraSizeSize (facultatif) macOS - Taille supplémentaire à ne pas inclure tout en maintenant le rapport d'aspect.
Fera que la fenêtre maintiendra un certain rapport hauteur/largeur. La taille supplémentaire permet à un développeur d'avoir de l'espace, spécifié en pixels, non inclus dans les calculs de ratio de l'aspect. Cette API prend déjà en compte la différence entre la taille d'une fenêtre et la taille de son contenu.
Considérons une fenêtre normale avec un lecteur vidéo HD et des commandes associées. Il y a peut-être 15 pixels de contrôles sur le bord gauche, 25 pixels de contrôles sur le bord droit et 50 pixels de contrôles sous le lecteur. Afin de maintenir le rapport 16:9 (aspect standard pour la HD @1920x1080) dans le lecteur lui-même, nous appellerons cette fonction avec comme arguments 16/9 et { width: 40, height: 50 }. Le deuxième argument n'a pas d'importance tant que les largeur et hauteur supplémentaires restent dans les limites de la vue du contenu. On ajoutera toute largeur supplémentaire et les zones de hauteur que vous avez dans la vue de contenu globale.
Le ratio hauteur/largeur n'est pas respecté lorsque la fenêtre est redimensionnée par programme avec des APIs comme win.setSize.
Pour réinitialiser un rapport d'aspect, passez 0 comme valeur d'aspectRatio à : win.setAspectRatio(0).
win.setBackgroundColor(backgroundColor)
backgroundColorstring - Couleur en Hex, RGB, ARGB, HSL, HSLA ou une couleur CSS nommée. Le canal alpha est facultatif pour le type hexadécimal.
Exemples de valeurs valides pour backgroundColor :
- Hex
- #fff (RVB raccourci)
- #ffff (ARGB raccourci )
- #ffffff (RGB)
- #ffffffff (ARGB)
- RGB
- rgb(([\d]+),\s([\d]+),\s([\d]+))
- e.g. rgb(255, 255, 255)
- rgb(([\d]+),\s([\d]+),\s([\d]+))
- RGBA
- rgba(([\d]+),\s([\d]+),\s([\d]+),\s*([\d.]+))
- e.g. rgba(255, 255, 255, 1.0)
- rgba(([\d]+),\s([\d]+),\s([\d]+),\s*([\d.]+))
- HSL
- hsl((-?[\d.]+),\s([\d.]+)%,\s([\d.]+)%)
- e.g. hsl(200, 20%, 50%)
- hsl((-?[\d.]+),\s([\d.]+)%,\s([\d.]+)%)
- HSLA
- hsla((-?[\d.]+),\s([\d.]+)%,\s([\d.]+)%,\s*([\d.]+))
- e.g. hsla(200, 20%, 50%, 0.5)
- hsla((-?[\d.]+),\s([\d.]+)%,\s([\d.]+)%,\s*([\d.]+))
- Couleur nommée
- Les options sont listées dans SkParseColor.cpp
- Similaire aux mots-clés de CSS Color Module Level 3, mais sensible à la casse.
- e.g.
bluevioletorred
- e.g.
Définit la couleur de l'arrière-plan de la fenêtre. Voir Configuration de backgroundColor.
win.previewFile(path[, displayName]) macOS
pathstring - Le chemin absolu vers le fichier à prévisualiser avec QuickLook. Ceci est important car Quick Look utilise le nom de fichier et l'extension de fichier sur le chemin pour déterminer le type de contenu du fichier à ouvrir.displayNamestring (facultatif) - Le nom du fichier à afficher dans la vue modale de Quick Look . Ceci est purement visuel et n'affecte pas le type de contenu du fichier. Par défaut,chemin.
Utilise Quick Look pour prévisualiser un fichier avec un chemin donné.
win.closeFilePreview() macOS
Ferme le panneau Quick Look actuellement ouvert.
win.setBounds(bounds[, animate])
boundsPartial<Rectangle>animateboolean (facultatif) macOS
Redimensionne et déplace la fenêtre vers les limites fournies. Toutes les propriétés qui ne sont pas fournies seront par défaut à leurs valeurs actuelles.
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
// définit toutes les propriétés limites
gagner. etBounds({ x: 440, y: 225, width: 800, height: 600 })
// a fixé une propriété de simples limites
gagner. etBounds({ width: 100 })
// { x: 440, y: 225, width: 100, height: 600 }
console.log(win.getBounds())
Note: Sur macOS, la valeur de coordonnée y ne peut pas être inférieure à la hauteur du Tray. La hauteur du tray a changé au fil du temps et dépend du système d'exploitation, mais elle est comprise entre 20 et 40 px. Passer une valeur inférieure à la hauteur du tray résultera en une fenêtre supprimée du tray.
win.getBounds()
Retourne Rectangle - Un Object contenant les bounds de la fenêtre.
Note: Sur macOS, la valeur de coordonnée y ne peut pas être inférieure à la hauteur du Tray. Par exemple, appeler win.setBounds({ x: 25, y: 20, width: 800, height: 600 }) avec une hauteur de tray de 38 signifie que win.getBounds() retournera { x: 25, y: 38, width: 800, height: 600 }.
win.getBackgroundColor()
Retourne string - Indique la couleur d'arrière-plan de la fenêtre au format hexadécimal (#RRGGBB).
Voir Configuration de backgroundColor.
Note: La valeur du canal alpha n'est pas retournée en même temps que les valeurs rouge, vert et bleu.
win.setContentBounds(bounds[, animate])
boundsRectangleanimateboolean (facultatif) macOS
Redimensionne et déplace la zone client de la fenêtre (par exemple la page web) vers les limites fournies.
win.getContentBounds()
Retourne Rectangle - Les limites bounds de la zone client de la fenêtre sous la forme d'un Object.
win.getNormalBounds()
Retourne Rectangle - Contient les limites de la fenêtre de l'état normal
Remarque : quel que soit l'état actuel de la fenêtre : maximisé, minimisé ou en plein écran, retourne toujours la position et la taille de la fenêtre en état normal. En état normal, getBounds et getNormalBounds renvoient le même Rectangle.
win.setEnabled(enable)
enableboolean
Active ou désactive la fenêtre.
win.isEnabled()
Retourne boolean - Indique si la fenêtre est activée.
win.setSize(width, height[, animate])
widthIntegerheightIntegeranimateboolean (facultatif) macOS
Redimensionne la fenêtre à width x height. Si la largeur width ou la hauteur height sont inférieures aux minima définis, la fenêtre se limitera à sa taille minimale.
win.getSize()
Retourne Integer[] - Contient la largeur et la hauteur de la fenêtre.
win.setContentSize(width, height[, animate])
widthIntegerheightIntegeranimateboolean (facultatif) macOS
Redimensionne la zone client de la fenêtre (par exemple la page web) à largeur et hauteur.
win.getContentSize()
Retourne Integer[] - Contient la largeur et la hauteur de la zone client de la fenêtre.
win.setMinimumSize(width, height)
widthIntegerheightInteger
Définit la taille minimale de la fenêtre à width et height.
win.getMinimumSize()
Retourne Integer[] - Contient la largeur et la hauteur minimale de la fenêtre.
win.setMaximumSize(width, height)
widthIntegerheightInteger
Définit la taille maximale de la fenêtre à width et height.
win.getMaximumSize()
Retourne Integer[] - Contient la largeur et la hauteur maximale de la fenêtre.
win.setResizable(resizable)
resizableboolean
Définit si la fenêtre peut être redimensionnée ou pas par l’utilisateur.
win.isResizable()
Retourne boolean - Indique si la fenêtre peut être redimensionnée manuellement par l'utilisateur.
win.setMovable(movable) macOS Windows
movableboolean
Définit si la fenêtre peut être déplacée par l’utilisateur. N'a aucun effet sous Linux.
win.isMovable() macOS Windows
Retourne boolean - Indique si la fenêtre peut être déplacée par l'utilisateur.
Sous Linux, retourne toujours true.
win.setMinimizable(minimizable) macOS Windows
minimizableboolean
Définit si la fenêtre peut être minimisée par l’utilisateur. N'a aucun effet sous Linux.
win.isMinimizable() macOS Windows
Retourne boolean - Indique si la fenêtre peut être minimisée par l'utilisateur.
Sous Linux, retourne toujours true.
win.setMaximizable(maximizable) macOS Windows
maximizableboolean
Définit si la fenêtre peut être maximalisée par l’utilisateur. N'a aucun effet sous Linux.
win.isMaximizable() macOS Windows
Retourne boolean - Indique si la fenêtre peut être maximalisée manuellement par l'utilisateur.
Sous Linux, retourne toujours true.
win.setFullScreenable(fullscreenable)
fullscreenableboolean
Définit si le bouton agrandir/zoom de la fenêtre active/désactive le mode plein écran ou agrandit la fenêtre.
win.isFullScreenable()
Retourne boolean - Indique si le bouton agrandir/zoom de la fenêtre fait basculer en mode plein écran ou agrandit la fenêtre.
win.setClosable(closable) macOS Windows
closableboolean
Définit si la fenêtre peut être fermée manuellement par l'utilisateur. N'a aucun effet sous Linux.
win.isClosable() macOS Windows
Retourne boolean - Indique si la fenêtre peut être fermée manuellement par l'utilisateur.
Sous Linux, retourne toujours true.
win.setHiddenInMissionControl(hidden) macOS
hiddenboolean
Définit si la fenêtre sera masquée lorsque l'utilisateur uitilise Mission Control.
win.isHiddenInMissionControl() macOS
Retourne boolean - Indique si la fenêtre sera masquée lorsque l'utilisateur utilise Mission Control.
win.setAlwaysOnTop(flag[, level][, relativeLevel])
flagbooleanlevelstring (facultatif) macOS Windows - Les valeurs possibles sontnormal,floating,torn-off-menu,modal-panel,main-menu,status,pop-up-menu,screen-saver, et ~dock~~ (déprécié). La valeur par défaut estfloatinglorsqueflagest vrai. Leniveauest réinitialisé ànormallorsque le drapeau est faux. Notez que deflottantàstatutinclus, la fenêtre est placée sous le Dock sur macOS et sous la barre des tâches sous Windows. Depop-up-menuà une valeur supérieure, il est affiché au-dessus du Dock sur macOS et au-dessus de la barre des tâches sur Windows. Voir la documentation macOS pour plus de détails.relativeLevelInteger (facultatif) macOS - Le nombre de calques supérieurs à définir pour cette fenêtre par rapport auleveldonné. Par défaut,0. Notez qu'Apple décourage les réglages de niveau supérieur à 1 au-dessus descreen-saver.
Définit si la fenêtre doit toujours s'afficher au-dessus des autres fenêtres. Après être définie comme telle, la fenêtre est toujours une fenêtre normale et non pas une fenêtre d'outils ne pouvant pas prendre le focus.
win.isAlwaysOnTop()
Retourne boolean - Indique si la fenêtre est toujours au-dessus des autres fenêtres ou pas.
win.moveAbove(mediaSourceId)
mediaSourceIdstring - Id de la fenêtre au format de l'id DesktopCapturerSource. Par exemple "window:1869:0".
Déplace la fenêtre au-dessus de la fenêtre source dans l'ordre du z-order. Si le mediaSourceId n'est pas du type window ou si la fenêtre n'existe pas, alors cette méthode lance une erreur.
win.moveTop()
Déplace la fenêtre sur le dessus (dans l'ordre z) peu importe qu'elle ait le focus ou non
win.center()
Déplace la fenêtre vers le centre de l’écran.
win.setPosition(x, y[, animate])
xIntegeryIntegeranimateboolean (facultatif) macOS
Déplace la fenêtre à la position x et y.
win.getPosition()
Retourne Integer[] - Contient la position actuelle de la fenêtre.
win.setTitle(title)
titlestring
Remplace le titre de la fenêtre native par title.
win.getTitle()
Retourne string - Titre de la fenêtre native.
Note: : Le titre de la page web peut être différent du titre de la fenêtre native.
win.setSheetOffset(offsetY[, offsetX]) macOS
offsetYFloatoffsetXFloat (facultatif)
Modifie le point d'attachement des feuilles sur macOS. Par défaut, les feuilles sont attachées juste sous le cadre de la fenêtre, mais vous pouvez les afficher sous une barre d'outils affichée. Par exemple :
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
const toolbarRect = document.getElementById('toolbar').getBoundingClientRect()
win.setSheetOffset(toolbarRect.height)
win.flashFrame(flag)
flagboolean
Démarre ou arrête de faire clignoter la fenêtre pour attirer l'attention de l'utilisateur.
win.setSkipTaskbar(skip) macOS Windows
skipboolean
Fait que la fenêtre ne soit pas affichée dans la barre des tâches.
win.setKiosk(flag)
flagboolean
Entre ou sort du mode kiosque.
win.isKiosk()
Retourne boolean - Indique si la fenêtre est en mode kiosque.
win.isTabletMode() Windows
Retourne boolean - Indique si la fenêtre est en mode Windows 10 tablet.
Etat donné que les utilisateurs de Windows 10 peuvent utiliser leur PC comme une tablette, dans ce mode, les applications peuvent choisir d'optimiser leur interface utilisateur pour les tablettes, par exemple en élargissant la barre de titre et en masquant les boutons de la barre de titre.
Le retour de cette API indique si la fenêtre est en mode tablette, et l'événement resize pourra dans ce cas être utilisé pour écouter les changements en mode tablette.
win.getMediaSourceId()
Retourne string - Id de fenêtre au format des id de DesktopCapturerSource. Par exemple "window:1324:0".
Plus précisément, le format est window:id:other_id où id correspond au HWND sur Windows, et au CGWindowID (uint64_t) sur macOS et Window (unsigned long) sur Linux. other_id est utilisé pour identifier le contenu web (onglets) donc dans la même fenêtre de niveau supérieur.
win.getNativeWindowHandle()
Retourne Buffer - Le handle spécifique à la plate-forme de la fenêtre.
Le type natif du handle est HWND sous Windows, NSView* sur macOS, et Window (unsigned long) sous Linux.
win.hookWindowMessage(message, callback) Windows
messageIntegercallbackFunctionwParamany - LewParamqui a été fourni au WndProclParamany - LelParamqui a été fourni au WndProc
Accroche un message de fenêtre. La callback est appelée lorsque le message est reçu dans le WndProc.
win.isWindowMessageHooked(message) Windows
messageInteger
Retourne boolean - true ou false selon que le message est accroché.
win.unhookWindowMessage(message) Windows
messageInteger
Décroche le message de fenêtre.
win.unhookAllWindowMessages() Windows
Décroche tous les messages de fenêtre.
win.setRepresentedFilename(filename) macOS
filenamestring
Définit le chemin d'accès du fichier que la fenêtre représente, et l'icône du fichier s'affichera dans la barre de titre de la fenêtre.
win.getRepresentedFilename() macOS
Retourne string - Le chemin du fichier que la fenêtre représente.
win.setDocumentEdited(edited) macOS
editedboolean
Spécifie si le document de la fenêtre a été modifié, et l'icône de la barre de titre deviendra grisé lorsque la valeur est à true.
win.isDocumentEdited() macOS
Retourne boolean - Indique si le document de la fenêtre a été modifié.
win.focusOnWebView()
win.blurWebView()
win.capturePage([rect, opts])
rectRectangle (facultatif) - Les limites à captureroptsObject (facultatif)stayHiddenboolean (facultatif) - Maintient la page cachée au lieu de visible. Par défaut la valeur estfalse.stayAwakeboolean (facultatif) - Maintient le système hors veille. Par défaut la valeur estfalse.
Retourne Promise<NativeImage> - résout avec une NativeImage
Capture un instantané de la zone de la page définie par rect. Une capture de la page entière sera réalisée en l'absence de rect. Si la page n'est pas visible, rect peut être vide. La page est considérée visible lorsque sa BrowserWindow est cachée et que le nombre de captations n'est pas nul. Si vous souhaitez que la page reste cachée, vous devez vous assurer que stayHidden soit bien défini à true.
win.loadURL(url[, options])
urlstring
Retourne une Promise<void> - la promesse se résoudra lorsque la page aura terminé le chargement (voir did-finish-load), et rejettée si la page ne parvient pas à se charger (voir did-fail-load).
Identique à webContents.loadURL(url[, options]).
L'url peut être une adresse distante (par exemple http://) ou un chemin vers un fichier HTML local en utilisant le protocole file://.
Pour s'assurer que les URL de fichier sont correctement formatées, il est recommandé d'utiliser la méthode url.format de Node. :
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
const url = require('url').format({
protocol: 'file',
slashes: true,
pathname: require('node:path').join(__dirname, 'index.html')
})
win.loadURL(url)
Vous pouvez charger une URL en utilisant une requête POST avec des données encodées par URL en faisant ce qui suit :
const { BrowserWindow } = require('electron')
const win = new BrowserWindow()
win.loadURL('http://localhost:8000/post', {
postData: [{
type: 'rawData',
bytes: Buffer.from('hello=world')
}],
extraHeaders: 'Content-Type: application/x-www-form-urlencoded'
})
win.loadFile(filePath[, options])
filePathstring
Retourne une Promise<void> - la promesse se résoudra lorsque la page aura terminé le chargement (voir did-finish-load), et rejettée si la page ne parvient pas à se charger (voir did-fail-load).
Comme pour webContents.loadFile, filePath doit être un chemin relatif à la racine de votre application et pointant vers un fichier HTML. Voir la documentation de webContents pour plus d'informations.
win.reload()
Identique à webContents.reload.
win.setMenu(menu) Linux Windows
menuMenu | null
Définit menu comme barre de menu de la fenêtre.
win.removeMenu() Linux Windows
Retire la barre de menu de la fenêtre.
win.setProgressBar(progress[, options])
progressDouble
Définit la valeur de progression dans la barre de progression. La plage valide est [0, 1.0].
Supprime la barre de progression lorsque progress est < 0 ; Et Passe en mode indéterminé lorsque progress > 1.
Sur la plate-forme Linux, ne prend en charge que l'environnement de bureau Unity, vous devez spécifier le nom du fichier *.desktop pour le champ desktopName de package.json. Par défaut, {app.name}.desktop sera assumé.
Sous Windows, un mode peut être fournit. Les valeurs acceptées étant none, normal, indeterminate, error, et paused. Si vous appelez setProgressBar sans avoir défini de mode (mais avec une valeur dans la plage valide), normal sera utilisé.
win.setOverlayIcon(overlay, description) Windows
overlayNativeImage | null - l'icône à afficher en bas à droite de l'icône de la barre des tâches. Si ce paramètre estnull, l'overlay est effacédescriptionchaîne - une description qui sera fournie aux lecteurs d'écran d'accessibilité
Définit un overlay de 16 x 16 pixels sur l'icône actuelle de la barre des tâches, ceci est généralement utilisé pour transmettre une sorte de statut d'application ou pour notifier passivement l'utilisateur.
win.invalidateShadow() macOS
Invalide l’ombre de fenêtre afin qu’elle soit recalculée en fonction de la forme de fenêtre actuelle.
Les BrowserWindows transparentes peuvent parfois laisser des artefacts visuels sur macOS. Cette méthode peut être utilisée pour effacer ces artefacts lorsque, par exemple, une animation est réalisée.
win.setHasShadow(hasShadow)
hasShadowboolean
Définit si la fenêtre doit être ombrée ou non.
win.hasShadow()
Retourne boolean - Indique si la fenêtre est ombrée.
win.setOpacity(opacity) Windows macOS
opaciténombre - entre 0.0 (entièrement transparent) et 1.0 (entièrement opaque)
Définit l'opacité de la fenêtre. N'a aucun effet sous Linux. Les valeurs hors de limite sont restreintes dans la plage [0, 1].
win.getOpacity()
Retourne number - entre 0.0 (entièrement transparent) et 1.0 (entièrement opaque). Sur Linux, renvoie toujours 1.
win.setShape(rects) Windows Linux Experimental
rectsRectangle - Définit une forme dans la fenêtre. Le passage d'une liste vide fait revenir la fenêtre à la forme rectangulaire.
Définir une forme de fenêtre détermine la zone dans la fenêtre où le système permet de dessiner et d'interagir avec l'utilisateur. En dehors de la région donnée, aucun pixel ne sera dessiné et aucun événement de souris ne sera enregistré. Les événements de souris en dehors de la région ne seront pas reçus par cette fenêtre, mais seront transmis à tout ce qui se trouve derrière la fenêtre.
win.setThumbarButtons(buttons) Windows
buttonsThumbarButton[]
Retourne boolean - Indique si les boutons ont été ajoutés avec succès
Ajouter une barre d'outils miniature avec un ensemble de boutons spécifié à l'image de miniature d'une fenêtre dans la disposition d'un bouton de la barre des tâches. Retourne boolean - Indique si l'a miniature a été ajoutée avec succès.
Le nombre de boutons dans la barre d'outils miniature ne doit pas dépasser 7 en raison de l'espace limité disponible. Une fois que vous avez configuré la barre d'outils miniature, la barre d'outils ne peut pas être retirée en raison de limitation de la plateforme. Mais vous pouvez appeler l'API avec un tableau vide pour supprimer les boutons.
buttons est un tableau d'objets de type Button:
- Object
ButtoniconNativeImage - L'icône s'affichant dans la miniature dans la barre d'outils.clickFunctiontooltipstring (facultatif) - Le texte dans l'info-bulle du bouton.flagsstring[] (facultatif) - Contrôle les états et comportements spécifiques du bouton. Par défaut, il est['activé'].
Le flags est un tableau pouvant inclure ces strings suivant :
enabled- Le bouton est actif et disponible à l'utilisateur.désactivé- Le bouton est désactivé. Il est présent, mais a un état visuel indiquant qu'il ne répondra pas à l'action de l'utilisateur.dismissonclick- Lorsque le bouton est cliqué, la fenêtre de miniature se ferme immédiatement.nobackground- Utilise uniquement l'image et ne dessine pas de bordure sur le bouton.hidden- Le bouton n'est pas affiché à l'utilisateur.non interactif- Le bouton est activé mais non interactif ; aucun état de bouton n'est dessiné. Cette valeur est destinée aux cas où le bouton est utilisé dans une notification.
win.setThumbnailClip(region) Windows
regionRectangle - La région de la fenêtre
Définit la région de la fenêtre à afficher comme image de miniature affichée lors du survol de la fenêtre dans la barre des tâches. Vous pouvez réinitialiser la miniature afin qu'elle occupe toute la fenêtre en spécifiant une région vide : { x: 0, y: 0, width: 0, height: 0 }.
win.setThumbnailToolTip(toolTip) Windows
toolTipstring
Définit l'infobulle qui s'affiche en survolant la vignette de la fenêtre dans la barre des tâches.
win.setAppDetails(options) Windows
- Objet
optionsappIdstring (facultatif) - Fenêtre App User Model ID. Elle doit être définie, sinon les autres options n'auront aucun effet.appIconPathstring (facultatif) - Fenêtre Icône de relance.appIconIndexInteger (facultatif) - Index de l'icône dansappIconPath. Ignoré lorsqueappIconPathn'est pas défini. La valeur par défaut est0.relaunchCommandstring (facultatif) - La Relaunch Commandde Windows.relaunchDisplayNamestring (facultatif) - Window's Relaunch Display Name.
Définit les propriétés du bouton de la barre des tâches de la fenêtre.
Note: relaunchCommand et relaunchDisplayName doivent toujours être définies ensemble. Si l'une de ces propriétés n'est pas définie, aucune d'elles ne sera utilisée.
win.showDefinitionForSelection() macOS
Identique à webContents.showDefinitionForSelection().
win.setIcon(icon) Windows Linux
iconNativeImage | string
Change l'icône de la fenêtre.
win.setWindowButtonVisibility(visible) macOS
visibleboolean
Définit si les boutons feux de circulation de la fenêtre doivent être visibles.
win.setAutoHideMenuBar(hide) Windows Linux
hideboolean
Définit si la barre de menus de la fenêtre doit se cacher automatiquement. Une fois définie, la barre de menu ne s'affichera que lorsque les utilisateurs appuient sur la seule touche Alt.
Si la barre de menu est déjà visible, l'appel à setAutoHideMenuBar(true) ne le cachera pas immédiatement.
win.isMenuBarAutoHide() Windows Linux
Retourne boolean - Indique si la barre de menu se cache automatiquement.
win.setMenuBarVisibility(visible) Windows Linux
visibleboolean
Définit si la barre de menu doit être visible. Si la barre de menu est definie comme auto-hide, les utilisateurs peuvent toujours afficher la barre de menu en appuyant sur la seule touche Alt.
win.isMenuBarVisible() Windows Linux
Retourne boolean - Indique si la barre de menu est visible.
win.setVisibleOnAllWorkspaces(visible[, options]) macOS Linux
visibleboolean
Définit si la fenêtre doit être visible sur tous les espaces de travail.
Note: Cette API ne fonctionne pas sous Windows.
win.isVisibleOnAllWorkspaces() macOS Linux
Retourne boolean - Indique si la fenêtre est visible sur tous les espaces de travail.
Remarque : Cette API retourne toujours false sur Windows.
win.setIgnoreMouseEvents(ignore[, options])
ignoreboolean
Fait que la fenêtre ignore tous les événements de la souris.
Tous les événements survenus dans cette fenêtre seront transmis à la fenêtre sous cette fenêtre, mais si cette fenêtre a le focus, elle recevra toujours les événements du clavier .
win.setContentProtection(enable) macOS Windows
enableboolean
Empêche le contenu de la fenêtre d'être capturé par d'autres applications.
Sous macOS, cela attribue la valeur la valeur NSWindowSharingNone au type de partage NSWindows . Sous Windows, effectue l'appel à SetWindowDisplayAffinity avec WDA_EXCLUDEFROMCAPTURE. Pour Windows 10 version 2004 et supérieures, la fenêtre sera complètement exclue de la capture, les anciennes versions de Windows se comportent comme si WDA_MONITOR était appliqué, capturant une fenêtre noire.
win.setFocusable(focusable) macOS Windows
focusableboolean
Indique si la fenêtre peut prendre le focus.
Sur macOS, ne supprime pas le focus de la fenêtre.
win.isFocusable() macOS Windows
Retourne boolean - Indique si la fenêtre peut prendre le focus.
win.setParentWindow(parent)
parentBrowserWindow | null
Définit parent comme la fenêtre parent de la fenêtre actuelle, le passage de null transformera la fenêtre actuelle en une fenêtre de niveau supérieur.
win.getParentWindow()
Retourne BrowserWindow | null - La fenêtre parente ou null s'il n'y a pas de parent.
win.getChildWindows()
Retourne BrowserWindow[] - Toutes les fenêtres enfants.
win.setAutoHideCursor(autoHide) macOS
autoHideboolean
Contrôle s'il faut masquer le curseur lors de la saisie.
win.selectPreviousTab() macOS
Sélectionne l'onglet précédent lorsque les onglets natifs sont activés et qu'il y a d'autres onglets dans la fenêtre.
win.selectNextTab() macOS
Sélectionne l'onglet suivant lorsque les onglets natifs sont activés et qu'il y a d'autres onglets dans la fenêtre.
win.mergeAllWindows() macOS
Fusionne toutes les fenêtres en une seule fenêtre avec plusieurs onglets lorsque les onglets natifs sont activés et qu'il y a plus d'une fenêtre ouverte.
win.moveTabToNewWindow() macOS
Déplace l'onglet actuel dans une nouvelle fenêtre si les onglets natifs sont activés et qu'il y a plus d'un onglet dans la fenêtre actuelle.
win.toggleTabBar() macOS
Active/désactive la visibilité de la barre d’onglets si les onglets natifs sont activés et qu'il n’y a qu’un seul onglet dans la fenêtre actuelle.
win.addTabbedWindow(browserWindow) macOS
browserWindowBrowserWindow
Ajoute une fenêtre sous la forme d'un onglet après l'onglet de l'instance de fenêtre.
win.setVibrancy(type) macOS
typestring | null - Peut êtreappearance-based,light,dark,titlebar,selection,menu,popover,sidebar,medium-light,ultra-dark,header,sheet,window,hud,fullscreen-ui,tooltip,content,sous-window, ousous-page. Voir la documentation macOS pour plus de détails.
Ajoute un effet de vibration à la fenêtre du navigateur. Passer null ou une chaîne vide supprimera l’effet de vibration sur la fenêtre.
Notez que appearance-based, light, dark, medium-light, et ultra-dark sont obsolètes et seront supprimées dans une prochaine version de macOS.
win.setBackgroundMaterial(material) Windows
materialstringauto- Indique que le Gestionnaire de fenêtres de bureau (DWM) décidera automatiquement de la toile de fond tracée par le système pour cette fenêtre. C'est le comportement par défaut.none- Ne pas dessiner d'arrière-plan système.mica- Dessine l’arrière-plan correspondant à une fenêtre de longue durée.acrylic- Dessine l'effet de matériau d'arrière-plan correspondant à une fenêtre transitoire.tabbed- Dessine l'arrière-plan correspondant à une fenêtre avec barre de titre à onglets.
Cette méthode définit l'arrière-plan de la fenêtre du navigateur, y compris derrière la zone non-client.
Consultez la documentation de Windows pour plus de détails.
Remarque : Cette méthode n'est prise en charge qu'à partir de Windows 11 22H2.
win.setWindowButtonPosition(position) macOS
positionPoint | null
Définit une position personnalisée pour les boutons de feux de signalisation dans une fenêtre sans cadre. Le passage de null réinitialisera la position par défaut.
win.getWindowButtonPosition() macOS
Retourne Point | null - La position personnalisée pour les boutons de feux de circulation dans la fenêtre sans cadres, null sera retournée lorsqu'il n'y a pas de position personnalisée.
win.setTrafficLightPosition(position) macOS Déprécié
positionPoint
Définit une position personnalisée pour les boutons de feux de signalisation dans une fenêtre sans cadre. Le passage de { x: 0, y: 0 } réinitialisera la position par défaut.
Remarque : cette fonction est obsolète. Utilisez à la place setWindowButtonPosition.
win.getTrafficLightPosition() macOS Déprécié
Retourne Point - La position personnalisée pour les boutons de feux de circulation dans une fenêtre sans cadre, { x: 0, y: 0 } sera retourné lorsqu'il n'y a pas de position personnalisée.
Remarque : cette fonction est obsolète. Utilisez à la place setWindowButtonPosition.
win.setTouchBar(touchBar) macOS
touchBarTouchBar | null
Définit la disposition de la barre tactile pour la fenêtre actuelle. La spécification de null ou d' undefined efface la barre tactile. Cette méthode n'a un effet que si la machine a une touch bar.
Remarque : L’API TouchBar est actuellement expérimentale et peut changer ou être supprimée dans les futures mises à jour d'Electron.
win.setBrowserView(browserView) Experimental
browserViewBrowserView | null - Attache unebrowserViewàwin. Si d'autresBrowserViewsont déjà attachées, elles seront supprimées de cette fenêtre.
win.getBrowserView() Expérimental
Retourne BrowserView | null - La BrowserView attachée à win. Retourne null si aucune n'est attachée. Déclenche une erreur si plusieurs BrowserView sont attachées.
win.addBrowserView(browserView) Expérimental
browserViewBrowserView
API de remplacement pour setBrowserView prenant en charge le travail avec plusieurs BrowserView.
win.removeBrowserView(browserView) Expérimental
browserViewBrowserView
win.setTopBrowserView(browserView) Expérimental
browserViewBrowserView
Pousse la browserView au-dessus des autres BrowserViews attachés à win. Lance une erreur si browserView n'est pas attaché à win.
win.getBrowserViews() Experimental
Retourne BrowserView[] - un tableau de toutes les BrowserViews qui ont été attachées avec l'une ou l'autre des méthodes addBrowserView ou setBrowserView.
Note : L'API BrowserView est actuellement expérimentale et pourra changer ou être supprimée dans les futures versions d'Electron.
win.setTitleBarOverlay(options) Windows
- Objet
optionscolorString (facultatif) Windows - Couleur CSS de l'overlay des contrôles de fenêtres lorsqu'il est activé.symbolColorString (facultatif) Windows - Couleur CSS des symboles de l'overlay des contrôles de fenêtres lorsqu'il est activé.heightInteger (facultatif) Windows - Hauteur exprimée en pixels de la barre de titre et de l'overlay des contrôles de fenêtre.
Cette méthode met à jour le style de la superposition de la barre de titre dans le cas d'une fenêtre avec l'overlay des contrôles de fenêtre déjà activé, .