Add ChatThreadListHeaderViewModifier implementation

Author: nuno-vieira

Sources/StreamChatSwiftUI/ChatThreadList/ChatThreadListHeaderViewModifier.swift

@@ -0,0 +1,22 @@
+//
+// Copyright © 2024 Stream.io Inc. All rights reserved.
+//
+
+import SwiftUI
+
+struct ChatThreadListHeaderViewModifier: ViewModifier {
+    @Injected(\.fonts) private var fonts
+
+    let title: String
+
+    func body(content: Content) -> some View {
+        content
+            .navigationBarTitleDisplayMode(.inline)
+            .toolbar {
+                ToolbarItem(placement: .principal) {
+                    Text(title)
+                        .font(fonts.bodyBold)
+                }
+            }
+    }
+}

Sources/StreamChatSwiftUI/ChatThreadList/ChatThreadListView.swift

@@ -25,7 +25,7 @@ public struct ChatThreadListView<Factory: ViewFactory>: View {
     ///   - viewFactory: The view factory used for creating views used by the thread list.
     ///   - viewModel: The view model instance providing the data. Default view model is created if nil.
     ///   - threadListController: The thread list controller managing the list of threads used as a data source for the view model. Default controller is created if nil.
-    ///   - title: A title used as the navigation bar title.
+    ///   - title: A custom title used as the navigation bar title.
     ///   - onItemTap: A closure for handling a tap on the thread item. Default closure updates the ``ChatThreadListViewModel/selectedThread`` property in the view model.
     ///   - handleTabBarVisibility: True, if TabBar visibility should be automatically updated.
     ///   - embedInNavigationView: True, if the thread list view should be embedded in a navigation stack.
@@ -41,7 +41,7 @@ public struct ChatThreadListView<Factory: ViewFactory>: View {
         viewFactory: Factory = DefaultViewFactory.shared,
         viewModel: ChatThreadListViewModel? = nil,
         threadListController: ChatThreadListController? = nil,
-        title: String = "Threads",
+        title: String? = nil,
         onItemTap: ((ChatThread) -> Void)? = nil,
         handleTabBarVisibility: Bool = true,
         embedInNavigationView: Bool = true
@@ -52,7 +52,7 @@ public struct ChatThreadListView<Factory: ViewFactory>: View {
             )
         )
         self.viewFactory = viewFactory
-        self.title = title
+        self.title = title ?? L10n.Thread.title
         self.handleTabBarVisibility = handleTabBarVisibility
         self.embedInNavigationView = embedInNavigationView
         customOnItemTap = onItemTap
@@ -72,6 +72,7 @@ public struct ChatThreadListView<Factory: ViewFactory>: View {
                     )
                 }
             }
+            .modifier(viewFactory.makeThreadListHeaderViewModifier(title: title))
             .onAppear {
                 if !viewModel.hasLoadedThreads {
                     viewModel.loadThreads()

Sources/StreamChatSwiftUI/DefaultViewFactory.swift

@@ -999,6 +999,10 @@ extension ViewFactory {
         ChatThreadListLoadingView()
     }
 
+    public func makeThreadListHeaderViewModifier(title: String) -> some ViewModifier {
+        ChatThreadListHeaderViewModifier(title: title)
+    }
+
     public func makeThreadListModifier() -> some ViewModifier {
         EmptyViewModifier()
     }

Sources/StreamChatSwiftUI/ViewFactory.swift

@@ -1010,6 +1010,11 @@ public protocol ViewFactory: AnyObject {
     /// Creates a loading view for the thread list.
     func makeThreadListLoadingView() -> ThreadListLoadingView
 
+    associatedtype ThreadListHeaderViewModifier: ViewModifier
+    /// Creates the thread list header view modifier.
+    ///  - Parameter title: the title displayed in the header.
+    func makeThreadListHeaderViewModifier(title: String) -> ThreadListHeaderViewModifier
+
     associatedtype ThreadListModifier: ViewModifier
     /// Returns a view modifier applied to the thread list.
     func makeThreadListModifier() -> ThreadListModifier

StreamChatSwiftUI.xcodeproj/project.pbxproj

@@ -514,6 +514,7 @@
 		AD3AB65A2CB59A660014D4D7 /* MessagePreviewFormatter.swift in Sources */ = {isa = PBXBuildFile; fileRef = AD3AB6592CB59A660014D4D7 /* MessagePreviewFormatter.swift */; };
 		AD3AB65C2CB730090014D4D7 /* Shimmer.swift in Sources */ = {isa = PBXBuildFile; fileRef = AD3AB65B2CB730090014D4D7 /* Shimmer.swift */; };
 		AD3AB65E2CB731360014D4D7 /* ChatThreadListLoadingView.swift in Sources */ = {isa = PBXBuildFile; fileRef = AD3AB65D2CB731360014D4D7 /* ChatThreadListLoadingView.swift */; };
+		AD3AB6602CB7403C0014D4D7 /* ChatThreadListHeaderViewModifier.swift in Sources */ = {isa = PBXBuildFile; fileRef = AD3AB65F2CB7403C0014D4D7 /* ChatThreadListHeaderViewModifier.swift */; };
 		C14A465B284665B100EF498E /* SDKIdentifier.swift in Sources */ = {isa = PBXBuildFile; fileRef = C14A465A284665B100EF498E /* SDKIdentifier.swift */; };
 		E3A1C01C282BAC66002D1E26 /* Sentry in Frameworks */ = {isa = PBXBuildFile; productRef = E3A1C01B282BAC66002D1E26 /* Sentry */; };
 /* End PBXBuildFile section */
@@ -1097,6 +1098,7 @@
 		AD3AB6592CB59A660014D4D7 /* MessagePreviewFormatter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = MessagePreviewFormatter.swift; sourceTree = "<group>"; };
 		AD3AB65B2CB730090014D4D7 /* Shimmer.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Shimmer.swift; sourceTree = "<group>"; };
 		AD3AB65D2CB731360014D4D7 /* ChatThreadListLoadingView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChatThreadListLoadingView.swift; sourceTree = "<group>"; };
+		AD3AB65F2CB7403C0014D4D7 /* ChatThreadListHeaderViewModifier.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChatThreadListHeaderViewModifier.swift; sourceTree = "<group>"; };
 		C14A465A284665B100EF498E /* SDKIdentifier.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SDKIdentifier.swift; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
@@ -2237,6 +2239,7 @@
 				AD3AB6552CB54F720014D4D7 /* ChatThreadListNavigatableItem.swift */,
 				AD3AB6532CB54F310014D4D7 /* ChatThreadListItem.swift */,
 				AD3AB65D2CB731360014D4D7 /* ChatThreadListLoadingView.swift */,
+				AD3AB65F2CB7403C0014D4D7 /* ChatThreadListHeaderViewModifier.swift */,
 				AD2DDA602CB040EA0040B8D4 /* NoThreadsView.swift */,
 			);
 			path = ChatThreadList;
@@ -2602,6 +2605,7 @@
 				84289BEB2807239B00282ABE /* MediaAttachmentsViewModel.swift in Sources */,
 				8465FD902746A95700AF091E /* ComposerHelperViews.swift in Sources */,
 				82D64C142AD7E5B700C5C79E /* ImageDecoderRegistry.swift in Sources */,
+				AD3AB6602CB7403C0014D4D7 /* ChatThreadListHeaderViewModifier.swift in Sources */,
 				82D64C182AD7E5B700C5C79E /* ImageCache.swift in Sources */,
 				849CDD942768E0E1003C7A51 /* MessageActionsResolver.swift in Sources */,
 				84EADEB72B28A17B0046B50C /* RecordingConstants.swift in Sources */,