From ec4c9024b9795d360fbd96b09684fdb228966781 Mon Sep 17 00:00:00 2001 From: Varun Sood <89240425+varunsood2003@users.noreply.github.com> Date: Thu, 6 Jul 2023 01:56:39 +0530 Subject: [PATCH] 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 --- docs/api/structures/browser-window-options.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/api/structures/browser-window-options.md b/docs/api/structures/browser-window-options.md index 4e7e07b814ec..136132ba57eb 100644 --- a/docs/api/structures/browser-window-options.md +++ b/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`).