Saltar al contenido principal

BaseWindowConstructorOptions Object

  • width Integer (opcional) - Ancho de la ventana en píxeles. Por defecto, 800.
  • height Integer (opcional) - Altura de la ventana en píxeles. Por defecto, 600.
  • x Integer (opcional) - (obligatorio si se usa y) Desplazamiento izquierdo de la ventana en la pantalla. Por defecto es centrar en la ventana.
  • y Integer (opcional) - (obligatorio si se usa x) Desplazamiento superior de la ventana en la pantalla. Por defecto es centrar en la ventana.
  • useContentSize boolean (opcional) - width y height se usarán como el tamaño de la página web, lo que significa que el tamaño real de la ventana incluirá el tamaño del marco de la ventana y será ligeramente mayor. Por defecto, false.
  • center boolean (opcional) - Muestra la ventana en el centro de la pantalla. Por defecto, false.
  • minWidth Integer (opcional) - Ancho mínimo de la ventana. Por defecto, 0.
  • minHeight Integer (opcional) - Altura mínima de la ventana. Por defecto, 0.
  • maxWidth Integer (opcional) - Ancho máximo de la ventana. Por defecto no hay limite.
  • maxHeight Integer (opcional) - Altura máxima de la ventana. Por defecto no hay limite.
  • resizable boolean (opcional) - Si la ventana es redimensionable. Por defecto, true.
  • movable boolean (opcional) macOS Windows - Si la ventana se puede mover. Esto no está implementado en Linux. Por defecto, true.
  • minimizable boolean (opcional) macOS Windows - Si la ventana es se puede minimizar. Esto no está implementado en Linux. Por defecto, true.
  • maximizable boolean (opcional) macOS Windows - Si la ventana es se puede maximizar. Esto no está implementado en Linux. Por defecto, true.
  • closable boolean (opcional) macOS Windows - Si la ventana se puede cerrar. Esto no está implementado en Linux. Por defecto, true.
  • focusable boolean (opcional) macOS Windows - Si la ventana puede tener el foco. Por defecto, true. En Windows, la configuración focusable: false implica skipTaskbar: true. En Linux, la configuración focusable: false hace que la ventana deje de interactuar con wm, por lo que la ventana siempre permanecerá en la parte superior en todos los espacios de trabajo.
  • alwaysOnTop boolean (opcional) - Si la ventana debe permanecer siempre encima de otras ventanas. Por defecto, false.
  • fullscreen boolean (opcional) - Si la ventana puede mostrarse a pantalla completa. Cuando se establece explícitamente como false, el botón de pantalla completa se ocultará o deshabilitará en macOS. Por defecto, false.
  • fullscreenable boolean (opcional) - Si la ventana se puede poner en modo de pantalla completa En macOS, también se indica si el botón maximizar/zoom debe alternar entre el modo de pantalla completa o maximizar la ventana. Por defecto, true.
  • simpleFullscreen boolean (opcional) macOS - Utiliza la pantalla completa anterior a Lion en macOS. Por defecto, false.
  • skipTaskbar boolean (opcional) macOS Windows - Si se debe mostrar la ventana en la barra de tareas. Por defecto, false.
  • hiddenInMissionControl boolean (opcional) macOS - Si la ventana debe ocultarse cuando el usuario cambia al mission control.
  • kiosk boolean (opcional) - Si la ventana está en modo quiosco. Por defecto, false.
  • title string (opcional) - Título de la ventana predeterminado. Por defecto, Electron. Si la etiqueta HTML <title> está definida en el archivo HTML cargado por loadURL(), esta propiedad será ignorada.
  • icon (NativeImage | string) (opcional) - El icono de la ventana. En Windows se recomienda utilizar iconos "ICO" para obtener mejores efectos visuales. También puedes dejarlo sin definir para que se utilice el ícono del ejecutable.
  • show boolean (opcional) - Si la ventana debe mostrarse cuando se crea. Por defecto, true.
  • frame boolean (opcional) - Especifique false para crear una ventana sin marco. Por defecto, true.
  • parent BaseWindow (opcional) - Especifica la ventana padre (parent window). Por defecto null.
  • modal boolean (opcional) - Si se trata de una ventana modal. Esto sólo funciona cuando la ventana es una ventana hija (child window). Por defecto, false.
  • acceptFirstMouse boolean (opcional) macOS - Si al hacer clic en una ventana inactiva también se accederá al contenido web. Por defecto, false en macOS. Esta opción no es configurable en otras plataformas.
  • disableAutoHideCursor boolean (opcional) - Si desea ocultar el cursor al escribir. Por defecto, false.
  • autoHideMenuBar boolean (opcional) - Oculta automáticamente la barra de menú a menos que se presione la tecla Alt. Por defecto, false.
  • enableLargerThanScreen boolean (opcional) macOS - Habilita que la ventana se redimensione a un tamaño más grande que la pantalla. Solo es relevante para macOS, ya que otros sistemas operativos permiten ventanas más grandes que la pantalla de forma predeterminada. Por defecto, false.
  • backgroundColor string (opcional) - El color de fondo de la ventana en formato de color Hex, RGB, RGBA, HSL, HSLA o CSS con nombre. Se admite el formato alfa en #AARRGGBB si transparent está configurado como true. Por defecto, #FFF (blanco). Consulte win.setBackgroundColor para más información.
  • hasShadow boolean (opcional) - Si la ventana debe tener sombra. Por defecto, true.
  • opacity number (opcional) macOS Windows - Establece la opacidad inicial de la ventana, entre 0.0 (completamente transparente) y 1.0 (completamente opaca). Esto solo está implementado en Windows y macOS.
  • darkTheme boolean (opcional) - Fuerza el uso del Modo Oscuro para la ventana, solo funciona en algunos entornos de escritorio GTK+3. Por defecto, false.
  • transparent boolean (opcional) - Hace que la ventana sea transparente. Por defecto, false. En Windows, no funciona a menos que la ventana sea sin marco.
  • type string (opcional) - El tipo de ventana, por defecto es una ventana normal. Más información sobre esto más abajo.
  • visualEffectState string (opcional) macOS - Especifica cómo la apariencia del material debe reflejar el estado de actividad de la ventana en macOS. Debe utilizarse con la propiedad vibrancy. Los valores posibles son:
    • followWindow - El fondo debe aparecer automáticamente activo cuando la ventana esté activa, e inactivo cuando no lo esté. Este es el valor predeterminado.
    • activo - El fondo siempre debe aparecer activo.
    • inactivo - El fondo siempre debe aparecer inactivo.
  • titleBarStyle string (opcional) - El estilo de la barra de título de la ventana. Por defecto, default. Los valores posibles son:
    • default - Muestra la barra de título estándar para macOS o Windows, respectivamente.
    • hidden - Muestra una barra de título oculta y una ventana de contenido de tamaño completo. En macOS, la ventana muestra en la parte superior izquierda los controles estándar de “semáforo” (botones rojo, ámbar y verde, para cerrar, maximizar/restaurar y minimizar). En Windows y Linux, cuando se combina con titleBarOverlay: true, activará la superposición de controles de ventana (consulte titleBarOverlay para más información); de lo contrario, no se mostrarán controles de ventana.
    • hiddenInset macOS - Muestra una barra de título oculta con una apariencia alternativa donde los botones del semáforo están ligeramente más insertados desde el borde de la ventana.
    • customButtonsOnHover macOS - Muestra una barra de título oculta y una ventana de contenido de tamaño completo, los botones del semáforo se mostrarán al pasar el cursor sobre ellos en la parte superior izquierda de la ventana. Nota: Esta opción es actualmente experimental.
  • titleBarOverlay Objet | Booleano (opcional) - Cuando se usa una ventana sin marco junto con win.setWindowButtonVisibility(true) en macOS o se usa un titleBarStyle para que los controles de ventana estándar ("semáforos" en macOS) sean visibles, esta propiedad habilita la superposición de controles de ventana API de JavaScript y Variables de entorno CSS. Si se especifica true, se obtendrá una superposición con los colores predeterminados del sistema. Por defecto, false.
    • color string (opcional) Windows Linux - El color CSS de la superposición de controles de ventana cuando está habilitada. Por defecto, el color del sistema.
    • symbolColor String(opcional) Windows - El color CSS de los símbolos en el Window Controls Overlay cuando este habilitado. Por defecto, el color del sistema.
    • height Integer (optional) - The height of the title bar and Window Controls Overlay in pixels. Por defecto, la altura del sistema.
  • trafficLightPosition Point (opcional) macOS - Establece una posición personalizada para los botones del semáforo en ventanas sin marco.
  • roundedCorners boolean (opcional) macOS - Si la ventana sin marco debe tener esquinas redondeadas en macOS. Por defecto, true. Si elegimos false, evitará que la ventana se pueda visualizar en pantalla completa.
  • thickFrame boolean (opcional) - Utiliza el estilo WS_THICKFRAME para ventanas sin marco en Windows, que agrega un marco de ventana estándar. Si elegimos false, se eliminarán la sombra y las animaciones de la ventana. Por defecto, true.
  • vibrancy string (opcional) macOS - Agrega un efecto de vibración a la ventana, solo en macOS. Puede ser appearance-based, titlebar, selection, menu, popover, sidebar, header, sheet, window, hud, fullscreen-ui, tooltip, content, under-window, or under-page.
  • backgroundMaterial string (opcional) Windows - Establece el material de fondo dibujado por el sistema de la ventana, incluso detrás del área que no es del cliente. Puede ser auto, none, mica, acrylic o tabbed. Consulte win.setBackgroundMaterial para más información.
  • zoomToPageWidth boolean (opcional) macOS - Controla el comportamiento en macOS al hacer clic con la tecla Opción presionada en el botón de semáforo verde en la barra de herramientas o al hacer clic en el elemento de menú Ventana > Zoom. Si es true, la ventana crecerá hasta el ancho preferido de la página web cuando se haga zoom, false hará que se amplíe hasta el ancho de la pantalla. Esto también afectará el comportamiento al llamar a maximize() directamente. Por defecto, false.
  • tabbingIdentifier string (opcional) macOS - Nombre del grupo de pestañas, permite abrir la ventana como una pestaña nativa. Las ventanas con el mismo identificador de pestaña se agruparán. Esto también agrega un botón de nueva pestaña nativo a la barra de pestañas de Windows y permite que su app y ventana reciban el evento new-window-for-tab.

Al configurar el tamaño mínimo o máximo de la ventana con minWidth/maxWidth/ minHeight/maxHeight, solo restringe a los usuarios. No le impedirá pasar un tamaño que no siga las restricciones de tamaño a setBounds/setSize o al constructor de BrowserWindow.

Los posibles valores y comportamientos de la opción type dependen de la plataforma. Los valores posibles son:

  • En Linux, los tipos posibles son desktop, dock, toolbar, splash, notification.
    • El tipo desktop coloca la ventana en el nivel de la ventana de fondo del escritorio (kCGDesktopWindowLevel - 1). Sin embargo, tenga en cuenta que una ventana del escritorio no recibirá eventos de foco, teclado o mouse. Aún puedes usar globalShortcut para recibir entradas con moderación.
    • El tipo dock crea un comportamiento de ventana similar a un dock.
    • El tipo toolbar crea una ventana con apariencia de barra de herramientas.
    • El tipo splash se comporta de una manera específica. No se puede arrastrar, incluso si el estilo CSS del cuerpo de la ventana contiene -webkit-app-region: drag. Este tipo se utiliza comúnmente para pantallas de presentación (splash).
    • El tipo notification crea una ventana que se comporta como una notificación del sistema.
  • En macOC, los tipos posibles son desktop, textured, panel.
    • El tipo textured agrega una apariencia de degradado metálico. Esta opción está obsoleta.
    • El tipo desktop coloca la ventana en el nivel de la ventana de fondo del escritorio (kCGDesktopWindowLevel - 1). Tenga en cuenta que la ventana del escritorio no recibirá foco ni eventos de teclado o mouse, pero puede usar globalShortcut para recibir entradas con moderación.
    • El tipo panel permite que la ventana flote sobre las aplicaciones de pantalla completa agregando la máscara de estilo NSWindowStyleMaskNonactivatingPanel, normalmente reservada para NSPanel, en tiempo de ejecución. Además, la ventana aparecerá en todos los espacios (escritorios).
  • En Windows, el tipo posible es toolbar.