Skip to content

feat!: Stream incremental changes directly to the collection view #30

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

Open
jbmorley wants to merge 22 commits into
base: main
Choose a base branch
from
Open

feat!: Stream incremental changes directly to the collection view #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
edce4c8
feat: Stream incremental changes directly to the collection view
jbmorley Jan 27, 2026
787ee20
Remove unnecessary comment
jbmorley Jan 27, 2026
5b84a24
Make it possible to toggle streaming mode
jbmorley Jan 27, 2026
0c53839
Send update when the proxy connects
jbmorley Jan 27, 2026
3c88770
Rename `updateItems` to `setItems`
jbmorley Jan 27, 2026
3266b2d
Update the copyright and simplify the comments
jbmorley Jan 27, 2026
901aa35
Update copyright again
jbmorley Jan 27, 2026
b0faef8
Support removing items
jbmorley Jan 27, 2026
ec036cb
Remove logging
jbmorley Jan 27, 2026
ec35e20
Support moving items
jbmorley Jan 28, 2026
5faf2d8
Submenu and fix cell updates
jbmorley Jan 28, 2026
813cce2
Add comments
jbmorley Jan 28, 2026
83c4c29
Address compiler warnings
jbmorley Jan 28, 2026
1b1534a
Start using identifiers internally
jbmorley Jan 28, 2026
01dbdea
Remove the `Hashable` constraint on `Element`
jbmorley Jan 28, 2026
6f78677
Test update behavior (and fix update bugs)
jbmorley Jan 28, 2026
f36d6f6
Small tidy up
jbmorley Jan 28, 2026
971c814
Small documentation improvement.
jbmorley Jan 28, 2026
cd1034a
Remove more `Hashable` constraints
jbmorley Jan 28, 2026
6039c63
Remove todo
jbmorley Jan 28, 2026
1202b7c
Guard against no-op moves
jbmorley Jan 28, 2026
83f7b31
Remove lingering todo
jbmorley Jan 28, 2026
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
156 changes: 21 additions & 135 deletions Example/Example.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,11 @@
archiveVersion = 1;
classes = {
};
objectVersion = 56;
objectVersion = 70;
objects = {

/* Begin PBXBuildFile section */
D82594FC28AA3E3500A36359 /* Model.swift in Sources */ = {isa = PBXBuildFile; fileRef = D82594FB28AA3E3500A36359 /* Model.swift */; };
D82594FE28AA3EA200A36359 /* Cell.swift in Sources */ = {isa = PBXBuildFile; fileRef = D82594FD28AA3EA200A36359 /* Cell.swift */; };
D825950128AA3F7800A36359 /* Item.swift in Sources */ = {isa = PBXBuildFile; fileRef = D825950028AA3F7800A36359 /* Item.swift */; };
D825950428AA443A00A36359 /* ItemsToolbar.swift in Sources */ = {isa = PBXBuildFile; fileRef = D825950328AA443A00A36359 /* ItemsToolbar.swift */; };
D825950628AA45ED00A36359 /* SelectionToolbar.swift in Sources */ = {isa = PBXBuildFile; fileRef = D825950528AA45ED00A36359 /* SelectionToolbar.swift */; };
D825950928AA46C000A36359 /* StateToolbar.swift in Sources */ = {isa = PBXBuildFile; fileRef = D825950828AA46C000A36359 /* StateToolbar.swift */; };
D841632D28AA26FC007812D8 /* ExampleApp.swift in Sources */ = {isa = PBXBuildFile; fileRef = D841632C28AA26FC007812D8 /* ExampleApp.swift */; };
D841632F28AA26FC007812D8 /* ContentView.swift in Sources */ = {isa = PBXBuildFile; fileRef = D841632E28AA26FC007812D8 /* ContentView.swift */; };
D841633128AA26FE007812D8 /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = D841633028AA26FE007812D8 /* Assets.xcassets */; };
D841633428AA26FE007812D8 /* Preview Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = D841633328AA26FE007812D8 /* Preview Assets.xcassets */; };
D841633F28AA26FE007812D8 /* ExampleTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D841633E28AA26FE007812D8 /* ExampleTests.swift */; };
D841634928AA26FE007812D8 /* ExampleUITests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D841634828AA26FE007812D8 /* ExampleUITests.swift */; };
D841634B28AA26FE007812D8 /* ExampleUITestsLaunchTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D841634A28AA26FE007812D8 /* ExampleUITestsLaunchTests.swift */; };
D841635A28AA2819007812D8 /* Color.swift in Sources */ = {isa = PBXBuildFile; fileRef = D841635928AA2818007812D8 /* Color.swift */; };
D841635D28AA283B007812D8 /* SelectableCollectionView in Frameworks */ = {isa = PBXBuildFile; productRef = D841635C28AA283B007812D8 /* SelectableCollectionView */; };
D8C5D20728AACB2B001443BA /* LayoutMode.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8C5D20628AACB2B001443BA /* LayoutMode.swift */; };
D8C5D20928AACB75001443BA /* LayoutToolbar.swift in Sources */ = {isa = PBXBuildFile; fileRef = D8C5D20828AACB75001443BA /* LayoutToolbar.swift */; };
/* End PBXBuildFile section */

/* Begin PBXContainerItemProxy section */
Expand All @@ -44,29 +28,18 @@
/* End PBXContainerItemProxy section */

/* Begin PBXFileReference section */
D82594FB28AA3E3500A36359 /* Model.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Model.swift; sourceTree = "<group>"; };
D82594FD28AA3EA200A36359 /* Cell.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Cell.swift; sourceTree = "<group>"; };
D825950028AA3F7800A36359 /* Item.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Item.swift; sourceTree = "<group>"; };
D825950328AA443A00A36359 /* ItemsToolbar.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ItemsToolbar.swift; sourceTree = "<group>"; };
D825950528AA45ED00A36359 /* SelectionToolbar.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SelectionToolbar.swift; sourceTree = "<group>"; };
D825950828AA46C000A36359 /* StateToolbar.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = StateToolbar.swift; sourceTree = "<group>"; };
D841632928AA26FC007812D8 /* Example.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Example.app; sourceTree = BUILT_PRODUCTS_DIR; };
D841632C28AA26FC007812D8 /* ExampleApp.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExampleApp.swift; sourceTree = "<group>"; };
D841632E28AA26FC007812D8 /* ContentView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ContentView.swift; sourceTree = "<group>"; };
D841633028AA26FE007812D8 /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
D841633328AA26FE007812D8 /* Preview Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = "Preview Assets.xcassets"; sourceTree = "<group>"; };
D841633528AA26FE007812D8 /* Example.entitlements */ = {isa = PBXFileReference; lastKnownFileType = text.plist.entitlements; path = Example.entitlements; sourceTree = "<group>"; };
D841633A28AA26FE007812D8 /* ExampleTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = ExampleTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
D841633E28AA26FE007812D8 /* ExampleTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExampleTests.swift; sourceTree = "<group>"; };
D841634428AA26FE007812D8 /* ExampleUITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = ExampleUITests.xctest; sourceTree = BUILT_PRODUCTS_DIR; };
D841634828AA26FE007812D8 /* ExampleUITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExampleUITests.swift; sourceTree = "<group>"; };
D841634A28AA26FE007812D8 /* ExampleUITestsLaunchTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ExampleUITestsLaunchTests.swift; sourceTree = "<group>"; };
D841635828AA2726007812D8 /* SelectableCollectionView */ = {isa = PBXFileReference; lastKnownFileType = wrapper; name = SelectableCollectionView; path = ..; sourceTree = "<group>"; };
D841635928AA2818007812D8 /* Color.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Color.swift; sourceTree = "<group>"; };
D8C5D20628AACB2B001443BA /* LayoutMode.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LayoutMode.swift; sourceTree = "<group>"; };
D8C5D20828AACB75001443BA /* LayoutToolbar.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LayoutToolbar.swift; sourceTree = "<group>"; };
/* End PBXFileReference section */

/* Begin PBXFileSystemSynchronizedRootGroup section */
D8D376C82F2898870033AB3C /* Example */ = {isa = PBXFileSystemSynchronizedRootGroup; explicitFileTypes = {}; explicitFolders = (); path = Example; sourceTree = "<group>"; };
D8D376D82F28988B0033AB3C /* ExampleTests */ = {isa = PBXFileSystemSynchronizedRootGroup; explicitFileTypes = {}; explicitFolders = (); path = ExampleTests; sourceTree = "<group>"; };
D8D376DC2F28988D0033AB3C /* ExampleUITests */ = {isa = PBXFileSystemSynchronizedRootGroup; explicitFileTypes = {}; explicitFolders = (); path = ExampleUITests; sourceTree = "<group>"; };
/* End PBXFileSystemSynchronizedRootGroup section */

/* Begin PBXFrameworksBuildPhase section */
D841632628AA26FC007812D8 /* Frameworks */ = {
isa = PBXFrameworksBuildPhase;
Expand All @@ -93,51 +66,13 @@
/* End PBXFrameworksBuildPhase section */

/* Begin PBXGroup section */
D82594FA28AA3E0D00A36359 /* Extensions */ = {
isa = PBXGroup;
children = (
D841635928AA2818007812D8 /* Color.swift */,
);
path = Extensions;
sourceTree = "<group>";
};
D82594FF28AA3F6C00A36359 /* Model */ = {
isa = PBXGroup;
children = (
D825950028AA3F7800A36359 /* Item.swift */,
D8C5D20628AACB2B001443BA /* LayoutMode.swift */,
D82594FB28AA3E3500A36359 /* Model.swift */,
);
path = Model;
sourceTree = "<group>";
};
D825950228AA439300A36359 /* Toolbars */ = {
isa = PBXGroup;
children = (
D825950328AA443A00A36359 /* ItemsToolbar.swift */,
D8C5D20828AACB75001443BA /* LayoutToolbar.swift */,
D825950528AA45ED00A36359 /* SelectionToolbar.swift */,
D825950828AA46C000A36359 /* StateToolbar.swift */,
);
path = Toolbars;
sourceTree = "<group>";
};
D825950728AA469600A36359 /* Views */ = {
isa = PBXGroup;
children = (
D82594FD28AA3EA200A36359 /* Cell.swift */,
D841632E28AA26FC007812D8 /* ContentView.swift */,
);
path = Views;
sourceTree = "<group>";
};
D841632028AA26FC007812D8 = {
isa = PBXGroup;
children = (
D841635728AA2726007812D8 /* Packages */,
D841632B28AA26FC007812D8 /* Example */,
D841633D28AA26FE007812D8 /* ExampleTests */,
D841634728AA26FE007812D8 /* ExampleUITests */,
D8D376C82F2898870033AB3C /* Example */,
D8D376D82F28988B0033AB3C /* ExampleTests */,
D8D376DC2F28988D0033AB3C /* ExampleUITests */,
D841632A28AA26FC007812D8 /* Products */,
D841635B28AA283B007812D8 /* Frameworks */,
);
Expand All @@ -153,46 +88,6 @@
name = Products;
sourceTree = "<group>";
};
D841632B28AA26FC007812D8 /* Example */ = {
isa = PBXGroup;
children = (
D841633528AA26FE007812D8 /* Example.entitlements */,
D841632C28AA26FC007812D8 /* ExampleApp.swift */,
D841633028AA26FE007812D8 /* Assets.xcassets */,
D82594FA28AA3E0D00A36359 /* Extensions */,
D82594FF28AA3F6C00A36359 /* Model */,
D841633228AA26FE007812D8 /* Preview Content */,
D825950228AA439300A36359 /* Toolbars */,
D825950728AA469600A36359 /* Views */,
);
path = Example;
sourceTree = "<group>";
};
D841633228AA26FE007812D8 /* Preview Content */ = {
isa = PBXGroup;
children = (
D841633328AA26FE007812D8 /* Preview Assets.xcassets */,
);
path = "Preview Content";
sourceTree = "<group>";
};
D841633D28AA26FE007812D8 /* ExampleTests */ = {
isa = PBXGroup;
children = (
D841633E28AA26FE007812D8 /* ExampleTests.swift */,
);
path = ExampleTests;
sourceTree = "<group>";
};
D841634728AA26FE007812D8 /* ExampleUITests */ = {
isa = PBXGroup;
children = (
D841634828AA26FE007812D8 /* ExampleUITests.swift */,
D841634A28AA26FE007812D8 /* ExampleUITestsLaunchTests.swift */,
);
path = ExampleUITests;
sourceTree = "<group>";
};
D841635728AA2726007812D8 /* Packages */ = {
isa = PBXGroup;
children = (
Expand Down Expand Up @@ -223,6 +118,9 @@
);
dependencies = (
);
fileSystemSynchronizedGroups = (
D8D376C82F2898870033AB3C /* Example */,
);
name = Example;
packageProductDependencies = (
D841635C28AA283B007812D8 /* SelectableCollectionView */,
Expand All @@ -244,6 +142,9 @@
dependencies = (
D841633C28AA26FE007812D8 /* PBXTargetDependency */,
);
fileSystemSynchronizedGroups = (
D8D376D82F28988B0033AB3C /* ExampleTests */,
);
name = ExampleTests;
productName = ExampleTests;
productReference = D841633A28AA26FE007812D8 /* ExampleTests.xctest */;
Expand All @@ -262,6 +163,9 @@
dependencies = (
D841634628AA26FE007812D8 /* PBXTargetDependency */,
);
fileSystemSynchronizedGroups = (
D8D376DC2F28988D0033AB3C /* ExampleUITests */,
);
name = ExampleUITests;
productName = ExampleUITests;
productReference = D841634428AA26FE007812D8 /* ExampleUITests.xctest */;
Expand Down Expand Up @@ -315,8 +219,6 @@
isa = PBXResourcesBuildPhase;
buildActionMask = 2147483647;
files = (
D841633428AA26FE007812D8 /* Preview Assets.xcassets in Resources */,
D841633128AA26FE007812D8 /* Assets.xcassets in Resources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand All @@ -341,34 +243,20 @@
isa = PBXSourcesBuildPhase;
buildActionMask = 2147483647;
files = (
D82594FE28AA3EA200A36359 /* Cell.swift in Sources */,
D841632F28AA26FC007812D8 /* ContentView.swift in Sources */,
D825950628AA45ED00A36359 /* SelectionToolbar.swift in Sources */,
D841632D28AA26FC007812D8 /* ExampleApp.swift in Sources */,
D8C5D20928AACB75001443BA /* LayoutToolbar.swift in Sources */,
D8C5D20728AACB2B001443BA /* LayoutMode.swift in Sources */,
D825950428AA443A00A36359 /* ItemsToolbar.swift in Sources */,
D841635A28AA2819007812D8 /* Color.swift in Sources */,
D825950928AA46C000A36359 /* StateToolbar.swift in Sources */,
D825950128AA3F7800A36359 /* Item.swift in Sources */,
D82594FC28AA3E3500A36359 /* Model.swift in Sources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
D841633628AA26FE007812D8 /* Sources */ = {
isa = PBXSourcesBuildPhase;
buildActionMask = 2147483647;
files = (
D841633F28AA26FE007812D8 /* ExampleTests.swift in Sources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
D841634028AA26FE007812D8 /* Sources */ = {
isa = PBXSourcesBuildPhase;
buildActionMask = 2147483647;
files = (
D841634928AA26FE007812D8 /* ExampleUITests.swift in Sources */,
D841634B28AA26FE007812D8 /* ExampleUITestsLaunchTests.swift in Sources */,
);
runOnlyForDeploymentPostprocessing = 0;
};
Expand Down Expand Up @@ -519,6 +407,7 @@
"$(inherited)",
"@executable_path/../Frameworks",
);
MACOSX_DEPLOYMENT_TARGET = 14.0;
MARKETING_VERSION = 1.0;
PRODUCT_BUNDLE_IDENTIFIER = uk.co.inseven.Example;
PRODUCT_NAME = "$(TARGET_NAME)";
Expand All @@ -544,6 +433,7 @@
"$(inherited)",
"@executable_path/../Frameworks",
);
MACOSX_DEPLOYMENT_TARGET = 14.0;
MARKETING_VERSION = 1.0;
PRODUCT_BUNDLE_IDENTIFIER = uk.co.inseven.Example;
PRODUCT_NAME = "$(TARGET_NAME)";
Expand All @@ -555,7 +445,6 @@
D841635228AA26FE007812D8 /* Debug */ = {
isa = XCBuildConfiguration;
buildSettings = {
ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
BUNDLE_LOADER = "$(TEST_HOST)";
CODE_SIGN_STYLE = Automatic;
CURRENT_PROJECT_VERSION = 1;
Expand All @@ -573,7 +462,6 @@
D841635328AA26FE007812D8 /* Release */ = {
isa = XCBuildConfiguration;
buildSettings = {
ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
BUNDLE_LOADER = "$(TEST_HOST)";
CODE_SIGN_STYLE = Automatic;
CURRENT_PROJECT_VERSION = 1;
Expand All @@ -591,7 +479,6 @@
D841635528AA26FE007812D8 /* Debug */ = {
isa = XCBuildConfiguration;
buildSettings = {
ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
CODE_SIGN_STYLE = Automatic;
CURRENT_PROJECT_VERSION = 1;
GENERATE_INFOPLIST_FILE = YES;
Expand All @@ -607,7 +494,6 @@
D841635628AA26FE007812D8 /* Release */ = {
isa = XCBuildConfiguration;
buildSettings = {
ALWAYS_EMBED_SWIFT_STANDARD_LIBRARIES = YES;
CODE_SIGN_STYLE = Automatic;
CURRENT_PROJECT_VERSION = 1;
GENERATE_INFOPLIST_FILE = YES;
Expand Down
95 changes: 95 additions & 0 deletions Example/Example/Model/Creator.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
// Copyright (c) 2022-2026 Jason Morley
//
// 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.

import Combine
import SwiftUI
import SelectableCollectionView

@Observable
class Creator: CollectionViewStreamingCollection {

enum Operation: CaseIterable {
case add
case remove
case move
case update

static func random() -> Self {
return allCases.randomElement()!
}
}

private var collectionView: (any CollectionViewProxy<Item>)? = nil
public var items: [Item] = []
private var isActive: Bool = true

func run() {
DispatchQueue.main.asyncAfter(deadline: .now() + 0.1) { [weak self] in
guard let self else {
return
}
defer { self.run() }

switch Operation.random() {
case .add:
let item = Item()
let index = Int.random(in: 0..<items.count + 1)
items.insert(item, at: index)
collectionView?.insertItem(item, atIndex: index, items: Array(items))
case .remove:
guard !items.isEmpty else {
return
}
let index = Int.random(in: 0..<items.count)
let item = items.remove(at: index)
collectionView?.removeItemWithId(item.id, atIndex: index, items: Array(items))
case .move:
guard !items.isEmpty else {
return
}
let from = Int.random(in: 0..<items.count)
let to = Int.random(in: 0...items.count) // Apple's move implementation _always_ treats it as inserting before this index.
let item = items[from]
items.move(fromOffsets: [from], toOffset: to)
collectionView?.moveItem(item, toIndex: to, items: Array(items))
case .update:
guard !items.isEmpty else {
return
}
let index = Int.random(in: 0..<items.count)
var item = items[index]
item.count += 1
items[index] = item // We currently need to replace this because it's a struct.
collectionView?.updateItem(item, atIndex: index, items: items)
}

}
}

init() {
run()
}

func collectionViewDidConnect(_ collectionView: (any CollectionViewProxy<Item>)?) {
self.collectionView = collectionView
self.collectionView?.setItems(Array(items))
}

}
3 changes: 2 additions & 1 deletion Example/Example/Model/Item.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@

import SwiftUI

struct Item: Hashable, Identifiable {
class Item: Identifiable {
let id = UUID()
let color: Color = .random
var count: Int = 0
}
Loading