Merge pull request #6 from iSapozhnik/feature/keep-popover-visible

Keep popover visible

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Sapozhnik Ivan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,6 +1,15 @@
 # Popover
 
-Mac OS custom popover.
+<div align="center">
+
+![Swift](https://img.shields.io/badge/%20in-swift%205.0-orange.svg)
+![macOS](https://img.shields.io/badge/macOS-10.12-green.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+</div>
+
+>Custom macOS popover.
+
 ![alt text](popover.png "Popover")
 
 # Install
@@ -28,7 +37,7 @@ dependencies: [
 2. Create a view you want to put into a status bar.
 3. Create a content view controller which would be embedded inside Popover
 4. Optionally create menu items
-5. Create a Popover instance. Here you can use either standard configuration (you don't need to pass `windowConfiguration` parameter in this case) or you can subclass `DefaultConfiguration`, override some properties and pass a new instance as a parameter. If in ste 4 you have created menu items, pass it here as well.
+5. Create a Popover instance. Here you can use either standard configuration (you don't need to pass `windowConfiguration` parameter in this case) or you can subclass `DefaultConfiguration`, override some properties and pass a new instance as a parameter. If in step 4 you have created menu items, pass it here as well. You can see them by making right click on menu bar item. 
 6. Call `prepare` to set everything up.
 
 And here is how typical `AppDelegate` may look like:
@@ -112,5 +121,17 @@ public protocol PopoverConfiguration {
 }
 ```
 
+## Mentions
+- [AppCoda Weekly - Issue #172](http://digest.appcoda.com/issues/appcoda-weekly-issue-172-239907)
+
+## Credits
+
+Created and maintained by [**@iSapozhnik**](https://twitter.com/iSapozhnik).
+
+## License
+
+Released under the MIT License. See `LICENSE` for details.
+
+>**Copyright &copy; 2020-present Sapozhnik Ivan.**
 
 Heavily inspired by [CCNStatusItem](https://github.com/phranck/CCNStatusItem)

Sources/Popover/Popover.swift

@@ -8,7 +8,17 @@
 import Cocoa
 
 public class Popover: NSObject {
-    var item: NSStatusItem! {
+    public var window: NSWindow? {
+        return popoverWindowController?.window
+    }
+
+    public var keepPopoverVisible: Bool = false {
+        didSet {
+            keepPopoverVisible ? removeMonitors() : setupMonitors()
+        }
+    }
+
+    @objc dynamic var item: NSStatusItem! {
         didSet {
             prepareMenu()
         }
@@ -85,6 +95,11 @@ public class Popover: NSObject {
         guard !isPopoverWindowVisible else { return }
         popoverWindowController?.show()
         globalEventMonitor?.start()
+
+        guard let button = item.button else { return }
+        DispatchQueue.main.async(execute: {
+            button.isHighlighted = true
+        })
     }
 
     /// Dismisses the Popover with default animation. Animation behavior is `AnimationBehavior.utilityWindow`
@@ -92,6 +107,11 @@ public class Popover: NSObject {
         guard isPopoverWindowVisible else { return }
         popoverWindowController?.dismiss()
         globalEventMonitor?.stop()
+
+        guard let button = item.button else { return }
+        DispatchQueue.main.async(execute: {
+            button.isHighlighted = false
+        })
     }
 
     private func setupMonitors() {
@@ -117,6 +137,14 @@ public class Popover: NSObject {
         }
     }
 
+    private func removeMonitors() {
+        globalEventMonitor?.stop()
+        globalEventMonitor = nil
+
+        localEventMonitor?.stop()
+        localEventMonitor = nil
+    }
+
     private func configureStatusBarButton(with image: NSImage) {
         item = NSStatusBar.system.statusItem(withLength: NSStatusItem.variableLength)
         guard let button = item.button else { return }

Sources/Popover/PopoverWindow.swift

@@ -44,7 +44,7 @@ class PopoverWindow: NSPanel {
     static func window(with configuration: PopoverConfiguration) -> PopoverWindow {
         let window = PopoverWindow.init(
             contentRect: .zero,
-            styleMask: .nonactivatingPanel,
+            styleMask: [.nonactivatingPanel],
             backing: .buffered,
             defer: true,
             configuration: configuration

Sources/Popover/PopoverWindowController.swift

@@ -7,7 +7,7 @@
 
 import Cocoa
 
-class PopoverWindowController: NSWindowController {
+class PopoverWindowController: NSWindowController, NSWindowDelegate {
     public private(set) var windowIsOpen: Bool = false
     public private(set) var isAnimating: Bool = false
 
@@ -18,7 +18,9 @@ class PopoverWindowController: NSWindowController {
         self.popover = popover
         self.wConfig = windowConfiguration
 
-        super.init(window: PopoverWindow.window(with: windowConfiguration))
+        let window = PopoverWindow.window(with: windowConfiguration)
+        super.init(window: window)
+        window.delegate = self
         self.contentViewController = contentViewController
     }
 
@@ -30,7 +32,7 @@ class PopoverWindowController: NSWindowController {
         guard !isAnimating else { return }
 
         updateWindowFrame()
-        window?.alphaValue = 1.0
+
         showWindow(nil)
         windowIsOpen = true
         window?.makeKey()
@@ -45,7 +47,7 @@ class PopoverWindowController: NSWindowController {
         windowIsOpen = false
     }
 
-    private func updateWindowFrame() {
+    func updateWindowFrame() {
         guard let window = self.window as? PopoverWindow else { return }
         let windowFrame = visibleStatusItemWindowFrame()
         window.arrowXLocation = windowFrame.arrowXLocation
@@ -82,4 +84,8 @@ class PopoverWindowController: NSWindowController {
 
         return currentScreen ?? NSScreen.main ?? NSScreen()
     }
+
+    func windowDidResize(_ notification: Notification) {
+        updateWindowFrame()
+    }
 }