Browse Source

docs: Improved the Documentation on BrowserWindow type attribute (#38666)

* docs: Documentation changes

* made the required changes in the docs

* made the toolbar type text correction
Varun Sood 1 year ago
parent
commit
ec4c9024b9
1 changed files with 10 additions and 0 deletions
  1. 10 0
      docs/api/structures/browser-window-options.md

+ 10 - 0
docs/api/structures/browser-window-options.md

@@ -137,6 +137,16 @@ 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
     (`NSWindowStyleMaskTexturedBackground`).