electron-findbar 3.1.0 → 3.2.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2025 Emerson Capuchi Romaneli
+Copyright (c) 2026 Emerson Capuchi Romaneli
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -13,7 +13,7 @@
 
 ## Installation
 
-Install the `electron-findbar` package via npm:
+Install the `electron-findbar` package via [npm](https://www.npmjs.com/package/electron-findbar):
 
 ```sh
 npm install electron-findbar
@@ -21,7 +21,7 @@ npm install electron-findbar
 
 ## Overview
 
-The `electron-findbar` is a `BrowserWindow` component designed to emulate the Chrome findbar layout, leveraging the `webContents.findInPage` method to navigate through matches. Inter-process communication (IPC) is used for interaction between the `main` and `renderer` processes.
+The `electron-findbar` package creates a `BrowserWindow`-based component designed to emulate the Chrome findbar layout, leveraging the `webContents.findInPage` method to navigate through matches. Inter-process communication (IPC) is used for interaction between the `main` and `renderer` processes.
 
 ### Memory Usage
 
@@ -55,14 +55,14 @@ Alternatively, you can provide a custom `WebContents` as the second parameter. I
 const findbar = Findbar.from(baseWindow, webContents)
 ```
 
-Is also possible to create a findbar providing only the web contents. The BaseWindow.getAllWindows() will be used to query for the parent window:
+It is also possible to create a findbar providing only the web contents. The BaseWindow.getAllWindows() will be used to query for the parent window:
 
 ```js
 // Create or retrieve the findbar associated to the webContents.
 const findbar = Findbar.from(webContents)
 ```
 
-**Note:** The findbar is ALWAYS linked to the webContents not the window. The parent is only the window to connect the events and stay on top. If the `.from(webContents)` is used to retrieve an existing findbar previously created with a parent, the findbar will stay connected to the parent.
+**Note:** The findbar is ALWAYS linked to the webContents, not the window. The parent is only the window to connect the events and stay on top. If the `.from(webContents)` is used to retrieve an existing findbar previously created with a parent, the findbar will stay connected to the parent. If a different parent is used, the parent window is updated automatically.
 
 #### Retrieve if exists
 
@@ -305,10 +305,11 @@ If the `contextIsolation` is enabled, the `electron-findbar/remote` will not be
 ```js
 const $remote = (ipc => ({
     getLastState: async () => ipc.invoke('electron-findbar/last-state'),
-    inputChange: (value) => { ipc.send('electron-findbar/input-change', value) },
+    inputChange: (text) => { ipc.send('electron-findbar/input-change', text) },
     matchCase: (value) => { ipc.send('electron-findbar/match-case', value) },
     previous: () => { ipc.send('electron-findbar/previous') },
     next: () => { ipc.send('electron-findbar/next') },
+    open: () => { ipc.send('electron-findbar/open') },
     close: () => { ipc.send('electron-findbar/close') }
 })) (require('electron').ipcRenderer)
 
@@ -337,7 +338,7 @@ The `updateParentWindow` method allows you to change the parent window while pre
 
 ```javascript
 // Create a findbar for the initial window
-const findbar = Findbar.from(oldWindow, webContents)
+const findbar = Findbar.from([oldWindow, ]webContents)
 
 // Later, when you need to change the parent:
 findbar.updateParentWindow(newWindow)

package/index.js

@@ -13,8 +13,11 @@ class Findbar {
     /** @type {WebContents} */
     #findableContents
 
+    /** @type {boolean} */
+    #propagateVisibilityEvents = true
+
     /** @type { { active: number, total: number } } */
-    #matches
+    #matches = { active: 0, total: 0 }
 
     /** @type {(findbarWindow: BrowserWindow) => void} */
     #windowHandler
@@ -63,9 +66,8 @@ class Findbar {
     constructor (parent, webContents) {
         if (isFindable(parent)) {
             this.#findableContents = parent
-            this.#parent = Findbar.#getBaseWindowFromWebContents(this.#findableContents)
+            parent = Findbar.#getBaseWindowFromWebContents(this.#findableContents)
         } else {
-            this.#parent = parent
             this.#findableContents = webContents ?? Findbar.#retrieveWebContents(parent)
         }
 
@@ -76,6 +78,7 @@ class Findbar {
         this.#findableContents._findbar = this
 
         this.#findableContents.once('destroyed', () => { this.detach() })
+        this.updateParentWindow(parent)
     }
 
     /**
@@ -87,6 +90,7 @@ class Findbar {
             this.#focusWindowAndHighlightInput()
             return
         }
+        if (!this.#parent) { this.updateParentWindow() }
         const options = Findbar.#mergeStandardOptions(this.#customOptions, this.#parent)
         this.#isMovable = options.movable
         this.#window = new BrowserWindow(options)
@@ -127,6 +131,9 @@ class Findbar {
         if (this.#parent === newParent) { return }
         this.close()
         this.#parent = newParent ?? Findbar.#getBaseWindowFromWebContents(this.#findableContents)
+        if (this.#parent && !this.#parent.isDestroyed()) {
+            this.#parent.once('closed', () => { this.#removeParent() })
+        }
     }
 
     /**
@@ -171,6 +178,7 @@ class Findbar {
      * @returns {void}
      */
     findPrevious() {
+        if (this.#matches.total < 2) { return }
         this.#matches.active === 1 && (this.#fixMove = false)
         this.isOpen() && this.#findInContent({ forward: false })
     }
@@ -180,6 +188,7 @@ class Findbar {
      * @returns {void}
      */
     findNext() {
+        if (this.#matches.total < 2) { return }
         this.#matches.active === this.#matches.total && (this.#fixMove = true)
         this.isOpen() && this.#findInContent({ forward: true })
     }
@@ -257,6 +266,15 @@ class Findbar {
         this.#boundsHandler = boundsHandler
     }
 
+    /**
+     * Set whether to propagate visibility events to the parent window. If true, when the parent window is shown/hidden, the findbar will also be shown/hidden.
+     * @param {boolean} shouldPropagate - Whether to propagate visibility events. Default is true.
+     * @returns {void}
+     */
+    propagateVisibilityEvents(shouldPropagate) {
+        this.#propagateVisibilityEvents = shouldPropagate
+    }
+
     #registerKeyboardShortcuts(event, input) {
         if (input.meta || input.control || input.alt) { return }
 
@@ -283,6 +301,12 @@ class Findbar {
             }
         }
     }
+
+    #removeParent() {
+        this.close()
+        this.#parent = null
+    }
+
     /**
      * @param {Electron.FindInPageOptions} options 
      */
@@ -311,16 +335,20 @@ class Findbar {
         
         if (this.#parent && !this.#parent.isDestroyed()) {
             boundsHandler()
-            this.#parent.prependListener('show', showCascade)
-            this.#parent.prependListener('hide', hideCascade)
+            if (this.#propagateVisibilityEvents) {
+                this.#parent.prependListener('show', showCascade)
+                this.#parent.prependListener('hide', hideCascade)
+            }
             this.#parent.prependListener('resize', boundsHandler)
             this.#parent.prependListener('move', boundsHandler)
         }
 
         this.#window.once('closed', () => {
             if (this.#parent && !this.#parent.isDestroyed()) {
-                this.#parent.off('show', showCascade)
-                this.#parent.off('hide', hideCascade)
+                if (this.#propagateVisibilityEvents) {
+                    this.#parent.off('show', showCascade)
+                    this.#parent.off('hide', hideCascade)
+                }
                 this.#parent.off('resize', boundsHandler)
                 this.#parent.off('move', boundsHandler)
             }
@@ -346,7 +374,8 @@ class Findbar {
             this.#fixMove = null
         }
 
-        this.#matches = { active, total }
+        this.#matches.active = active
+        this.#matches.total = total
 
         this.#window.webContents.send('electron-findbar/matches', this.#matches)
     }
@@ -365,16 +394,16 @@ class Findbar {
      * @returns {WebContents | undefined} The web contents if any.
      */
     static #retrieveWebContents(window) {
-        return window.webContents ?? window.contentView?.children[0]
+        return window.webContents ?? window.contentView?.children[0]?.webContents
     }
 
     /**
      * Get the parent window from web contents.
-     * @param {WebContents} cont 
+     * @param {WebContents} w 
      * @returns {BaseWindow | undefined} Parent window if any.
      */
-    static #getBaseWindowFromWebContents(cont) {
-        return BaseWindow.getAllWindows().find(win => win.webContents === cont || win.contentView.children.some(child => child.webContents === cont))
+    static #getBaseWindowFromWebContents(w) {
+        return BaseWindow.getAllWindows().find(win => win.webContents === w || win.contentView.children.some(child => child.webContents === w))
     }
 
     /**
@@ -448,7 +477,7 @@ class Findbar {
     }
 
     /**
-     * Get the findbar instance for a given BrowserWindow or WebContents. 
+     * Get the findbar instance for a given BrowserWindow or WebContents.
      * @param {BrowserWindow | WebContents} windowOrWebContents
      * @returns {Findbar | undefined} The findbar instance if it exists, otherwise undefined.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "electron-findbar",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "Chrome-like findbar for your Electron app.",
   "main": "index.js",
   "files": [