Skip to content

refactor: Make CollectionViewContainerDelegate type-safe #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jbmorley merged 1 commit into from
Jan 27, 2026
Merged

refactor: Make CollectionViewContainerDelegate type-safe #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 27 additions & 21 deletions Sources/SelectableCollectionView/Views/CollectionViewContainer.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,22 +26,26 @@ import SwiftUI

import SelectableCollectionViewMacResources

#warning("TODO: Rename element to ID to avoid confusion?")

protocol CollectionViewContainerDelegate: NSObject {
func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
menuItemsForElements elements: Set<Element>) -> [MenuItem]
func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
contentForElement element: Element) -> Content?
func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
didUpdateSelection selection: Set<Element>)
func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
didDoubleClickSelection selection: Set<Element>)

func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
keyDown event: NSEvent) -> Bool
func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
keyUp event: NSEvent) -> Bool
// TODO: Rename element to ID to avoid confusion?

public protocol CollectionViewContainerDelegate: NSObject {

associatedtype Element: Hashable & Identifiable
associatedtype CellContent: View

func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, CellContent, Self>,
menuItemsForElements elements: Set<Element>) -> [MenuItem]
func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, CellContent, Self>,
contentForElement element: Element) -> CellContent?
func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, CellContent, Self>,
didUpdateSelection selection: Set<Element>)
func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, CellContent, Self>,
didDoubleClickSelection selection: Set<Element>)

func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, CellContent, Self>,
keyDown event: NSEvent) -> Bool
func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, CellContent, Self>,
keyUp event: NSEvent) -> Bool
}

class CustomScrollView: NSScrollView {
Expand All @@ -64,12 +68,14 @@ class CustomScrollView: NSScrollView {

}

public class CollectionViewContainer<Element: Hashable, Content: View>: NSView,
NSCollectionViewDelegate,
CollectionViewInteractionDelegate,
NSCollectionViewDelegateFlowLayout {
public class CollectionViewContainer<Element: Hashable, Content: View, Delegate: CollectionViewContainerDelegate>
: NSView,
NSCollectionViewDelegate,
CollectionViewInteractionDelegate,
NSCollectionViewDelegateFlowLayout where Delegate.Element == Element,
Delegate.CellContent == Content {

weak var delegate: CollectionViewContainerDelegate?
weak var delegate: Delegate?

enum Section {
case none
Expand Down
60 changes: 24 additions & 36 deletions Sources/SelectableCollectionView/Views/CollectionViewContainerHost.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,18 @@
import SwiftUI

public struct CollectionViewContainerHost<Data: RandomAccessCollection,
Content: View>: NSViewRepresentable where Data.Element: Identifiable,
Data.Element: Hashable,
Data.Element.ID: Hashable {
Content: View>
: NSViewRepresentable where Data.Element: Identifiable,
Data.Element: Hashable,
Data.Element.ID: Hashable {

public typealias ID = Data.Element.ID
public typealias Element = Data.Element

public class Coordinator: NSObject, CollectionViewContainerDelegate {
public final class Coordinator: NSObject, CollectionViewContainerDelegate {

public typealias Element = Data.Element
public typealias CellContent = Content

var parent: CollectionViewContainerHost<Data, Content>
var collectionViewLayoutHash: Int = 0
Expand All @@ -39,50 +43,36 @@ public struct CollectionViewContainerHost<Data: RandomAccessCollection,
self.parent = parent
}

func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
menuItemsForElements elements: Set<Element>) -> [MenuItem] where Element : Hashable, Content : View {
guard let elements = elements as? Set<Data.Element> else {
return []
}
public func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, Content, Coordinator>,
menuItemsForElements elements: Set<Element>) -> [MenuItem] {
let ids = Set(elements.map { $0.id })
return parent.contextMenu(ids)
}

func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
contentForElement element: Element) -> Content? where Element : Hashable, Content : View {
#warning("TODO: These guards shouldn't be necessary?")
guard let element = element as? Data.Element,
let content = parent.itemContent(element) as? Content else {
return nil
}
return content
public func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, Content, Coordinator>,
contentForElement element: Element) -> Content? {
return parent.itemContent(element)
}

func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
didUpdateSelection selection: Set<Element>) where Element : Hashable, Content : View {
guard let selection = selection as? Set<Data.Element> else {
return
}
public func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, Content, Coordinator>,
didUpdateSelection selection: Set<Element>) {
let ids = Set(selection.map { $0.id })
parent.selection.wrappedValue = ids
}

func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
didDoubleClickSelection selection: Set<Element>) where Element : Hashable, Content : View {
guard let selection = selection as? Set<Data.Element> else {
return
}
public func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, Content, Coordinator>,
didDoubleClickSelection selection: Set<Element>) {
let ids = Set(selection.map { $0.id })
parent.primaryAction(ids)
}

func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
keyDown event: NSEvent) -> Bool where Element : Hashable, Content : View {
public func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, Content, Coordinator>,
keyDown event: NSEvent) -> Bool {
return parent.keyDown(event)
}

func collectionViewContainer<Element, Content>(_ collectionViewContainer: CollectionViewContainer<Element, Content>,
keyUp event: NSEvent) -> Bool where Element : Hashable, Content : View {
public func collectionViewContainer(_ collectionViewContainer: CollectionViewContainer<Element, Content, Coordinator>,
keyUp event: NSEvent) -> Bool {
return parent.keyUp(event)
}

Expand Down Expand Up @@ -119,15 +109,14 @@ public struct CollectionViewContainerHost<Data: RandomAccessCollection,
return Coordinator(self)
}

public func makeNSView(context: Context) -> CollectionViewContainer<Element, Content> {
let collectionView = CollectionViewContainer<Element, Content>(layout: layout.makeLayout())
public func makeNSView(context: Context) -> CollectionViewContainer<Element, Content, Coordinator> {
let collectionView = CollectionViewContainer<Element, Content, Coordinator>(layout: layout.makeLayout())
collectionView.delegate = context.coordinator
return collectionView
}

public func updateNSView(_ collectionView: CollectionViewContainer<Element, Content>, context: Context) {
public func updateNSView(_ collectionView: CollectionViewContainer<Element, Content, Coordinator>, context: Context) {
context.coordinator.parent = self
#warning("TODO: We shouldn't need to copy this into an array?")
let selectedElements = items.filter { selection.wrappedValue.contains($0.id) }
collectionView.update(Array(items), selection: Set(selectedElements))

Expand All @@ -137,7 +126,6 @@ public struct CollectionViewContainerHost<Data: RandomAccessCollection,
context.coordinator.collectionViewLayoutHash = layout.hashValue
}
}

}

#endif