fix: unify BrowserWindow.isVisible() logic cross-platform

Co-authored-by: Shelley Vohr <shelley.vohr@gmail.com>
electron · May 16, 2023 · 02767e0 · 02767e0
1 parent da7b9a1
commit 02767e0
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 5 deletions.
diff --git a/docs/api/browser-window.md b/docs/api/browser-window.md
@@ -954,7 +954,7 @@ Hides the window.
 
 #### `win.isVisible()`
 
-Returns `boolean` - Whether the window is visible to the user.
+Returns `boolean` - Whether the window is visible to the user in the foreground of the app.
 
 #### `win.isModal()`
 

diff --git a/shell/browser/native_window_mac.mm b/shell/browser/native_window_mac.mm
@@ -491,10 +491,6 @@ void ViewDidMoveToSuperview(NSView* self, SEL _cmd) {
 
 bool NativeWindowMac::IsVisible() {
   bool occluded = [window_ occlusionState] == NSWindowOcclusionStateVisible;
-
-  // For a window to be visible, it must be visible to the user in the
-  // foreground of the app, which means that it should not be minimized or
-  // occluded
   return [window_ isVisible] && !occluded && !IsMinimized();
 }
 

diff --git a/shell/browser/native_window_views.cc b/shell/browser/native_window_views.cc
@@ -535,7 +535,17 @@ void NativeWindowViews::Hide() {
 }
 
 bool NativeWindowViews::IsVisible() {
+#if BUILDFLAG(IS_WIN)
+  // widget()->IsVisible() calls ::IsWindowVisible, which returns non-zero if a
+  // window or any of its parent windows are visible. We want to only check the
+  // current window.
+  bool visible =
+      ::GetWindowLong(GetAcceleratedWidget(), GWL_STYLE) & WS_VISIBLE;
+  // WS_VISIBLE is true even if a window is miminized - explicitly check that.
+  return visible && !IsMinimized();
+#else
   return widget()->IsVisible();
+#endif
 }
 
 bool NativeWindowViews::IsEnabled() {

diff --git a/spec/api-browser-window-spec.ts b/spec/api-browser-window-spec.ts
@@ -736,6 +736,18 @@ describe('BrowserWindow module', () => {
       });
     });
 
+    describe('BrowserWindow.minimize()', () => {
+      // TODO(codebytere): Enable for Linux once maximize/minimize events work in CI.
+      ifit(process.platform !== 'linux')('should not be visible when the window is minimized', async () => {
+        const minimize = emittedOnce(w, 'minimize');
+        w.minimize();
+        await minimize;
+
+        expect(w.isMinimized()).to.equal(true);
+        expect(w.isVisible()).to.equal(false);
+      });
+    });
+
     describe('BrowserWindow.showInactive()', () => {
       it('should not focus on window', () => {
         w.showInactive();