NSPopoverTouchBarItems in NSScrollView (NSTouchBar)

Question

Is there a way to add an array of NSPopoverTouchBarItems into a NSScrollView?

Currently, my view hierarchy resembles the below list.

• NSTouchBar
  • NSCustomTouchBarItem
    • NSScrollView
      • NSStackView
        • Array of NSButtons

The above hierarchy outputs the following screenshot.

In sum, the end goal is to replace the array of NSButtons with NSPopoverTouchBarItems.

Answer 1

I believe what you need is the use of NSScrubber to be able to scroll or have fixed position of multiple buttons including NSPopoverTouchBarItem

https://developer.apple.com/documentation/appkit/nsscrubber

Check out this repository for more information and sample codes that might help you:

https://github.com/loretoparisi/touchbar

import Cocoa

fileprivate extension NSTouchBar.CustomizationIdentifier {
    static let popoverBar = NSTouchBar.CustomizationIdentifier("com.TouchBarCatalog.popoverBar")
}

fileprivate extension NSTouchBarItem.Identifier {
    static let scrubberPopover = NSTouchBarItem.Identifier("com.TouchBarCatalog.TouchBarItem.scrubberPopover")
}

class PopoverScrubber: NSScrubber {
    var presentingItem: NSPopoverTouchBarItem?
}

class PopoverScrubberViewController: NSViewController {
    // MARK: NSTouchBar

    override func makeTouchBar() -> NSTouchBar? {
        let touchBar = NSTouchBar()
        touchBar.delegate = self
        touchBar.customizationIdentifier = .popoverBar
        touchBar.defaultItemIdentifiers = [.scrubberPopover]
        touchBar.customizationAllowedItemIdentifiers = [.scrubberPopover]

        return touchBar
    }
}

// MARK: NSTouchBarDelegate

extension PopoverScrubberViewController: NSTouchBarDelegate {
    func touchBar(_ touchBar: NSTouchBar, makeItemForIdentifier identifier: NSTouchBarItem.Identifier) -> NSTouchBarItem? {
        guard identifier == NSTouchBarItem.Identifier.scrubberPopover else { return nil }

        let popoverItem = NSPopoverTouchBarItem(identifier: identifier)
        popoverItem.collapsedRepresentationLabel = "Scrubber Popover"
        popoverItem.customizationLabel = "Scrubber Popover"

        let scrubber = PopoverScrubber()
        scrubber.register(NSScrubberTextItemView.self, forItemIdentifier: NSUserInterfaceItemIdentifier(rawValue: "TextScrubberItemIdentifier"))
        scrubber.mode = .free
        scrubber.selectionBackgroundStyle = .roundedBackground
        scrubber.delegate = self
        scrubber.dataSource = self
        scrubber.presentingItem = popoverItem

        popoverItem.collapsedRepresentation = scrubber

        popoverItem.popoverTouchBar = PopoverTouchBarSample(presentingItem: popoverItem)

        return popoverItem
    }
}

// MARK: NSScrubber Data Source and delegate

extension PopoverScrubberViewController: NSScrubberDataSource, NSScrubberDelegate {

    func numberOfItems(for scrubber: NSScrubber) -> Int {
        return 20
    }

    func scrubber(_ scrubber: NSScrubber, viewForItemAt index: Int) -> NSScrubberItemView {
        let itemView = scrubber.makeItem(withIdentifier: NSUserInterfaceItemIdentifier(rawValue: "TextScrubberItemIdentifier"), owner: nil) as! NSScrubberTextItemView
        itemView.textField.stringValue = String(index)
        return itemView
    }

    func scrubber(_ scrubber: NSScrubber, didSelectItemAt index: Int) {
        print("\(#function) at index \(index)")

        if let popoverScrubber = scrubber as? PopoverScrubber,
            let popoverItem = popoverScrubber.presentingItem {
            popoverItem.showPopover(nil)
        }
    }
}