fable-electron-docs-api
BaseWindowConstructorOptions Type
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. Possible values are:* 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. This option is deprecated. * The desktop type places the window at the desktop background window level (kCGDesktopWindowLevel - 1). Note that desktop window will not receive focus, keyboard or mouse events, but you can use globalShortcut to receive input sparingly. * The panel type enables the window to float on top of full-screened apps by adding the NSWindowStyleMaskNonactivatingPanel style mask, normally reserved for NSPanel, at runtime. Also, the window will appear on all spaces (desktops).* On Windows, possible type is toolbar.
Constructors
| Constructor |
Description
|
Full Usage:
BaseWindowConstructorOptions(?width, ?height, ?x, ?y, ?useContentSize, ?center, ?minWidth, ?minHeight, ?maxWidth, ?maxHeight, ?resizable, ?movable, ?minimizable, ?maximizable, ?closable, ?focusable, ?alwaysOnTop, ?fullscreen, ?fullscreenable, ?simpleFullscreen, ?skipTaskbar, ?hiddenInMissionControl, ?kiosk, ?title, ?icon, ?show, ?frame, ?parent, ?modal, ?acceptFirstMouse, ?disableAutoHideCursor, ?autoHideMenuBar, ?enableLargerThanScreen, ?backgroundColor, ?hasShadow, ?opacity, ?darkTheme, ?transparent, ?type, ?visualEffectState, ?titleBarStyle, ?titleBarOverlay, ?accentColor, ?trafficLightPosition, ?roundedCorners, ?thickFrame, ?vibrancy, ?backgroundMaterial, ?zoomToPageWidth, ?tabbingIdentifier)
Parameters:
int
-
Window's width in pixels. Default is 800.
?height : int
-
Window's height in pixels. Default is 600.
?x : int
-
(**required** if y is used) Window's left offset from screen. Default is to center the window.
?y : int
-
(**required** if x is used) Window's top offset from screen. Default is to center the window.
?useContentSize : bool
-
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 : bool
-
Show window in the center of the screen. Default is false.
?minWidth : int
-
Window's minimum width. Default is 0.
?minHeight : int
-
Window's minimum height. Default is 0.
?maxWidth : int
-
Window's maximum width. Default is no limit.
?maxHeight : int
-
Window's maximum height. Default is no limit.
?resizable : bool
-
Whether window is resizable. Default is true.
?movable : bool
-
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ || Whether window is movable.
This is not implemented on Linux. Default is true.
?minimizable : bool
-
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ || Whether window is minimizable.
This is not implemented on Linux. Default is true.
?maximizable : bool
-
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ || Whether window is maximizable.
This is not implemented on Linux. Default is true.
?closable : bool
-
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ || Whether window is closable.
This is not implemented on Linux. Default is true.
?focusable : bool
-
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 : bool
-
Whether the window should always stay on top of other windows. Default is false.
?fullscreen : bool
-
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 : bool
-
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 : bool
-
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Use pre-Lion fullscreen on
macOS. Default is false.
?skipTaskbar : bool
-
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ || Whether to show the
window in taskbar. Default is false.
?hiddenInMissionControl : bool
-
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Whether window should be
hidden when the user toggles into mission control.
?kiosk : bool
-
Whether the window is in kiosk mode. Default is false.
?title : string
-
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 : U2<NativeImage, string>
-
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 : bool
-
Whether window should be shown when created. Default is true.
?frame : bool
-
Specify false to create a frameless window. Default is true.
?parent : BaseWindow
-
Specify parent window. Default is null.
?modal : bool
-
Whether this is a modal window. This only works when the window is a child window. Default is false.
?acceptFirstMouse : bool
-
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || 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 : bool
-
Whether to hide cursor when typing. Default is false.
?autoHideMenuBar : bool
-
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ✔ | MAS ❌ || Auto hide the menu
bar unless the Alt key is pressed. Default is false.
?enableLargerThanScreen : bool
-
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || 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
-
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 : bool
-
Whether window should have a shadow. Default is true.
?opacity : float
-
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ || 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 : bool
-
Forces using dark theme for the window, only works on some GTK+3 desktop environments. Default is false.
?transparent : bool
-
Makes the window transparent. Default is false. On Windows, does not work unless the window is frameless.
?type : string
-
The type of window, default is normal window. See more about this below.
?visualEffectState : VisualEffectState
-
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Specify how the material
appearance should reflect window activity state on macOS. Must be used with the vibrancy property. Possible values are:
?titleBarStyle : TitleBarStyle
-
The style of window title bar. Default is default. Possible values are:
?titleBarOverlay : U2<TitleBarOverlay, bool>
-
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.
?accentColor : U2<bool, string>
-
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ || The accent color for
the window. By default, follows user preference in System Settings. Set to false to explicitly disable, or set the color
in Hex, RGB, RGBA, HSL, HSLA or named CSS color format. Alpha values will be ignored.
?trafficLightPosition : Point
-
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || Set a custom position
for the traffic light buttons in frameless windows.
?roundedCorners : bool
-
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ || Whether frameless window should
have rounded corners. Default is true. Setting this property to false will prevent the window from being fullscreenable on macOS.
On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have
rounded corners.
?thickFrame : bool
-
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ || Use WS_THICKFRAME style for
frameless windows on Windows, which adds the standard window frame. Setting it to false will remove window shadow and window
animations, and disable window resizing via dragging the window edges. Default is true.
?vibrancy : Vibrancy
-
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || 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 : BackgroundMaterial
-
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ || 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 : bool
-
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || 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
-
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ || 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.
Returns: BaseWindowConstructorOptions
|
|
Instance members
| Instance member |
Description
|
Full Usage:
this.accentColor
|
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ The accent color for the window. By default, follows user preference in System Settings. Set to false to explicitly disable, or set the color in Hex, RGB, RGBA, HSL, HSLA or named CSS color format. Alpha values will be ignored. |
Full Usage:
this.acceptFirstMouse
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ 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. |
Full Usage:
this.alwaysOnTop
|
Whether the window should always stay on top of other windows. Default is false. |
Full Usage:
this.autoHideMenuBar
|
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ✔ | MAS ❌ Auto hide the menu bar unless the Alt key is pressed. Default is false. |
Full Usage:
this.backgroundColor
|
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. |
Full Usage:
this.backgroundMaterial
|
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ 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. |
Full Usage:
this.center
|
Show window in the center of the screen. Default is false. |
Full Usage:
this.closable
|
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Whether window is closable. This is not implemented on Linux. Default is true. |
Full Usage:
this.darkTheme
|
Forces using dark theme for the window, only works on some GTK+3 desktop environments. Default is false. |
Full Usage:
this.disableAutoHideCursor
|
Whether to hide cursor when typing. Default is false. |
Full Usage:
this.enableLargerThanScreen
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ 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. |
Full Usage:
this.focusable
|
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. |
Full Usage:
this.frame
|
Specify false to create a frameless window. Default is true. |
Full Usage:
this.fullscreen
|
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. |
Full Usage:
this.fullscreenable
|
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. |
Full Usage:
this.hasShadow
|
Whether window should have a shadow. Default is true. |
Full Usage:
this.height
|
Window's height in pixels. Default is 600. |
Full Usage:
this.hiddenInMissionControl
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Whether window should be hidden when the user toggles into mission control. |
Full Usage:
this.icon
|
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. |
Full Usage:
this.kiosk
|
Whether the window is in kiosk mode. Default is false. |
Full Usage:
this.maxHeight
|
Window's maximum height. Default is no limit. |
Full Usage:
this.maxWidth
|
Window's maximum width. Default is no limit. |
Full Usage:
this.maximizable
|
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Whether window is maximizable. This is not implemented on Linux. Default is true. |
Full Usage:
this.minHeight
|
Window's minimum height. Default is 0. |
Full Usage:
this.minWidth
|
Window's minimum width. Default is 0. |
Full Usage:
this.minimizable
|
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Whether window is minimizable. This is not implemented on Linux. Default is true. |
Full Usage:
this.modal
|
Whether this is a modal window. This only works when the window is a child window. Default is false. |
Full Usage:
this.movable
|
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Whether window is movable. This is not implemented on Linux. Default is true. |
Full Usage:
this.opacity
|
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ 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. |
Full Usage:
this.parent
|
Specify parent window. Default is null. |
Full Usage:
this.resizable
|
Whether window is resizable. Default is true. |
Full Usage:
this.roundedCorners
|
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Whether frameless window should have rounded corners. Default is true. Setting this property to false will prevent the window from being fullscreenable on macOS. On Windows versions older than Windows 11 Build 22000 this property has no effect, and frameless windows will not have rounded corners. |
Full Usage:
this.show
|
Whether window should be shown when created. Default is true. |
Full Usage:
this.simpleFullscreen
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ Use pre-Lion fullscreen on macOS. Default is false. |
Full Usage:
this.skipTaskbar
|
⚠ OS Compatibility: WIN ✔ | MAC ✔ | LIN ❌ | MAS ❌ Whether to show the window in taskbar. Default is false. |
Full Usage:
this.tabbingIdentifier
|
⚠ OS Compatibility: WIN ❌ | MAC ✔ | LIN ❌ | MAS ❌ 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. |
Full Usage:
this.thickFrame
|
⚠ OS Compatibility: WIN ✔ | MAC ❌ | LIN ❌ | MAS ❌ Use WS_THICKFRAME style for frameless windows on Windows, which adds the standard window frame. Setting it to false will remove window shadow and window animations, and disable window resizing via dragging the window edges. Default is true. |
Full Usage:
this.title
|
Default window title. Default is "Electron". If the HTML tag |