https://github.com/iSapozhnik/Popover

Custom macOS Popover 💬
https://github.com/iSapozhnik/Popover

macos macos-app menubar nspanel nspopover nsstatusbarbutton nsstatusitem nswindow osx popover statusbar windows

Last synced: 14 days ago
JSON representation

Custom macOS Popover 💬

• Host: GitHub
• URL: https://github.com/iSapozhnik/Popover
• Owner: iSapozhnik
• License: mit
• Created: 2020-04-01T21:42:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-11-12T12:42:56.000Z (about 3 years ago)
• Last Synced: 2024-10-25T05:49:22.918Z (19 days ago)
• Topics: macos, macos-app, menubar, nspanel, nspopover, nsstatusbarbutton, nsstatusitem, nswindow, osx, popover, statusbar, windows
• Language: Swift
• Homepage: https://isapozhnik.com/articles/status-item/
• Size: 349 KB
• Stars: 124
• Watchers: 4
• Forks: 18
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Popover



![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)



>Custom macOS popover.

![alt text](popover.png "Popover")

# 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 © 2020-present Sapozhnik Ivan.**

Heavily inspired by [CCNStatusItem](https://github.com/phranck/CCNStatusItem)