updated

Author: flocked

Example/Example.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -0,0 +1,23 @@
+//
+//  AppDelegate.swift
+//  CollectionViewTemplate
+//
+//  Created by Florian Zand on 19.01.23.
+//
+
+import Cocoa
+
+@main
+class AppDelegate: NSObject, NSApplicationDelegate {
+    func applicationDidFinishLaunching(_: Notification) {
+        // Insert code here to initialize your application
+    }
+
+    func applicationWillTerminate(_: Notification) {
+        // Insert code here to tear down your application
+    }
+
+    func applicationSupportsSecureRestorableState(_: NSApplication) -> Bool {
+        true
+    }
+}

OutlineViewDiffableDatasource Example/Example/AppDelegate.swift

@@ -0,0 +1,11 @@
+{
+  "colors" : [
+    {
+      "idiom" : "universal"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

OutlineViewDiffableDatasource Example/Example/Assets.xcassets/AccentColor.colorset/Contents.json

@@ -0,0 +1,58 @@
+{
+  "images" : [
+    {
+      "idiom" : "mac",
+      "scale" : "1x",
+      "size" : "16x16"
+    },
+    {
+      "idiom" : "mac",
+      "scale" : "2x",
+      "size" : "16x16"
+    },
+    {
+      "idiom" : "mac",
+      "scale" : "1x",
+      "size" : "32x32"
+    },
+    {
+      "idiom" : "mac",
+      "scale" : "2x",
+      "size" : "32x32"
+    },
+    {
+      "idiom" : "mac",
+      "scale" : "1x",
+      "size" : "128x128"
+    },
+    {
+      "idiom" : "mac",
+      "scale" : "2x",
+      "size" : "128x128"
+    },
+    {
+      "idiom" : "mac",
+      "scale" : "1x",
+      "size" : "256x256"
+    },
+    {
+      "idiom" : "mac",
+      "scale" : "2x",
+      "size" : "256x256"
+    },
+    {
+      "idiom" : "mac",
+      "scale" : "1x",
+      "size" : "512x512"
+    },
+    {
+      "idiom" : "mac",
+      "scale" : "2x",
+      "size" : "512x512"
+    }
+  ],
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

OutlineViewDiffableDatasource Example/Example/Assets.xcassets/AppIcon.appiconset/Contents.json

@@ -0,0 +1,6 @@
+{
+  "info" : {
+    "author" : "xcode",
+    "version" : 1
+  }
+}

OutlineViewDiffableDatasource Example/Example/Assets.xcassets/Contents.json

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict/>
+</plist>

OutlineViewDiffableDatasource Example/Example/Base.lproj/Main.storyboard

@@ -0,0 +1,97 @@
+//
+//  ViewController.swift
+//
+//
+//  Created by Florian Zand on 19.01.23.
+//
+
+import AppKit
+import AdvancedCollectionTableView
+
+class MainViewController: NSViewController {
+    typealias DataSource = CollectionViewDiffableDataSource<Section, GalleryItem>
+    typealias ItemRegistration = NSCollectionView.ItemRegistration<NSCollectionViewItem, GalleryItem>
+    
+    @IBOutlet var collectionView: NSCollectionView!
+
+    var galleryItems = GalleryItem.sampleItems
+
+    lazy var dataSource = DataSource(collectionView: collectionView, itemRegistration: itemRegistration)
+
+    let itemRegistration = ItemRegistration() { collectionViewItem, _, galleryItem in
+        /// Configurate the item
+        var configuration = NSItemContentConfiguration()
+        configuration.text = galleryItem.title
+        configuration.secondaryText = galleryItem.detail
+        configuration.image = NSImage(named: galleryItem.title)
+        configuration.contentProperties.shadow = .black(opacity: 0.5, radius: 5.0)
+        if let badgeText = galleryItem.badgeText {
+            configuration.badges = [.text(badgeText, color: galleryItem.badgeColor, type: .attachment)]
+        }
+        
+        if galleryItem.isFavorite {
+            configuration.badges = [.text("􀋃", color: .systemRed, shape: .circle, type: .attachment)]
+        }
+
+        /// Apply the configuration
+        collectionViewItem.contentConfiguration = configuration
+        
+        /// Gets called when the item state changes (on selection, mouse hover, etc.)
+        collectionViewItem.configurationUpdateHandler = { item, state in
+            /// Updates the configuration based on whether the mouse is hovering the item
+            configuration.contentProperties.scaleTransform = state.isHovered ? 1.03 : 1.0
+            configuration.overlayView = state.isHovered ? NSView(color: .white, opacity: 0.25) : nil
+            
+            /// Apply the updated configuration animated.
+            item.contentConfiguration = configuration
+        }
+    }
+    
+    override func viewDidLoad() {
+        super.viewDidLoad()
+        
+        collectionView.collectionViewLayout = .grid(columns: 3)
+        collectionView.dataSource = dataSource
+
+        /// Enables deleting selected items via backspace key.
+        dataSource.deletingHandlers.canDelete = { selectedItems in return selectedItems }
+        dataSource.deletingHandlers.didDelete = { deletedItems, _ in
+            self.galleryItems.remove(deletedItems)
+        }
+
+        /// Enables reordering selected items by dragging them.
+        dataSource.reorderingHandlers.canReorder = { selectedItems in return true }
+        dataSource.reorderingHandlers.didReorder = { transaction in
+            self.galleryItems = self.galleryItems.applying(transaction.difference)!
+        }
+        
+        dataSource.rightClickHandler = { selectedItems in
+            selectedItems.forEach({ item in
+                item.isFavorite = !item.isFavorite
+            })
+            /// Reconfigurates items without reloading them by calling the item registration handler.
+            self.dataSource.reconfigureElements(selectedItems)
+        }
+                
+        applySnapshot(using: galleryItems)
+        
+        dataSource.selectElements([galleryItems.first!], scrollPosition: .top)
+        collectionView.makeFirstResponder()
+    }
+
+    func applySnapshot(using items: [GalleryItem]) {
+        var snapshot = dataSource.emptySnapshot()
+        snapshot.appendSections([.main])
+        snapshot.appendItems(items, toSection: .main)
+        dataSource.apply(snapshot, .withoutAnimation)
+    }
+}
+
+private extension NSView {
+    /// Creates a colored view.
+    convenience init(color: NSColor, opacity: CGFloat) {
+        self.init(frame: .zero)
+        backgroundColor = color
+        alphaValue = opacity
+    }
+}

OutlineViewDiffableDatasource Example/Example/Example.entitlements

@@ -0,0 +1,50 @@
+//
+//  CollectionItem.swift
+//
+//
+//  Created by Florian Zand on 24.01.23.
+//
+
+import AppKit
+import FZQuicklook
+
+public class GalleryItem: NSObject, Identifiable {
+    
+    public let title: String
+    public let detail: String
+    public let badgeText: String?
+    public let badgeColor: NSColor
+    public var isFavorite: Bool
+
+    public init(_ title: String, detail: String, badgeText: String? = nil, badgeColor: NSColor = .controlAccentColor, isFavorite: Bool = false) {
+        self.title = title
+        self.detail = detail
+        self.badgeText = badgeText
+        self.badgeColor = badgeColor
+        self.isFavorite = isFavorite
+    }
+
+    static let sampleItems = [GalleryItem("Neil Catstrong", detail: "Liquid Ink"),
+                              GalleryItem("Majestic Mouser", detail: "Painted by Vermeer"),
+                              GalleryItem("Vapor Cat", detail: "Vaporwave", badgeText: "new"),
+                              GalleryItem("Cosmojelly", detail: "Oil on Canvas"),
+                              GalleryItem("Plasmawhale", detail: "Science Fiction", badgeText: "favorite", badgeColor: .systemPurple),
+                              GalleryItem("Berghain", detail: "Surrealist Painting"),
+                              GalleryItem("About Blank", detail: "Oil Painting"),
+                              GalleryItem("Fireworker Monkey", detail: "Japanese Manga"),
+                              GalleryItem("Dystopian City", detail: "Oil Painting", isFavorite: true),
+                              GalleryItem("Underground", detail: "Oil on Canvas"),
+                              GalleryItem("Tresor", detail: "Painting", isFavorite: true),
+                              GalleryItem("Oxi", detail: "Oil on Canvas")]
+}
+
+///  By conforming to `QuicklookPreviewable` and providing `previewItemURL` the items can be previewed by pressing spacebar which opens a Quicklook panel (simliar to Finder).
+extension GalleryItem: QuicklookPreviewable {
+    public var previewItemURL: URL? {
+        Bundle.main.urlForImageResource(title)
+    }
+
+    public var previewItemTitle: String? {
+        title
+    }
+}

OutlineViewDiffableDatasource Example/Example/MainViewController.swift

@@ -0,0 +1,24 @@
+//
+//  OutlineItem.swift
+//
+//
+//  Created by Florian Zand on 22.06.23.
+//
+
+import Foundation
+
+struct OutlineItem: Hashable, ExpressibleByStringLiteral, CustomStringConvertible {
+    let title: String
+    
+    var description: String {
+        title
+    }
+    
+    init(_ title: String) {
+        self.title = title
+    }
+    
+    init(stringLiteral value: String) {
+        self.title = value
+    }
+}

OutlineViewDiffableDatasource Example/Example/Model/CollectionItem.swift

@@ -0,0 +1,22 @@
+//
+//  Section.swift
+//
+//
+//  Created by Florian Zand on 22.06.23.
+//
+
+import Foundation
+
+public enum Section: String, Hashable, Identifiable {
+    case main = "Main"
+    case section2 = "Section 2"
+    case section3 = "Section 3"
+    
+    public var title: String {
+        rawValue
+    }
+
+    public var id: String {
+        rawValue
+    }
+}

OutlineViewDiffableDatasource Example/Example/Model/OutlineItem.swift

@@ -0,0 +1,54 @@
+//
+//  SidebarViewController.swift
+//
+//
+//  Created by Florian Zand on 19.01.23.
+//
+
+import AppKit
+import AdvancedCollectionTableView
+
+class SidebarViewController: NSViewController {
+    typealias DataSource = OutlineViewDiffableDataSource<OutlineItem>
+    typealias CellRegistration = NSTableView.CellRegistration<NSTableCellView, OutlineItem>
+
+    @IBOutlet var outlineView: NSOutlineView!
+    
+    lazy var dataSource = DataSource(outlineView: outlineView, cellRegistration: cellRegistration)
+
+    let cellRegistration = CellRegistration { tableCell, _, _, outlineItem in
+        /// `defaultContentConfiguration` returns a table cell content configuration with default styling based on the table view it's displayed at (in this case a sidebar table).
+        var configuration = tableCell.defaultContentConfiguration()
+        configuration.text = outlineItem.title
+        tableCell.contentConfiguration = configuration
+    }
+    
+    override func viewDidLoad() {
+        super.viewDidLoad()
+
+        outlineView.dataSource = dataSource
+        dataSource.reorderingHandlers.canReorder = { _, _ in return true }
+        applySnapshot()
+    }
+        
+    func applySnapshot() {
+        var snapshot = dataSource.emptySnapshot()
+        let rootItems: [OutlineItem] = ["Root 1", "Root 2", "Root 3", "Root 4", "Root 5"]
+        snapshot.append(rootItems)
+        for item in rootItems {
+            var children: [OutlineItem] = []
+            for i in 0..<5 {
+                children.append(.init("\(item.title).\(i+1)"))
+            }
+            snapshot.append(children, to: item)
+            for child in children {
+                var childs: [OutlineItem] = []
+                for a in 0..<5 {
+                    childs.append(.init("\(child.title).\(a+1)"))
+                }
+                snapshot.append(childs, to: child)
+            }
+        }
+        dataSource.apply(snapshot, .withoutAnimation)
+    }
+}