Added possibility to inject custom footer view in the channel list (#35)

Author: martinmitrevski

Sources/StreamChatSwiftUI/ChatChannelList/ChatChannelList.swift

@@ -163,6 +163,8 @@ struct ChannelsLazyVStack<Factory: ViewFactory>: View {
 
                 factory.makeChannelListDividerItem()
             }
+            
+            factory.makeChannelListFooterView()
         }
     }
 }

Sources/StreamChatSwiftUI/ChatChannelList/ChatChannelListView.swift

@@ -97,6 +97,8 @@ public struct ChatChannelListView<Factory: ViewFactory>: View {
                                     leadingSwipeButtonTapped: { _ in }
                                 )
                             }
+                            
+                            viewFactory.makeChannelListStickyFooterView()
                         }
                     }
                 }

Sources/StreamChatSwiftUI/DefaultViewFactory.swift

@@ -136,6 +136,14 @@ extension ViewFactory {
         SearchBar(text: searchText)
     }
 
+    public func makeChannelListFooterView() -> some View {
+        EmptyView()
+    }
+    
+    public func makeChannelListStickyFooterView() -> some View {
+        EmptyView()
+    }
+    
     public func makeChannelListSearchResultItem(
         searchResult: ChannelSelectionInfo,
         onlineIndicatorShown: Bool,

Sources/StreamChatSwiftUI/ViewFactory.swift

@@ -139,6 +139,16 @@ public protocol ViewFactory: AnyObject {
         searchText: Binding<String>
     ) -> ChannelListTopViewType
 
+    associatedtype ChannelListFooterViewType: View
+    /// Creates the view shown at the bottom of the channel list.
+    /// - Returns: view shown at the bottom of the channel list.
+    func makeChannelListFooterView() -> ChannelListFooterViewType
+    
+    associatedtype ChannelListStickyFooterViewType: View
+    /// Creates the view always visible at the bottom of the channel list.
+    /// - Returns: view shown at the bottom of the channel list.
+    func makeChannelListStickyFooterView() -> ChannelListStickyFooterViewType
+    
     associatedtype ChannelListSearchResultItem: View
     /// Creates the search result item in the channel list.
     /// - Parameters:

StreamChatSwiftUITests/Tests/Utils/ViewFactory_Tests.swift

@@ -556,6 +556,28 @@ class ViewFactory_Tests: StreamChatTestCase {
         // Then
         XCTAssert(view is ReactionsUsersView)
     }
+    
+    func test_viewFactory_makeChannelListFooterView() {
+        // Given
+        let viewFactory = DefaultViewFactory.shared
+        
+        // When
+        let view = viewFactory.makeChannelListFooterView()
+        
+        // Then
+        XCTAssert(view is EmptyView)
+    }
+    
+    func test_viewFactory_makeChannelListStickyFooterView() {
+        // Given
+        let viewFactory = DefaultViewFactory.shared
+        
+        // When
+        let view = viewFactory.makeChannelListStickyFooterView()
+        
+        // Then
+        XCTAssert(view is EmptyView)
+    }
 }
 
 extension ChannelAction: Equatable {

docusaurus/docs/iOS/swiftui/components/helper-views.md

@@ -131,6 +131,44 @@ public func makeChannelListDividerItem() -> some View {
 
 If you want your list to not have a divider whatsoever, you can simply return an `EmptyView` here.
 
+## Changing the Top Bar
+
+By default, the SwiftUI SDK shows a search bar at the top of the channel list. This component lets you search through messages matching the search term inside the channels. When you tap on a search result, the corresponding channel is opened, automatically scrolling to the searched message.
+
+In order to replace this component with your own (or completely remove it by returning an `EmptyView`), you need to implement the `makeChannelListTopView` method:
+
+```swift
+func makeChannelListTopView(
+    searchText: Binding<String>
+) -> some View {
+    SearchBar(text: searchText)
+}
+```
+
+In this method, a binding of the search text is provided, in case you want to implement your custom search bar.
+
+## Changing the Footer View
+
+You can add a view at the bottom of the channel list. There are two options here - a footer shown when you scroll to the end of the channel list and a sticky footer that's always visible.
+
+To add a footer at the bottom of the channel list, you need to implement the `makeChannelListFooterView` method:
+
+```swift
+public func makeChannelListFooterView() -> some View {
+    SomeFooterView()
+}
+```
+
+To add a sticky footer, always visible at the bottom of the channel list, you need to implement the `makeChannelListStickyFooterView` method:
+
+```swift
+func makeChannelListStickyFooterView() -> some View {
+    SomeStickyFooterView()
+}
+```
+
+Both methods return an `EmptyView` by default.
+
 Remember to always inject your custom view factory in your view hierarchy:
 
 ```swift