BaseWindow

Create and control windows.

Process: Main

Note BaseWindow provides a flexible way to compose multiple web views in a single window. For windows with only a single, full-size web view, the BrowserWindow class may be a simpler option.

This module cannot be used until the ready event of the app module is emitted.

// In the main process.
const { BaseWindow, WebContentsView } = require('electron')

const win = new BaseWindow({ width: 800, height: 600 })

const leftView = new WebContentsView()
leftView.webContents.loadURL('https://electronjs.org')
win.contentView.addChildView(leftView)

const rightView = new WebContentsView()
rightView.webContents.loadURL('https://github.com/electron/electron')
win.contentView.addChildView(rightView)

leftView.setBounds({ x: 0, y: 0, width: 400, height: 600 })
rightView.setBounds({ x: 400, y: 0, width: 400, height: 600 })

Ventana principal y ventana secundaria

By using parent option, you can create child windows:

const { BaseWindow } = require('electron')

const parent = new BaseWindow()
const child = new BaseWindow({ parent })

The child window will always show on top of the parent window.

Ventanas modales

A modal window is a child window that disables parent window. To create a modal window, you have to set both the parent and modal options:

const { BaseWindow } = require('electron')

const parent = new BaseWindow()
const child = new BaseWindow({ parent, modal: true })

Notas según la plataforma

• En macOS las ventanas modales se mostrarán como hojas adjuntas a la ventana principal.
• On macOS the child windows will keep the relative position to parent window when parent window moves, while on Windows and Linux child windows will not move.
• On Linux the type of modal windows will be changed to dialog.
• En Linux, muchos entornos de escritorio no admiten ocultar una ventana modal.

Class: BaseWindow

Create and control windows.

Process: Main

BaseWindow is an EventEmitter.

It creates a new BaseWindow with native properties as set by the options.

new BaseWindow([options])

• options BaseWindowConstructorOptions (optional)
  • width Integer (optional) - Window's width in pixels. Default is 800.
  • height Integer (optional) - Window's height in pixels. Default is 600.
  • x Integer (optional) - (required if y is used) Window's left offset from screen. Por defecto es centrar en la ventana.
  • y Integer (optional) - (required if x is used) Window's top offset from screen. Por defecto es centrar en la ventana.
  • useContentSize boolean (optional) - The width and height would be used as web page's size, which means the actual window's size will include window frame's size and be slightly larger. Default is false.
  • center boolean (optional) - Show window in the center of the screen. Default is false.
  • minWidth Integer (optional) - Window's minimum width. Default is 0.
  • minHeight Integer (optional) - Window's minimum height. Default is 0.
  • maxWidth Integer (optional) - Window's maximum width. Por defecto no hay limite.
  • maxHeight Integer (optional) - Window's maximum height. Por defecto no hay limite.
  • resizable boolean (optional) - Whether window is resizable. Default is true.
  • movable boolean (optional) macOS Windows - Whether window is movable. This is not implemented on Linux. Default is true.
  • minimizable boolean (optional) macOS Windows - Whether window is minimizable. This is not implemented on Linux. Default is true.
  • maximizable boolean (optional) macOS Windows - Whether window is maximizable. This is not implemented on Linux. Default is true.
  • closable boolean (optional) macOS Windows - Whether window is closable. This is not implemented on Linux. Default is true.
  • focusable boolean (optional) - Whether the window can be focused. Default is true. On Windows setting focusable: false also implies setting skipTaskbar: true. On Linux setting focusable: false makes the window stop interacting with wm, so the window will always stay on top in all workspaces.
  • alwaysOnTop boolean (optional) - Whether the window should always stay on top of other windows. Default is false.
  • fullscreen boolean (optional) - Whether the window should show in fullscreen. When explicitly set to false the fullscreen button will be hidden or disabled on macOS. Default is false.
  • fullscreenable boolean (optional) - Whether the window can be put into fullscreen mode. On macOS, also whether the maximize/zoom button should toggle full screen mode or maximize window. Default is true.
  • simpleFullscreen boolean (optional) macOS - Use pre-Lion fullscreen on macOS. Default is false.
  • skipTaskbar boolean (optional) macOS Windows - Whether to show the window in taskbar. Default is false.
  • hiddenInMissionControl boolean (optional) macOS - Whether window should be hidden when the user toggles into mission control.
  • kiosk boolean (optional) - Whether the window is in kiosk mode. Default is false.
  • title string (optional) - Default window title. Default is "Electron". If the HTML tag <title> is defined in the HTML file loaded by loadURL(), this property will be ignored.
  • icon (NativeImage | string) (optional) - The window icon. On Windows it is recommended to use ICO icons to get best visual effects, you can also leave it undefined so the executable's icon will be used.
  • show boolean (optional) - Whether window should be shown when created. Default is true.
  • frame boolean (optional) - Specify false to create a frameless window. Default is true.
  • parent BaseWindow (optional) - Specify parent window. Default is null.
  • modal boolean (optional) - Whether this is a modal window. This only works when the window is a child window. Default is false.
  • acceptFirstMouse boolean (optional) macOS - Whether clicking an inactive window will also click through to the web contents. Default is false on macOS. This option is not configurable on other platforms.
  • disableAutoHideCursor boolean (optional) - Whether to hide cursor when typing. Default is false.
  • autoHideMenuBar boolean (optional) - Auto hide the menu bar unless the Alt key is pressed. Default is false.
  • enableLargerThanScreen boolean (optional) macOS - Enable the window to be resized larger than screen. Only relevant for macOS, as other OSes allow larger-than-screen windows by default. Default is false.
  • backgroundColor string (optional) - The window's background color in Hex, RGB, RGBA, HSL, HSLA or named CSS color format. Alpha in #AARRGGBB format is supported if transparent is set to true. Default is #FFF (white). See win.setBackgroundColor for more information.
  • hasShadow boolean (optional) - Whether window should have a shadow. Default is true.
  • opacity number (optional) macOS Windows - Set the initial opacity of the window, between 0.0 (fully transparent) and 1.0 (fully opaque). This is only implemented on Windows and macOS.
  • darkTheme boolean (optional) - Forces using dark theme for the window, only works on some GTK+3 desktop environments. Default is false.
  • transparent boolean (optional) - Makes the window transparent. Default is false. En Windows, no funciona a menos que la ventana sea sin marco.
  • type string (optional) - The type of window, default is normal window. See more about this below.
  • visualEffectState string (optional) macOS - Specify how the material appearance should reflect window activity state on macOS. Must be used with the vibrancy property. Los valores posibles son:
    • followWindow - The backdrop should automatically appear active when the window is active, and inactive when it is not. Este es el valor predeterminado.
    • active - The backdrop should always appear active.
    • inactive - The backdrop should always appear inactive.
  • titleBarStyle string (optional) - The style of window title bar. Default is default. Los valores posibles son:
    • default - Results in the standard title bar for macOS or Windows respectively.
    • hidden - Results in a hidden title bar and a full size content window. On macOS, the window still has the standard window controls (“traffic lights”) in the top left. On Windows and Linux, when combined with titleBarOverlay: true it will activate the Window Controls Overlay (see titleBarOverlay for more information), otherwise no window controls will be shown.
    • hiddenInset macOS - Results in a hidden title bar with an alternative look where the traffic light buttons are slightly more inset from the window edge.
    • customButtonsOnHover macOS - Results in a hidden title bar and a full size content window, the traffic light buttons will display when being hovered over in the top left of the window. Note: This option is currently experimental.
  • titleBarOverlay Object | Boolean (optional) - When using a frameless window in conjunction with win.setWindowButtonVisibility(true) on macOS or using a titleBarStyle so that the standard window controls ("traffic lights" on macOS) are visible, this property enables the Window Controls Overlay JavaScript APIs and CSS Environment Variables. Specifying true will result in an overlay with default system colors. Default is false.
    • color String (optional) Windows Linux - The CSS color of the Window Controls Overlay when enabled. Default is the system color.
    • symbolColor String(opcional) Windows - El color CSS de los símbolos en el Window Controls Overlay cuando este habilitado. Default is the system color.
    • height Integer (optional) - The height of the title bar and Window Controls Overlay in pixels. Default is system height.
  • trafficLightPosition Point (optional) macOS - Set a custom position for the traffic light buttons in frameless windows.
  • roundedCorners boolean (optional) macOS - Whether frameless window should have rounded corners on macOS. Default is true. Setting this property to false will prevent the window from being fullscreenable.
  • thickFrame boolean (optional) - Use WS_THICKFRAME style for frameless windows on Windows, which adds standard window frame. Setting it to false will remove window shadow and window animations. Default is true.
  • vibrancy string (optional) macOS - Add a type of vibrancy effect to the window, only on macOS. Can be appearance-based, titlebar, selection, menu, popover, sidebar, header, sheet, window, hud, fullscreen-ui, tooltip, content, under-window, or under-page.
  • backgroundMaterial string (optional) Windows - Set the window's system-drawn background material, including behind the non-client area. Can be auto, none, mica, acrylic or tabbed. See win.setBackgroundMaterial for more information.
  • 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. Default is false.
  • 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. Los valores posibles son:

• On Linux, possible types are desktop, dock, toolbar, splash, notification.
  • The desktop type places the window at the desktop background window level (kCGDesktopWindowLevel - 1). However, note that a desktop window will not receive focus, keyboard, or mouse events. You can still use globalShortcut to receive input sparingly.
  • 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. This type is commonly used for splash screens.
  • 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 (NSWindowStyleMaskTexturedBackground).
  • 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.

Eventos de Instancia

Objects created with new BaseWindow emit the following events:

Note: Some events are only available on specific operating systems and are labeled as such.

Evento: "close"

Devuelve:

• event Event

Aparece cuando la ventana se va a cerrar. It's emitted before the beforeunload and unload event of the DOM. Calling event.preventDefault() will cancel the close.

Usually you would want to use the beforeunload handler to decide whether the window should be closed, which will also be called when the window is reloaded. In Electron, returning any value other than undefined would cancel the close. Por ejemplo:

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.
  // It is recommended to use the dialog API to let the user confirm closing the
  // application.
  e.returnValue = false
}

Note: There is a subtle difference between the behaviors of window.onbeforeunload = handler and window.addEventListener('beforeunload', handler). It is recommended to always set the event.returnValue explicitly, instead of only returning a value, as the former works more consistently within Electron.

Evento: "closed"

Emitted when the window is closed. Después de haber recibido este evento, debe eliminar la referencia a la ventana y evitar volverla a usar.

Event: 'session-end' Windows

Aparece cuando la sesión de la ventana va a terminarse debido a un cierre forzoso o el reinicio de la máquina o el cierre de la sesión.

Evento: "blur"

Aparece cuando la ventana pierde el enfoque.

Evento: "focus"

Aparece cuando la ventana recupera el enfoque.

Evento: "show"

Aparece cuando se muestra la ventana.

Evento: "hide"

Aparece cuando se oculta la ventana.

Evento: "maximize"

Aparece cuando se maximiza la ventana.

Evento: "unmaximize"

Aparece cuando la ventana sale de un estado maximizado.

Evento: "minimize"

Aparece cuando se minimiza la ventana.

Evento: "restore"

Aparece cuando se restaura la ventana de un estado minimizado.

Event: 'will-resize' macOS Windows

Devuelve:

• event Event
• newBounds Rectangle - Size the window is being resized to.
• details Object
  • edge (string) - The edge of the window being dragged for resizing. Can be bottom, left, right, top-left, top-right, bottom-left or bottom-right.

Emitido antes de que la ventana sea redimensionada. Calling event.preventDefault() will prevent the window from being resized.

Tenga en cuenta que esto solo es emitido cuando la venta está siendo redimensionada de forma manual. Resizing the window with setBounds/setSize will not emit this event.

The possible values and behaviors of the edge option are platform dependent. Los valores posibles son:

• On Windows, possible values are bottom, top, left, right, top-left, top-right, bottom-left, bottom-right.
• On macOS, possible values are bottom and right.
  • The value bottom is used to denote vertical resizing.
  • The value right is used to denote horizontal resizing.

Evento: "resize"

Emitido después que la ventana se haya redimensionada.

Event: 'resized' macOS Windows

Emitted once when the window has finished being resized.

This is usually emitted when the window has been resized manually. On macOS, resizing the window with setBounds/setSize and setting the animate parameter to true will also emit this event once resizing has finished.

Event: 'will-move' macOS Windows

Devuelve:

• event Event
• newBounds Rectangle - Location the window is being moved to.

Emitted before the window is moved. On Windows, calling event.preventDefault() will prevent the window from being moved.

Note that this is only emitted when the window is being moved manually. Moving the window with setPosition/setBounds/center will not emit this event.

Evento: "move"

Aparece cuando la ventana se mueve a una nueva posición.

Event: 'moved' macOS Windows

Aparece solo una vez cuando la ventana se mueve a una nueva posición.

Note: On macOS this event is an alias of move.

Evento: "enter-full-screen"

Aparece cuando la ventana entra en un estado pantalla completa.

Evento: "leave-full-screen"

Aparece cuando la ventana sale del estado pantalla completa.

Evento: 'always-on-top-changed'

Devuelve:

• event Event
• isAlwaysOnTop boolean

Emitido cuando la ventana es configurada o no configurada para mostrarse siempre en la parte superior de las otras ventanas.

Event: 'app-command' Windows Linux

Devuelve:

• event Event
• command string

Emitted when an App Command is invoked. Estos están generalmente relacionados a las teclas del teclado o a los comandos del navegador, así como el botón "Back" está en algunos ratones en Windows.

Commands are lowercased, underscores are replaced with hyphens, and the APPCOMMAND_ prefix is stripped off. e.g. APPCOMMAND_BROWSER_BACKWARD is emitted as browser-backward.

const { BaseWindow } = require('electron')
const win = new BaseWindow()
win.on('app-command', (e, cmd) => {
  // Navigate the window back when the user hits their mouse back button
  if (cmd === 'browser-backward') {
    // Find the appropriate WebContents to navigate.
  }
})

Los siguientes comandos de aplicación están explícitamente soportados en Linux:

• browser-backward
• browser-forward

Event: 'swipe' macOS

Devuelve:

• event Event
• direction string

Emitted on 3-finger swipe. Possible directions are up, right, down, left.

El método subyacente a este evento esta construido para manejar el viejo estilo de desplazamiento del trackpad de macOS, donde el contenido de la pantalla no se mueve con el manotazo. Most macOS trackpads are not configured to allow this kind of swiping anymore, so in order for it to emit properly the 'Swipe between pages' preference in System Preferences > Trackpad > More Gestures must be set to 'Swipe with two or three fingers'.

Event: 'rotate-gesture' macOS

Devuelve:

• event Event
• rotation Float

Emitido en el gesto de rotación de trackpad. Continuamente emitido hasta que el gesto de rotación se termine. The rotation value on each emission is the angle in degrees rotated since the last emission. The last emitted event upon a rotation gesture will always be of value 0. Los valores de rotación en sentido antihorario son positivos, mientras que los valores de rotación en sentido horario son negativos.

Event: 'sheet-begin' macOS

Aparece cuando la ventana abre una hoja.

Event: 'sheet-end' macOS

Aparece cuando la ventana cierra una hoja.

Event: 'new-window-for-tab' macOS

Aparece cuando se hace clic al botón de nueva pestaña nativa.

Event: 'system-context-menu' Windows

Devuelve:

• event Event
• point Point - The screen coordinates the context menu was triggered at

Emitido cuando el menú contextual del sistema es activado en la ventana, esto normalmente solo es activado cuando el usuario hace click derecho en el área que no es del cliente de la ventana. This is the window titlebar or any area you have declared as -webkit-app-region: drag in a frameless window.

Calling event.preventDefault() will prevent the menu from being displayed.

Métodos Estáticos

The BaseWindow class has the following static methods:

BaseWindow.getAllWindows()

Returns BaseWindow[] - An array of all opened browser windows.

BaseWindow.getFocusedWindow()

Returns BaseWindow | null - The window that is focused in this application, otherwise returns null.

BaseWindow.fromId(id)

• id Integer

Returns BaseWindow | null - The window with the given id.

Propiedades de la instancia

Objects created with new BaseWindow have the following properties:

const { BaseWindow } = require('electron')
// In this example `win` is our instance
const win = new BaseWindow({ width: 800, height: 600 })

win.id Readonly

A Integer property representing the unique ID of the window. Each ID is unique among all BaseWindow instances of the entire Electron application.

win.contentView

A View property for the content view of the window.

win.tabbingIdentifier macOS Readonly

A string (optional) property that is equal to the tabbingIdentifier passed to the BrowserWindow constructor or undefined if none was set.

win.autoHideMenuBar

A boolean property that determines whether the window menu bar should hide itself automatically. Once set, the menu bar will only show when users press the single Alt key.

If the menu bar is already visible, setting this property to true won't hide it immediately.

win.simpleFullScreen

A boolean property that determines whether the window is in simple (pre-Lion) fullscreen mode.

win.fullScreen

A boolean property that determines whether the window is in fullscreen mode.

win.focusable Windows macOS

A boolean property that determines whether the window is focusable.

win.visibleOnAllWorkspaces macOS Linux

A boolean property that determines whether the window is visible on all workspaces.

Note: Always returns false on Windows.

win.shadow

A boolean property that determines whether the window has a shadow.

win.menuBarVisible Windows Linux

A boolean property that determines whether the menu bar should be visible.

Note: If the menu bar is auto-hide, users can still bring up the menu bar by pressing the single Alt key.

win.kiosk

A boolean property that determines whether the window is in kiosk mode.

win.documentEdited macOS

A boolean property that specifies whether the window’s document has been edited.

The icon in title bar will become gray when set to true.

win.representedFilename macOS

A string property that determines the pathname of the file the window represents, and the icon of the file will show in window's title bar.

win.title

A string property that determines the title of the native window.

Note: The title of the web page can be different from the title of the native window.

win.minimizable macOS Windows

A boolean property that determines whether the window can be manually minimized by user.

On Linux the setter is a no-op, although the getter returns true.

win.maximizable macOS Windows

A boolean property that determines whether the window can be manually maximized by user.

On Linux the setter is a no-op, although the getter returns true.

win.fullScreenable

A boolean property that determines whether the maximize/zoom window button toggles fullscreen mode or maximizes the window.

win.resizable

A boolean property that determines whether the window can be manually resized by user.

win.closable macOS Windows

A boolean property that determines whether the window can be manually closed by user.

On Linux the setter is a no-op, although the getter returns true.

win.movable macOS Windows

A boolean property that determines Whether the window can be moved by user.

On Linux the setter is a no-op, although the getter returns true.

win.excludedFromShownWindowsMenu macOS

A boolean property that determines whether the window is excluded from the application’s Windows menu. false by default.

const { Menu, BaseWindow } = require('electron')
const win = new BaseWindow({ height: 600, width: 600 })

const template = [
  {
    role: 'windowmenu'
  }
]

win.excludedFromShownWindowsMenu = true

const menu = Menu.buildFromTemplate(template)
Menu.setApplicationMenu(menu)

win.accessibleTitle

A string property that defines an alternative title provided only to accessibility tools such as screen readers. Esta cadena no es directamente visible para los usuarios.

Métodos de Instancia

Objects created with new BaseWindow have the following instance methods:

Note: Some methods are only available on specific operating systems and are labeled as such.

win.setContentView(view)

• view View

Sets the content view of the window.

win.getContentView()

Returns View - The content view of the window.

win.destroy()

Force closing the window, the unload and beforeunload event won't be emitted for the web page, and close event will also not be emitted for this window, but it guarantees the closed event will be emitted.

win.close()

Trate de cerrar la ventana. Esto tiene el mismo efecto que un usuario pulsando manualmente el botón cerrar de la ventana. The web page may cancel the close though. See the close event.

win.focus()

Enfoca la ventana.

win.blur()

Elimina el enfoque de la ventana.

win.isFocused()

Returns boolean - Whether the window is focused.

win.isDestroyed()

Returns boolean - Whether the window is destroyed.

win.show()

Muestra la ventana y la enfoca.

win.showInactive()

Muestra la ventana pero no la enfoca.

win.hide()

Oculta la ventana.

win.isVisible()

Returns boolean - Whether the window is visible to the user in the foreground of the app.

win.isModal()

Returns boolean - Whether current window is a modal window.

win.maximize()

Maximiza la ventana. This will also show (but not focus) the window if it isn't being displayed already.

win.unmaximize()

Sale del estado maximizado de la ventana.

win.isMaximized()

Returns boolean - Whether the window is maximized.

win.minimize()

Minimiza la ventana. On some platforms the minimized window will be shown in the Dock.

win.restore()

Restaura la ventana desde un estado minimizado a su estado previo.

win.isMinimized()

Returns boolean - Whether the window is minimized.

win.setFullScreen(flag)

• flag boolean

Establece si la ventana debe estar o no en modo pantalla completa.

Note: On macOS, fullscreen transitions take place asynchronously. If further actions depend on the fullscreen state, use the 'enter-full-screen' or 'leave-full-screen' events.

win.isFullScreen()

Returns boolean - Whether the window is in fullscreen mode.

win.setSimpleFullScreen(flag) macOS

• flag boolean

Entra o sale del modo simple de pantalla completa.

Simple fullscreen mode emulates the native fullscreen behavior found in versions of macOS prior to Lion (10.7).

win.isSimpleFullScreen() macOS

Returns boolean - Whether the window is in simple (pre-Lion) fullscreen mode.

win.isNormal()

Returns boolean - Whether the window is in normal state (not maximized, not minimized, not in fullscreen mode).

win.setAspectRatio(aspectRatio[, extraSize])

• aspectRatio Float - The aspect ratio to maintain for some portion of the content view.
• extraSize Size (optional) macOS - The extra size not to be included while maintaining the aspect ratio.

Esto hará que la ventana mantenga una relación de aspecto. El tamaño extra permite al desarrollador tener espacio especificado en píxeles, el cual no está incluido dentro de los cálculos de la relación de aspecto. Esta API ya toma en cuenta la diferencia entre el tamaño de la ventana y el tamaño del contenido.

Considere una ventana normal con un reproductor de video HD y los controles asociados. Quizá hay 15 pixeles de controles en el borde izquierdo, 25 pixeles de control en el borde derecho y 50 pixeles de control bajo el reproductor. Para mantener una relación de aspecto 16:9 (relación de aspecto estándar para HD @1920x1080) dentro del reproductor tendríamos que llamar esta función con argumentos de 16/9 y { width: 40, height: 50 . En el segundo argumento no importa donde están la anchura extra ni altura extra dentro de la vista del contenido, solo importa que existan. Suma cualquier áreas de ancho y alto adicionales que tengas dentro de la vista de contenido general.

The aspect ratio is not respected when window is resized programmatically with APIs like win.setSize.

To reset an aspect ratio, pass 0 as the aspectRatio value: win.setAspectRatio(0).

win.setBackgroundColor(backgroundColor)

• backgroundColor string - Color in Hex, RGB, RGBA, HSL, HSLA or named CSS color format. The alpha channel is optional for the hex type.

Examples of valid backgroundColor values:

• Hex
  • #fff (shorthand RGB)
  • #ffff (shorthand ARGB)
  • #ffffff (RGB)
  • #ffffffff (ARGB)
• RGB
  • rgb\(([\d]+),\s*([\d]+),\s*([\d]+)\)
    • ej. rgb(255, 255, 255)
• RGBA
  • rgba\(([\d]+),\s*([\d]+),\s*([\d]+),\s*([\d.]+)\)
    • ej. rgba(255, 255, 255, 1.0)
• HSL
  • hsl\((-?[\d.]+),\s*([\d.]+)%,\s*([\d.]+)%\)
    • ej. hsl(200, 20%, 50%)
• HSLA
  • hsla\((-?[\d.]+),\s*([\d.]+)%,\s*([\d.]+)%,\s*([\d.]+)\)
    • ej. hsla(200, 20%, 50%, 0.5)
• Nombre de color
  • Options are listed in SkParseColor.cpp
  • Similar a las palabras clave del Módulo de Color CSS Nivel 3, pero sensible a mayúsculas y minúsculas.
    • e.g. blueviolet or red

Establece el color de fondo de la ventana. See Setting backgroundColor.

win.previewFile(path[, displayName]) macOS

• path string - The absolute path to the file to preview with QuickLook. This is important as Quick Look uses the file name and file extension on the path to determine the content type of the file to open.
• displayName string (optional) - The name of the file to display on the Quick Look modal view. This is purely visual and does not affect the content type of the file. Defaults to path.

Uses Quick Look to preview a file at a given path.

win.closeFilePreview() macOS

Closes the currently open Quick Look panel.

win.setBounds(bounds[, animate])

• bounds Partial<Rectangle>
• animate boolean (optional) macOS

Redimensiona y mueve la ventana a los límites proporcionados. Cualquier propiedad que no se proporcione tendrá sus valores actuales por defecto.

const { BaseWindow } = require('electron')
const win = new BaseWindow()

// set all bounds properties
win.setBounds({ x: 440, y: 225, width: 800, height: 600 })

// set a single bounds property
win.setBounds({ width: 100 })

// { x: 440, y: 225, width: 100, height: 600 }
console.log(win.getBounds())

Note: On macOS, the y-coordinate value cannot be smaller than the Tray height. The tray height has changed over time and depends on the operating system, but is between 20-40px. Passing a value lower than the tray height will result in a window that is flush to the tray.

win.getBounds()

Returns Rectangle - The bounds of the window as Object.

Note: On macOS, the y-coordinate value returned will be at minimum the Tray height. For example, calling win.setBounds({ x: 25, y: 20, width: 800, height: 600 }) with a tray height of 38 means that win.getBounds() will return { x: 25, y: 38, width: 800, height: 600 }.

win.getBackgroundColor()

Returns string - Gets the background color of the window in Hex (#RRGGBB) format.

See Setting backgroundColor.

Note: The alpha value is not returned alongside the red, green, and blue values.

win.setContentBounds(bounds[, animate])

• bounds Rectangle
• animate boolean (optional) macOS

Redimensiona y mueve el área del cliente de la ventana (por ejemplo, la página web) hasta los límites proporcionados.

win.getContentBounds()

Returns Rectangle - The bounds of the window's client area as Object.

win.getNormalBounds()

Returns Rectangle - Contains the window bounds of the normal state

Note: whatever the current state of the window : maximized, minimized or in fullscreen, this function always returns the position and size of the window in normal state. In normal state, getBounds and getNormalBounds returns the same Rectangle.

win.setEnabled(enable)

• enable boolean

Habilita o deshabilita la ventana.

win.isEnabled()

Returns boolean - whether the window is enabled.

win.setSize(width, height[, animate])

• width Integer
• height Integer
• animate boolean (optional) macOS

Resizes the window to width and height. If width or height are below any set minimum size constraints the window will snap to its minimum size.

win.getSize()

Returns Integer[] - Contains the window's width and height.

win.setContentSize(width, height[, animate])

• width Integer
• height Integer
• animate boolean (optional) macOS

Resizes the window's client area (e.g. the web page) to width and height.

win.getContentSize()

Returns Integer[] - Contains the window's client area's width and height.

win.setMinimumSize(width, height)

• width Integer
• height Integer

Sets the minimum size of window to width and height.

win.getMinimumSize()

Returns Integer[] - Contains the window's minimum width and height.

win.setMaximumSize(width, height)

• width Integer
• height Integer

Sets the maximum size of window to width and height.

win.getMaximumSize()

Returns Integer[] - Contains the window's maximum width and height.

win.setResizable(resizable)

• resizable boolean

Sets whether the window can be manually resized by the user.

win.isResizable()

Returns boolean - Whether the window can be manually resized by the user.

win.setMovable(movable) macOS Windows

• movable boolean

Sets whether the window can be moved by user. En Linux no hace nada.

win.isMovable() macOS Windows

Returns boolean - Whether the window can be moved by user.

On Linux always returns true.

win.setMinimizable(minimizable) macOS Windows

• minimizable boolean

Sets whether the window can be manually minimized by user. En Linux no hace nada.

win.isMinimizable() macOS Windows

Returns boolean - Whether the window can be manually minimized by the user.

On Linux always returns true.

win.setMaximizable(maximizable) macOS Windows

• maximizable boolean

Sets whether the window can be manually maximized by user. En Linux no hace nada.

win.isMaximizable() macOS Windows

Returns boolean - Whether the window can be manually maximized by user.

On Linux always returns true.

win.setFullScreenable(fullscreenable)

• fullscreenable boolean

Sets whether the maximize/zoom window button toggles fullscreen mode or maximizes the window.

win.isFullScreenable()

Returns boolean - Whether the maximize/zoom window button toggles fullscreen mode or maximizes the window.

win.setClosable(closable) macOS Windows

• closable boolean

Sets whether the window can be manually closed by user. En Linux no hace nada.

win.isClosable() macOS Windows

Returns boolean - Whether the window can be manually closed by user.

On Linux always returns true.

win.setHiddenInMissionControl(hidden) macOS

• hidden boolean

Sets whether the window will be hidden when the user toggles into mission control.

win.isHiddenInMissionControl() macOS

Returns boolean - Whether the window will be hidden when the user toggles into mission control.

win.setAlwaysOnTop(flag[, level][, relativeLevel])

• flag boolean
• level string (optional) macOS Windows - Values include normal, floating, torn-off-menu, modal-panel, main-menu, status, pop-up-menu, screen-saver, and dock (Deprecated). The default is floating when flag is true. The level is reset to normal when the flag is false. Note that from floating to status included, the window is placed below the Dock on macOS and below the taskbar on Windows. From pop-up-menu to a higher it is shown above the Dock on macOS and above the taskbar on Windows. See the macOS docs for more details.
• relativeLevel Integer (optional) macOS - The number of layers higher to set this window relative to the given level. The default is 0. Note that Apple discourages setting levels higher than 1 above screen-saver.

Sets whether the window should show always on top of other windows. Después de configurar esto, la ventana seguirá siendo una ventana normal, y no una ventana de herramientas que no puede enfocarse.

win.isAlwaysOnTop()

Returns boolean - Whether the window is always on top of other windows.

win.moveAbove(mediaSourceId)

• mediaSourceId string - Window id in the format of DesktopCapturerSource's id. Por ejemplo "window:1869:0".

Moves window above the source window in the sense of z-order. If the mediaSourceId is not of type window or if the window does not exist then this method throws an error.

win.moveTop()

Mover ventana a la parte superior(z-order) independientemente del enfoque

win.center()

Mueve la ventana al centro de la pantalla.

win.setPosition(x, y[, animate])

• x Integer
• y Integer
• animate boolean (optional) macOS

Moves window to x and y.

win.getPosition()

Returns Integer[] - Contains the window's current position.

win.setTitle(title)

• title string

Changes the title of native window to title.

win.getTitle()

Returns string - The title of the native window.

Note: The title of the web page can be different from the title of the native window.

win.setSheetOffset(offsetY[, offsetX]) macOS

• offsetY Float
• offsetX Float (optional)

Changes the attachment point for sheets on macOS. By default, sheets are attached just below the window frame, but you may want to display them beneath a HTML-rendered toolbar. Por ejemplo:

const { BaseWindow } = require('electron')
const win = new BaseWindow()

const toolbarRect = document.getElementById('toolbar').getBoundingClientRect()
win.setSheetOffset(toolbarRect.height)

win.flashFrame(flag)

History

Version(s)	Changes
None	window.flashFrame(bool) will flash dock icon continuously on macOS
None	API ADDED

• flag boolean

Empieza y deja de hacer parpadear la ventana para atraer la atención del usuario.

win.setSkipTaskbar(skip) macOS Windows

• skip boolean

Hace que la ventana no se muestre en la barra de tareas.

win.setKiosk(flag)

• flag boolean

Entra / sale del modo Kiosko.

win.isKiosk()

Returns boolean - Whether the window is in kiosk mode.

win.isTabletMode() Windows

Returns boolean - Whether the window is in Windows 10 tablet mode.

Since Windows 10 users can use their PC as tablet, under this mode apps can choose to optimize their UI for tablets, such as enlarging the titlebar and hiding titlebar buttons.

This API returns whether the window is in tablet mode, and the resize event can be be used to listen to changes to tablet mode.

win.getMediaSourceId()

Returns string - Window id in the format of DesktopCapturerSource's id. Por ejemplo "window:1324:0".

More precisely the format is window:id:other_id where id is HWND on Windows, CGWindowID (uint64_t) on macOS and Window (unsigned long) on Linux. other_id is used to identify web contents (tabs) so within the same top level window.

win.getNativeWindowHandle()

Returns Buffer - The platform-specific handle of the window.

The native type of the handle is HWND on Windows, NSView* on macOS, and Window (unsigned long) on Linux.

win.hookWindowMessage(message, callback) Windows

• message Integer
• callback Function
  • wParam Buffer - The wParam provided to the WndProc
  • lParam Buffer - The lParam provided to the WndProc

Engancha una ventana de mensaje. The callback is called when the message is received in the WndProc.

win.isWindowMessageHooked(message) Windows

• message Integer

Returns boolean - true or false depending on whether the message is hooked.

win.unhookWindowMessage(message) Windows

• message Integer

Desancla el mensaje de la ventana.

win.unhookAllWindowMessages() Windows

Desancla todos los mensajes de la ventana.

win.setRepresentedFilename(filename) macOS

• filename string

Establece el nombre de la ruta del archivo que la ventana representa, y el icono del archivo se mostrará en la barra de título de la ventana.

win.getRepresentedFilename() macOS

Returns string - The pathname of the file the window represents.

win.setDocumentEdited(edited) macOS

• edited boolean

Specifies whether the window’s document has been edited, and the icon in title bar will become gray when set to true.

win.isDocumentEdited() macOS

Returns boolean - Whether the window's document has been edited.

win.setMenu(menu) Linux Windows

• menu Menu | null

Sets the menu as the window's menu bar.

win.removeMenu() Linux Windows

Eliminar la barra de menú de la ventana.

win.setProgressBar(progress[, options])

• progress Double
• options Object (optional)
  • mode string Windows - Mode for the progress bar. Can be none, normal, indeterminate, error or paused.

Establece el valor del progreso en el progress bar. Valid range is [0, 1.0].

Elimina la barra de progreso cuando el progreso es < 0; cambia a modo indeterminado cuando el progreso es >1.

On Linux platform, only supports Unity desktop environment, you need to specify the *.desktop file name to desktopName field in package.json. By default, it will assume {app.name}.desktop.

En Windows, se puede pasar de modo. Accepted values are none, normal, indeterminate, error, and paused. If you call setProgressBar without a mode set (but with a value within the valid range), normal will be assumed.

win.setOverlayIcon(overlay, description) Windows

• overlay NativeImage | null - the icon to display on the bottom right corner of the taskbar icon. If this parameter is null, the overlay is cleared
• description string - a description that will be provided to Accessibility screen readers

Establece una superposición de 16 x 16 píxeles sobre el icono actual de la barra de tareas. Generalmente se utiliza para transmitir algún tipo de estatus de la aplicación o para notificar pasivamente al usuario.

win.invalidateShadow() macOS

Invalidates the window shadow so that it is recomputed based on the current window shape.

BaseWindows that are transparent can sometimes leave behind visual artifacts on macOS. This method can be used to clear these artifacts when, for example, performing an animation.

win.setHasShadow(hasShadow)

• hasShadow boolean

Establece si la ventana debe tener una sombra.

win.hasShadow()

Returns boolean - Whether the window has a shadow.

win.setOpacity(opacity) Windows macOS

• opacity number - between 0.0 (fully transparent) and 1.0 (fully opaque)

Establece la opacidad de la ventana. En Linux no hace nada. Out of bound number values are clamped to the [0, 1] range.

win.getOpacity()

Returns number - between 0.0 (fully transparent) and 1.0 (fully opaque). En Linux, siempre devuelve 1.

win.setShape(rects) Windows Linux Experimental

• rects Rectangle[] - Sets a shape on the window. Passing an empty list reverts the window to being rectangular.

Establecer una forma de ventana determina el área dentro de la ventana donde el sistema permite dibujar y interactuar con el usuario. Fuera de la región dada, no se dibujarán píxeles y no se registrarán eventos del ratón. Los eventos del ratón fuera de la región no será recibida por esa ventana, pero pasará a lo que esté detrás de la misma.

win.setThumbarButtons(buttons) Windows

• buttons ThumbarButton[]

Returns boolean - Whether the buttons were added successfully

Añade la barra de herramientas de la vista previa con una configuración específica de los botones para la imagen previsualizada de una ventana en el plano del botón en la barra de tareas. Returns a boolean object indicates whether the thumbnail has been added successfully.

El número de botones en la barra de herramientas de la vista previa no debe ser mayor que 7 debido al limitado espacio. Una vez que se configura la barra de herramientas de la vista previa, la barra de tareas no puede ser eliminada debido a las limitaciones de la plataforma. Sin embargo, se puede llamar a la API con un arreglo vacío para limpiar los botones.

The buttons is an array of Button objects:

• Button Object
  • icon NativeImage - The icon showing in thumbnail toolbar.
  • click Function
  • tooltip string (optional) - The text of the button's tooltip.
  • flags string[] (optional) - Control specific states and behaviors of the button. By default, it is ['enabled'].

The flags is an array that can include following strings:

• enabled - The button is active and available to the user.
• disabled - The button is disabled. It is present, but has a visual state indicating it will not respond to user action.
• dismissonclick - When the button is clicked, the thumbnail window closes immediately.
• nobackground - Do not draw a button border, use only the image.
• hidden - The button is not shown to the user.
• noninteractive - The button is enabled but not interactive; no pressed button state is drawn. This value is intended for instances where the button is used in a notification.

win.setThumbnailClip(region) Windows

• region Rectangle - Region of the window

Establece la región de la ventana para mostrar como la vista previa de la imagen es mostrada cuando se pasa sobre la ventana en la barra de tareas. You can reset the thumbnail to be the entire window by specifying an empty region: { x: 0, y: 0, width: 0, height: 0 }.

win.setThumbnailToolTip(toolTip) Windows

• toolTip string

Configura la descripción emergente que se muestra cuando se pasa sobre la vista previa de la ventana en la barra de tareas.

win.setAppDetails(options) Windows

• options Object
  • appId string (optional) - Window's App User Model ID. Tiene que estar configurado, de lo contrario las otras opciones no tendrán efecto.
  • appIconPath string (optional) - Window's Relaunch Icon.
  • appIconIndex Integer (optional) - Index of the icon in appIconPath. Ignored when appIconPath is not set. Default is 0.
  • relaunchCommand string (optional) - Window's Relaunch Command.
  • relaunchDisplayName string (optional) - Window's Relaunch Display Name.

Establece las propiedades para el botón de la barra de herramientas de la ventana.

Note: relaunchCommand and relaunchDisplayName must always be set together. Si una de esas propiedades no está establecida, entonces ninguna será usada.

win.setIcon(icon) Windows Linux

• icon NativeImage | string

Cambia el icono de la ventana.

win.setWindowButtonVisibility(visible) macOS

• visible boolean

Establece si los botones de luz del tráfico de ventana deben estar visibles.

win.setAutoHideMenuBar(hide) Windows Linux

• hide boolean

Establece si el menu bar de la ventana debe ocultarse a si misma automáticamente o no. Once set the menu bar will only show when users press the single Alt key.

If the menu bar is already visible, calling setAutoHideMenuBar(true) won't hide it immediately.

win.isMenuBarAutoHide() Windows Linux

Devuelve boolean - Si la barra de menú se oculta automáticamente.

win.setMenuBarVisibility(visible) Windows Linux

• visible boolean

Establece si la barra de menú debe estar visible. Si la barra de menú se esconde automáticamente, los usuarios todavía pueden mostrar la barra de menú presionando la tecla solo Alt.

win.isMenuBarVisible() Windows Linux

Devuelve boolean - Si la barra de menú es visible.

win.setVisibleOnAllWorkspaces(visible[, options]) macOS Linux

• visible boolean
• options Object (optional)
  • visibleOnFullScreen boolean (opcional) macOS - Establece si la ventana debe ser visible sobre las ventanas de pantalla completa.
  • skipTransformProcessType boolean (opcional) macOS - Llamar setVisibleOnAllWorkspaces transformará por defecto el proceso tipo entre UIElementApplication y ForegroundApplication para asegurar el comportamiento correcto. Sin embargo, esto ocultará la ventana y se acoplará durante un corto tiempo cada vez que se llama. Si su ventana ya es de tipo UIElementApplication, puede saltarse esta transformación pasando verdadero a skipTransformProcessType.

Establece si la ventana debe ser visible o no en todos los espacios de trabajo.

Nota: Esta API no hace nada en Windows.

win.isVisibleOnAllWorkspaces() macOS Linux

Devuelve boolean - Si la ventana es visible en todos los espacios de trabajo.

Nota: Esta API siempre devuelve falso en Windows.

win.setIgnoreMouseEvents(ignore[, options])

• ignore boolean
• options Object (optional)
  • forward boolean (optional) macOS Windows - Si es verdadero, envía el mensaje de movimiento de mouse a Chromium, permitiendo eventos relacionados con el mouse como mouseleave. Solo se utiliza cuando ignore es verdadero. Si ignore es falso, el reenvío siempre es deshabilitado independientemente de este valor.

Hace que la ventana ignore todos los eventos del ratón.

Todos los eventos del ratón ocurridos en esta ventana se pasarán a la ventana debajo de esta ventana, pero si esta ventana esta enfocada, todavía recibirá los eventos del teclado.

win.setContentProtection(activable) macOS Windows

• enable boolean

Evita que los contenidos de la ventana sean capturados por otras aplicaciones.

On macOS it sets the NSWindow's sharingType to NSWindowSharingNone. En Windows se llama SetWindowDisplayAffinity con WDA_EXCLUDEFROMCAPTURE. Para Windows 10 versión 2004 y superior, la ventana se eliminará de la captura completamente, versiones antiguas de Windows se comportan como si WDA_MONITOR fuera aplicado capturando una ventana negra.

win.setFocusable(focusable) macOS Windows

• focusable boolean

Cambia si se puede enfocar o no la ventana.

En macOS no elimina el foco de la ventana.

win.isFocusable() macOS Windows

Devuelve boolean - Si la ventana puede ser enfocada.

win.setParentWindow(parent)

• parent BaseWindow | null

Establece parent como la ventana padre de la ventana actual, al pasar null se convertirá la ventana actual en una ventana de nivel superior.

win.getParentWindow()

Devuelve BaseWindow | null - La ventana padre o null si no hay padre.

win.getChildWindows()

Devuelve BaseWindow[] - Todas las ventanas hijas.

win.setAutoHideCursor(autoHide) macOS

• autoHide boolean

Controla si se debe ocultar el cursor al escribir.

win.selectPreviousTab() macOS

Selecciona la pestaña previa cuando las pestañas nativas están activas y hay otras pestañas en la ventana.

win.selectNextTab() macOS

Selecciona la siguiente pestaña cuando las pestañas nativas están activas y hay otras pestañas en la ventana.

win.showAllTabs() macOS

Shows or hides the tab overview when native tabs are enabled.

win.mergeAllWindows() macOS

Unifica todas las ventanas en una sola con múltiples pestañas cuando las pestañas nativas están activas y hay más de una ventana abierta.

win.moveTabToNewWindow() macOS

Mueve la pestaña actual a una nueva ventana si las pestañas nativas están activas y hay más de una pestaña en la ventana actual.

win.toggleTabBar() macOS

Conmuta la visibilidad de la barra de pestañas si las pestañas nativas están activas y hay solo una pestaña en la ventana actual.

win.addTabbedWindow(baseWindow) macOS

• baseWindow BaseWindow

Añade una ventana como pestaña de la ventana actual, después de la pestaña para la instancia de la ventana actual.

win.setVibrancy(type) macOS

• type string | null - Puede ser titlebar, selection, menu, pock, sidebar, header, sheet, window, hud, fullscreen-ui, tooltip, content, under-window, o under-page. Consulte la documentación de macOS para más detalles.

Añade un efecto de vibración a la ventana. Enviar null o un string vacío eliminará el efecto de vibración en la ventana.

win.setBackgroundMaterial(material) Windows

• material string
  • auto - Deje que el Administrador de Ventanas de Escritorio (DWM) decida automáticamente el material de fondo dibujado por el sistema para esta ventana. Este es el valor predeterminado.
  • ninguno - No dibuja ningún fondo del sistema.
  • mica - Dibuja el efecto de material de fondo correspondiente a una ventana de larga duración.
  • acrylic - Dibuja el efecto de material de fondo correspondiente a una ventana transitoria.
  • tabbed - Dibuja el efecto de material de fondo correspondiente a una ventana con una barra de título tabulada.

This method sets the browser window's system-drawn background material, including behind the non-client area.

Consulte la documentación de Windows para más detalles.

Nota: Este método solo es compatible con Windows 11 22H2 y versiones posteriores.

win.setWindowButtonPosition(position) macOS

• position Point | null

Establece una posición personalizada para los botones del semáforo en la ventana sin marco. Pasar null restablecerá la posición a su valor predeterminado.

win.getWindowButtonPosition() macOS

Devuelve Point | null- La posición personalizada de los botones de semáforo en la ventana sin borde, se devolverá null cuando no haya una posición personalizada.

win.setTouchBar(touchBar) macOS

• touchBar TouchBar | null

Configura el plano de la touchBar para la ventana actual. Espeficando null or undefined elimina el touch bar. This method only has an effect if the machine has a touch bar.

Nota: actualmente la API TouchBar es experimental y puede cambiar o ser eliminada en futuras versiones de Electron.

win.setTitleBarOverlay(options) Windows Linux

• options Object
  • color String (optional) - The CSS color of the Window Controls Overlay when enabled.
  • symbolColor String (optional) - The CSS color of the symbols on the Window Controls Overlay when enabled.
  • height Integer (optional) - The height of the title bar and Window Controls Overlay in pixels.

On a Window with Window Controls Overlay already enabled, this method updates the style of the title bar overlay.

On Linux, the symbolColor is automatically calculated to have minimum accessible contrast to the color if not explicitly set.