Skip to content

Commit

Permalink
docs: Improved the Documentation on BrowserWindow type attribute (ele…
Browse files Browse the repository at this point in the history
…ctron#38666)

* docs: Documentation changes

* made the required changes in the docs

* made the toolbar type text correction
  • Loading branch information
varunsood2003 authored and MrHuangJser committed Dec 11, 2023
1 parent fcbaa41 commit e22190d
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions docs/api/structures/browser-window-options.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`).
Expand Down

0 comments on commit e22190d

Please sign in to comment.