Create swift.yml

Enable showing the popover without taking application focus and keeping the popover visible without disabling right click

.github/workflows/swift.yml

@@ -0,0 +1,19 @@
+name: Swift
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: macos-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build
+      run: swift build -v
+    - name: Run tests
+      run: swift test -v

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,137 @@
 # Popover
 
-Mac OS custom popover. Made with ❤️
+<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")
 
-Heavily inspired by [CCNStatusItem](https://github.com/phranck/CCNStatusItem)
+# Install
+
+Since this is a Swift Package, the installation process is pretty stright forward.
+
+### Manual way
+Update your `Package.swift` dependencies:
+
+```
+dependencies: [
+    .package(url: "https://github.com/iSapozhnik/Popover", from: "1.1.1")
+]
+```
+
+### Via Xcode:
+1. Go to `File -> Swift Packages -> Add Package Dependency`. 
+2. Put GitHub URL `https://github.com/iSapozhnik/Popover` and click `Next`
+3. Select the latest version
+4. Click `Finish`
+
+# How to use
+
+1. In your `AppDelegate` import Popover
+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 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:
+
+```swift
+import Cocoa
+import Popover
+
+class MyPopoverConfiguration: DefaultConfiguration {
+    override var backgroundColor: NSColor {
+        return NSColor.systemRed
+    }
+
+    override var borderColor: NSColor? {
+        return NSColor.red
+    }
+}
+
+@NSApplicationMain
+class AppDelegate: NSObject, NSApplicationDelegate {
+    var popover: Popover!
+
+    func applicationDidFinishLaunching(_ aNotification: Notification) {
+        let statusItemView = StatusItemView(frame: NSRect(width: 22.0, height: 20))
+
+        let viewController = MainViewController()
+
+        let menuItems: [Popover.MenuItemType] = [
+            .item(Popover.MenuItem(title: "Settings", action: viewController.showSettings)),
+            .separator,
+            .item(Popover.MenuItem(title: "Quit", key: "q", action: viewController.quit))
+        ]
+
+        popover = Popover(with: MyPopoverConfiguration(), menuItems: menuItems)
+        popover.prepare(with: statusItemView, contentViewController: viewController)
+    }
+}
+
+```
+
+# What can be customized?
+
+Quite a lot of things:
+
+```swift
+public protocol PopoverConfiguration {
+    /// The distance from Popover's arrow to a status item.
+    var popoverToStatusItemMargin:  CGFloat { get }
+
+    /// Popover's background color.
+    var backgroundColor:            NSColor { get }
+
+    /// Popover's border color.
+    /// - Important:
+    ///     If `borderColor` returns `nil`, settings `borderWidth` won't make any effect. See also: `borderWidth`.
+    var borderColor:                NSColor? { get }
+
+    /// Popover's border width.
+    /// - Important:
+    ///      If Popover's border color is set to `nil`, setting `borderWidth` won't make any effect.
+    var borderWidth:                CGFloat { get }
+
+    /// Defines Popover arrow height.
+    var arrowHeight:                CGFloat { get }
+
+    /// Defines Popover arrow width.
+    var arrowWidth:                 CGFloat { get }
+
+    /// Defines Popover corner radius.
+    /// - Warning:
+    ///     If this value is too big and if the Popover's status item (menu bar view) is too close to the right edge, the appearence of the Popover might be odd.
+    var cornerRadius:               CGFloat { get }
+
+    /// Defines Popover content edge insets.
+    var contentEdgeInsets:          NSEdgeInsets { get }
+
+    /// The distance from the right side of the Popover to the screen's edge.
+    /// - Warning:
+    ///     If this value is too big and if the Popover's status item (menu bar view) is too close to the right edge, the appearence of the Popover might be odd.
+    var rightEdgeMargin:            CGFloat { get }
+}
+```
+
+## 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/EventMonitor.swift

@@ -8,13 +8,25 @@
 import Cocoa
 
 class EventMonitor {
+    enum MonitorType {
+        case global
+        case local
+    }
+    
+    typealias GlobalEventHandler = (NSEvent?) -> Void
+    typealias LocalEventHandler = (NSEvent?) -> NSEvent?
+
     private var monitor: Any?
     private let mask: NSEvent.EventTypeMask
-    private let handler: (NSEvent?) -> Void
+    private let monitorType: MonitorType
+    private let globalHandler: GlobalEventHandler?
+    private let localHandler: LocalEventHandler?
 
-    init(mask: NSEvent.EventTypeMask, handler: @escaping (NSEvent?) -> Void) {
+    init(monitorType: MonitorType, mask: NSEvent.EventTypeMask, globalHandler: GlobalEventHandler?, localHandler: LocalEventHandler?) {
         self.mask = mask
-        self.handler = handler
+        self.monitorType = monitorType
+        self.globalHandler = globalHandler
+        self.localHandler = localHandler
     }
 
     deinit {
@@ -22,7 +34,12 @@ class EventMonitor {
     }
 
     func start() {
-        monitor = NSEvent.addGlobalMonitorForEvents(matching: mask, handler: handler)
+        switch monitorType {
+        case .global:
+            startGlobalMonitor()
+        case .local:
+            startLocalMonitor()
+        }
     }
 
     func stop() {
@@ -31,4 +48,20 @@ class EventMonitor {
         NSEvent.removeMonitor(monitor)
         self.monitor = nil
     }
+
+    private func startGlobalMonitor() {
+        guard let handler = globalHandler else {
+            assertionFailure("Global event handler is not set.")
+            return
+        }
+        monitor = NSEvent.addGlobalMonitorForEvents(matching: mask, handler: handler)
+    }
+
+    private func startLocalMonitor() {
+        guard let handler = localHandler else {
+            assertionFailure("Local event handler is not set.")
+            return
+        }
+        monitor = NSEvent.addLocalMonitorForEvents(matching: mask, handler: handler)
+    }
 }

Sources/Popover/Extensions.swift

@@ -0,0 +1,20 @@
+//
+//  File.swift
+//  
+//
+//  Created by Ivan Sapozhnik on 06.04.20.
+//
+
+import Cocoa
+
+extension CAEdgeAntialiasingMask {
+    static var all: CAEdgeAntialiasingMask {
+        return [.layerLeftEdge, .layerRightEdge, .layerBottomEdge, .layerTopEdge]
+    }
+}
+
+extension Array {
+    var isNotEmpty: Bool {
+        return !isEmpty
+    }
+}

Sources/Popover/MenuItem.swift

@@ -0,0 +1,36 @@
+//
+//  File.swift
+//  
+//
+//  Created by Ivan Sapozhnik on 07.04.20.
+//
+
+import Foundation
+
+public extension Popover {
+    enum MenuItemType {
+        case item(MenuItem)
+        case separator
+    }
+
+    class MenuItem: NSObject {
+        let title: String
+        let key: String
+        let _action: () -> Void
+
+        public convenience init(title: String, action: @escaping () -> Void) {
+            self.init(title: title, key: "", action: action)
+        }
+
+        public init(title: String, key: String, action: @escaping () -> Void) {
+            self.title = title
+            self.key = key
+            _action = action
+        }
+
+        @objc
+        func action() {
+            _action()
+        }
+    }
+}

Sources/Popover/Popover.swift

@@ -8,59 +8,143 @@
 import Cocoa
 
 public class Popover: NSObject {
-    var item: NSStatusItem!
+    public var window: NSWindow? {
+        return popoverWindowController?.window
+    }
+
+    public var keepPopoverVisible: Bool = false
+
+    @objc dynamic var item: NSStatusItem! {
+        didSet {
+            prepareMenu()
+        }
+    }
 
     private let wConfig: PopoverConfiguration
     private var popoverWindowController: PopoverWindowController?
-    private var statusItemContainer: StatusItemContainerView?
-    private var eventMonitor: EventMonitor?
+    private var globalEventMonitor: EventMonitor?
+    private var localEventMonitor: EventMonitor?
+    private var menu: NSMenu?
+    private var menuItems: [MenuItemType]?
 
     private var isPopoverWindowVisible: Bool {
         return (popoverWindowController != nil) ? popoverWindowController!.windowIsOpen : false
     }
 
+    /// Convenience initializer which is using default configuration
+    public convenience override init() {
+        self.init(with: DefaultConfiguration(), menuItems: nil)
+    }
+
+    /// Convenience initializer
+    ///
+    /// - Parameters:
+    ///     - windowConfiguration: Popover window configuration. Subclass `DefaultConfiguration` and override properties or conform to `PopoverConfiguration` protocol.
+    public convenience init(with windowConfiguration: PopoverConfiguration) {
+        self.init(with: windowConfiguration, menuItems: nil)
+    }
+
+    /// Convenience initializer which is using default configuration and optiona menu items
+    ///
+    /// - Parameters:
+    ///     - menuItems: Array of items that NSMenu will show
+    public convenience init(with menuItems: [MenuItemType]?) {
+        self.init(with: DefaultConfiguration(), menuItems: menuItems)
+    }
+
     /// Creates a Popover with given PopoverConfiguration. Popover configuration can be either `DefaultConfiguration` or you can sublclass this class and override some of the properties.
+    ///
     /// By default Popover is using Event Monitor and by doing left or right click ouside of the Popover's frame, the Popover will be automatically dismissed.
-    public init(with windowConfiguration: PopoverConfiguration) {
+    ///
+    /// - Parameters:
+    ///     - windowConfiguration: Popover window configuration. By default `DefaultConfiguration` instance is being used.
+    ///     - menuItems: Array of items that NSMenu will show
+    public init(with windowConfiguration: PopoverConfiguration, menuItems: [MenuItemType]?) {
         wConfig = windowConfiguration
+        self.menuItems = menuItems
 
         super.init()
 
-        eventMonitor = EventMonitor(mask: [.rightMouseDown, .leftMouseDown], handler: { [weak self] event in
-            guard let self = self else { return }
-            self.dismiss()
-        })
-    }
-
-    /// Convenience initializer which is using default configuration
-    public convenience override init() {
-        self.init(with: DefaultConfiguration())
+        setupMonitors()
     }
 
     /// Creates a Popover with given image and contentViewController
+    ///
     /// By default it won't present any Popover until the user clicks on status bar item
-    public func createPopover(with image: NSImage, contentViewController viewController: NSViewController) {
+    public func prepare(with image: NSImage, contentViewController viewController: NSViewController) {
         configureStatusBarButton(with: image)
         popoverWindowController = PopoverWindowController(with: self, contentViewController: viewController, windowConfiguration: wConfig)
+        localEventMonitor?.start()
     }
 
     /// Creates a Popover with given view and contentViewController. The view's height will be scaled down to 18pt and also will be vertically aligned. The wdith can be any.
+    ///
     /// By default it won't present any Popover until the user clicks on status bar item
-    public func createPopover(with view: NSView, contentViewController viewController: NSViewController) {
+    public func prepare(with view: NSView, contentViewController viewController: NSViewController) {
         configureStatusBarButton(with: view)
         popoverWindowController = PopoverWindowController(with: self, contentViewController: viewController, windowConfiguration: wConfig)
+        localEventMonitor?.start()
+    }
+
+    public func show() {
+      self.show(withFocus: true)
     }
 
     /// Shows the Popover with no animation
-    public func show() {
-        popoverWindowController?.show()
-        eventMonitor?.start()
+    public func show(withFocus: Bool) {
+        guard !isPopoverWindowVisible else { return }
+        popoverWindowController?.show(withFocus: withFocus)
+        globalEventMonitor?.start()
+
+        guard let button = item.button else { return }
+        DispatchQueue.main.async(execute: {
+            button.isHighlighted = true
+        })
     }
 
-    /// Dismisses the Popover with default animation. Animation behaviour is `AnimationBehavior.utilityWindow`
+    /// Dismisses the Popover with default animation. Animation behavior is `AnimationBehavior.utilityWindow`
     public func dismiss() {
+        guard isPopoverWindowVisible else { return }
         popoverWindowController?.dismiss()
-        eventMonitor?.stop()
+        globalEventMonitor?.stop()
+
+        guard let button = item.button else { return }
+        DispatchQueue.main.async(execute: {
+            button.isHighlighted = false
+        })
+    }
+
+    private func setupMonitors() {
+        globalEventMonitor = EventMonitor(monitorType: .global, mask: [.leftMouseDown, .rightMouseDown], globalHandler: { [weak self] _ in
+            guard let self = self else { return }
+            if (!self.keepPopoverVisible) {
+              self.dismiss()
+            }
+        }, localHandler: nil)
+
+        if menuItems != nil, menuItems?.isNotEmpty ?? false {
+            localEventMonitor = EventMonitor(monitorType: .local, mask: [.leftMouseDown, .rightMouseDown], globalHandler: nil, localHandler: { [weak self] event -> NSEvent? in
+                guard let self = self, let currentEvent = event else { return event }
+
+                let isRightMouseClick = currentEvent.type == .rightMouseDown
+                let isControlLeftClick = currentEvent.type == .leftMouseDown && currentEvent.modifierFlags.contains(.control)
+
+                if isRightMouseClick || isControlLeftClick {
+                    self.dismiss()
+                    self.item.menu = self.menu
+                }
+
+                return event
+            })
+        }
+    }
+
+    private func removeMonitors() {
+        globalEventMonitor?.stop()
+        globalEventMonitor = nil
+
+        localEventMonitor?.stop()
+        localEventMonitor = nil
     }
 
     private func configureStatusBarButton(with image: NSImage) {
@@ -68,9 +152,8 @@ public class Popover: NSObject {
         guard let button = item.button else { return }
 
         image.isTemplate = true
-        button.target = self
-        button.action = #selector(handleStatusItemButtonAction(_:))
         button.image = image
+        setTargetAction(for: button)
     }
 
     private func configureStatusBarButton(with view: NSView) {
@@ -79,17 +162,43 @@ public class Popover: NSObject {
 
         let statusItemContainer = StatusItemContainerView()
 
-        button.target = self
-        button.action = #selector(handleStatusItemButtonAction(_:))
+        setTargetAction(for: button)
         button.addSubview(statusItemContainer)
 
         statusItemContainer.embed(view)
-
-        button.frame = statusItemContainer.frame
-        self.statusItemContainer = statusItemContainer
     }
 
     @objc private func handleStatusItemButtonAction(_ sender: Any?) {
-        isPopoverWindowVisible ? dismiss() : show()
+        isPopoverWindowVisible ? dismiss() : show(withFocus: true)
+    }
+
+    private func setTargetAction(for button: NSButton) {
+        button.target = self
+        button.action = #selector(handleStatusItemButtonAction(_:))
+    }
+
+    private func prepareMenu() {
+        guard menuItems != nil, menuItems?.isNotEmpty ?? false else { return }
+
+        let menu = NSMenu()
+        menuItems?.forEach { menuItemType in
+            switch menuItemType {
+            case .item(let actionItem):
+                let menuItem = NSMenuItem(title: actionItem.title, action: #selector(MenuItem.action), keyEquivalent: actionItem.key)
+                menuItem.target = actionItem
+                menu.addItem(menuItem)
+            case .separator:
+                menu.addItem(NSMenuItem.separator())
+            }
+        }
+
+        menu.delegate = self
+        self.menu = menu
+    }
+}
+
+extension Popover: NSMenuDelegate {
+    public func menuDidClose(_ menu: NSMenu) {
+        item.menu = nil
     }
 }

Sources/Popover/PopoverConfiguration.swift

@@ -16,12 +16,12 @@ public protocol PopoverConfiguration {
 
     /// Popover's border color.
     /// - Important:
-    ///     If `borderColor` returns `nil`, settings `borderWidth` won't make any affect. See also: `borderWidth`.
+    ///     If `borderColor` returns `nil`, settings `borderWidth` won't make any effect. See also: `borderWidth`.
     var borderColor:                NSColor? { get }
 
     /// Popover's border width.
     /// - Important:
-    ///      If Popover's border color is set to `nil`, setting `borderWidth` won't make any affect.
+    ///      If Popover's border color is set to `nil`, setting `borderWidth` won't make any effect.
     var borderWidth:                CGFloat { get }
 
     /// Defines Popover arrow height.

Sources/Popover/PopoverWindow.swift

@@ -17,9 +17,20 @@ class PopoverWindow: NSPanel {
     private var childContentView: NSView?
     private var backgroundView: PopoverWindowBackgroundView?
 
-    private init(contentRect: NSRect, styleMask style: NSWindow.StyleMask, backing backingStoreType: NSWindow.BackingStoreType, defer flag: Bool, configuration: PopoverConfiguration) {
+    private init(
+        contentRect: NSRect,
+        styleMask style: NSWindow.StyleMask,
+        backing backingStoreType: NSWindow.BackingStoreType,
+        defer flag: Bool,
+        configuration: PopoverConfiguration
+    ) {
         wConfig = configuration
-        super.init(contentRect: contentRect, styleMask: style, backing: backingStoreType, defer: flag)
+        super.init(
+            contentRect: contentRect,
+            styleMask: style,
+            backing: backingStoreType,
+            defer: flag
+        )
 
         isOpaque = false
         hasShadow = true
@@ -33,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
@@ -50,12 +61,10 @@ class PopoverWindow: NSPanel {
         set {
             guard childContentView != newValue, let bounds = newValue?.bounds else { return }
 
-            let antialiasingMask: CAEdgeAntialiasingMask = [.layerLeftEdge, .layerRightEdge, .layerBottomEdge, .layerTopEdge]
-
             backgroundView = super.contentView as? PopoverWindowBackgroundView
             if (backgroundView == nil) {
                 backgroundView = PopoverWindowBackgroundView(frame: bounds, windowConfiguration: wConfig)
-                backgroundView?.layer?.edgeAntialiasingMask = antialiasingMask
+                backgroundView?.layer?.edgeAntialiasingMask = .all
                 super.contentView = backgroundView
             }
 
@@ -68,7 +77,7 @@ class PopoverWindow: NSPanel {
             childContentView?.wantsLayer = true
             childContentView?.layer?.cornerRadius = wConfig.cornerRadius
             childContentView?.layer?.masksToBounds = true
-            childContentView?.layer?.edgeAntialiasingMask = antialiasingMask
+            childContentView?.layer?.edgeAntialiasingMask = .all
 
             guard let userContentView = self.childContentView, let backgroundView = self.backgroundView else { return }
             backgroundView.addSubview(userContentView)
@@ -97,7 +106,7 @@ class PopoverWindow: NSPanel {
     }
 
     private func updateArrowPosition() {
-        guard let backgroundView = self.backgroundView as? PopoverWindowBackgroundView else { return }
+        guard let backgroundView = self.backgroundView else { return }
         backgroundView.arrowXLocation = arrowXLocation
     }
 }

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
     }
 
@@ -26,14 +28,18 @@ class PopoverWindowController: NSWindowController {
         fatalError("init(coder:) has not been implemented")
     }
 
-    func show() {
+    func show(withFocus: Bool) {
         guard !isAnimating else { return }
 
         updateWindowFrame()
-        window?.alphaValue = 1.0
-        showWindow(nil)
+
+        if (withFocus) {
+          showWindow(nil)
+          window?.makeKey()
+        } else {
+          window?.orderFrontRegardless()
+        }
         windowIsOpen = true
-        window?.makeKey()
         // TODO: animation
     }
 
@@ -45,7 +51,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
@@ -83,4 +89,7 @@ class PopoverWindowController: NSWindowController {
         return currentScreen ?? NSScreen.main ?? NSScreen()
     }
 
+    func windowDidResize(_ notification: Notification) {
+        updateWindowFrame()
+    }
 }

Sources/Popover/StatusItemContainerView.swift

@@ -24,7 +24,7 @@ class StatusItemContainerView: NSView {
         )
         let contentFrame = NSRect(
             x: 0,
-            y: (Constants.maxContainerSize-Constants.maxContentHeight) / 2,
+            y: (Constants.maxContainerSize - Constants.maxContentHeight) / 2,
             width: NSWidth(view.bounds),
             height: Constants.maxContentHeight
         )