Types Module
Types and nested modules
| Type/Module | Description |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The Display object represents a physical display connected to the system. A fake Display may exist on a headless system, or a Display may correspond to a remote, virtual display. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Possible values:* disabled_software - Software only. Hardware acceleration disabled (yellow)* disabled_off - Disabled (red)* disabled_off_ok - Disabled (yellow)* unavailable_software - Software only, hardware acceleration unavailable (yellow)* unavailable_off - Unavailable (red)* unavailable_off_ok - Unavailable (yellow)* enabled_readback - Hardware accelerated but at reduced performance (yellow)* enabled_force - Hardware accelerated on all pages (green)* enabled - Hardware accelerated (green)* enabled_on - Enabled (green)* enabled_force_on - Force enabled (green) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Note that all statistics are reported in Kilobytes. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
When mode is unspecified, pacScript and proxyRules are provided together, the proxyRules option is ignored and pacScript configuration is applied.The
proxyRules has to follow the rules below:For example:* http=foopy:80;ftp=foopy2 - Use HTTP proxy foopy:80 for http:// URLs, and HTTP proxy
foopy2:80 for ftp:// URLs.* foopy:80 - Use HTTP proxy foopy:80 for all URLs.* foopy:80,bar,direct:// - Use HTTP proxy foopy:80 for
all URLs, failing over to bar if foopy:80 is unavailable, and after that using no proxy.* socks4://foopy - Use SOCKS
v4 proxy foopy:1080 for all URLs.* http=foopy,socks5://bar.com - Use HTTP proxy foopy for http URLs, and fail over to the
SOCKS5 proxy bar.com if foopy is unavailable.* http=foopy,direct:// - Use HTTP proxy foopy for http URLs, and use no proxy
if foopy is unavailable.* http=foopy;socks=foopy2 - Use HTTP proxy foopy for http URLs, and use socks4://foopy2 for all other URLs.The
proxyBypassRules is a comma separated list of rules described below:* [ URL_SCHEME "://" ] HOSTNAME_PATTERN [ ":" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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. |
|
|
|
|
|
An example TraceConfig that roughly matches what Chrome DevTools records: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This type is a helper alias, no object will ever exist of this type. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Unfortunately, Windows does not offer a way to differentiate between a shutdown and a reboot, meaning the 'shutdown' reason is triggered in both scenarios. For more details on the WM_ENDSESSION message and its associated reasons, refer to the MSDN documentation. |
fable-electron-docs-api