Deprecated supplementary views.

Author: ekazaev

ChatLayout.podspec

@@ -1,8 +1,8 @@
 Pod::Spec.new do |s|
   s.name             = 'ChatLayout'
-  s.version          = '2.2.3'
+  s.version          = '2.3.0'
   s.summary          = 'Chat UI Library. It uses custom UICollectionViewLayout to provide you full control over the presentation.'
-  s.swift_version    = '6.1'
+  s.swift_version    = '6.2'
 
   s.description      = <<-DESC
 ChatLayout is a Chat UI Library. It uses custom UICollectionViewLayout to provide you full control over the

ChatLayout/Classes/Core/ChatLayoutAttributes.swift

@@ -43,6 +43,7 @@ public final class ChatLayoutAttributes: UICollectionViewLayoutAttributes {
     var id: UUID?
     #endif
 
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     convenience init(kind: ItemKind, indexPath: IndexPath = IndexPath(item: 0, section: 0)) {
         switch kind {
         case .cell:
@@ -54,6 +55,10 @@ public final class ChatLayoutAttributes: UICollectionViewLayoutAttributes {
         }
     }
 
+    convenience init(indexPath: IndexPath = IndexPath(item: 0, section: 0)) {
+        self.init(forCellWith: indexPath)
+    }
+
     /// Returns an exact copy of `ChatLayoutAttributes`.
     public override func copy(with zone: NSZone? = nil) -> Any {
         let copy = super.copy(with: zone) as! ChatLayoutAttributes

ChatLayout/Classes/Core/ChatLayoutDelegate.swift

@@ -30,6 +30,7 @@ public protocol ChatLayoutDelegate: AnyObject {
     ///   - chatLayout: `CollectionViewChatLayout` reference.
     ///   - sectionIndex: Index of the section.
     /// - Returns: `Bool`.
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     func shouldPresentHeader(
         _ chatLayout: CollectionViewChatLayout,
         at sectionIndex: Int
@@ -40,6 +41,7 @@ public protocol ChatLayoutDelegate: AnyObject {
     ///   - chatLayout: `CollectionViewChatLayout` reference.
     ///   - sectionIndex: Index of the section.
     /// - Returns: `Bool`.
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     func shouldPresentFooter(
         _ chatLayout: CollectionViewChatLayout,
         at sectionIndex: Int
@@ -52,6 +54,7 @@ public protocol ChatLayoutDelegate: AnyObject {
     /// - Returns: `Bool`.
     ///
     /// **NB:** This method will be called only if the `ChatLayoutSettings.pinnableItems` is set to `.supplementaryViews`
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     func shouldPinHeaderToVisibleBounds(
         _ chatLayout: CollectionViewChatLayout,
         at sectionIndex: Int
@@ -64,6 +67,7 @@ public protocol ChatLayoutDelegate: AnyObject {
     /// - Returns: `Bool`.
     ///
     /// **NB:** This method will be called only if the `ChatLayoutSettings.pinnableItems` is set to `.supplementaryViews`
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     func shouldPinFooterToVisibleBounds(
         _ chatLayout: CollectionViewChatLayout,
         at sectionIndex: Int
@@ -176,6 +180,7 @@ public protocol ChatLayoutDelegate: AnyObject {
 /// Default extension.
 public extension ChatLayoutDelegate {
     /// Default implementation returns: `false`.
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     func shouldPresentHeader(
         _ chatLayout: CollectionViewChatLayout,
         at sectionIndex: Int
@@ -184,6 +189,7 @@ public extension ChatLayoutDelegate {
     }
 
     /// Default implementation returns: `false`.
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     func shouldPresentFooter(
         _ chatLayout: CollectionViewChatLayout,
         at sectionIndex: Int
@@ -192,6 +198,7 @@ public extension ChatLayoutDelegate {
     }
 
     /// Default implementation returns: `false`.
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     func shouldPinHeaderToVisibleBounds(
         _ chatLayout: CollectionViewChatLayout,
         at sectionIndex: Int
@@ -208,6 +215,7 @@ public extension ChatLayoutDelegate {
     }
 
     /// Default implementation returns: `false`.
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     func shouldPinFooterToVisibleBounds(
         _ chatLayout: CollectionViewChatLayout,
         at sectionIndex: Int

ChatLayout/Classes/Core/ChatLayoutPositionSnapshot.swift

@@ -28,6 +28,7 @@ public struct ChatLayoutPositionSnapshot: Hashable, Sendable {
     public var indexPath: IndexPath
 
     /// Kind of item at the `indexPath`
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     public var kind: ItemKind
 
     /// The edge of the offset.
@@ -42,6 +43,7 @@ public struct ChatLayoutPositionSnapshot: Hashable, Sendable {
     ///   - edge: The edge of the offset.
     ///   - offset: The offset from the `edge`.
     ///   - kind: Kind of item at the `indexPath`
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     public init(
         indexPath: IndexPath,
         kind: ItemKind,
@@ -53,4 +55,20 @@ public struct ChatLayoutPositionSnapshot: Hashable, Sendable {
         self.offset = offset
         self.kind = kind
     }
+
+    /// Constructor
+    /// - Parameters:
+    ///   - indexPath: Item's `IndexPath`
+    ///   - edge: The edge of the offset.
+    ///   - offset: The offset from the `edge`.
+    public init(
+        indexPath: IndexPath,
+        edge: Edge,
+        offset: CGFloat = 0
+    ) {
+        self.indexPath = indexPath
+        self.edge = edge
+        self.offset = offset
+        kind = .cell
+    }
 }

ChatLayout/Classes/Core/ChatLayoutSettings.swift

@@ -18,6 +18,7 @@ public struct ChatLayoutSettings: Equatable, Sendable {
     /// Represents type of pinnable elements in the layout.
     public enum PinneableItems: Equatable, Sendable {
         /// Pin supplementary views (header and/or footer).
+        @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
         case supplementaryViews
         /// Pin cells
         case cells

ChatLayout/Classes/Core/Model/ItemKind.swift

@@ -16,26 +16,30 @@ import UIKit
 /// Type of the item supported by `CollectionViewChatLayout`
 public enum ItemKind: CaseIterable, Hashable, Sendable {
     /// Header item
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     case header
 
     /// Cell item
     case cell
 
     /// Footer item
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     case footer
 
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     init(_ elementKind: String) {
         switch elementKind {
         case UICollectionView.elementKindSectionHeader:
             self = .header
         case UICollectionView.elementKindSectionFooter:
             self = .footer
         default:
-            preconditionFailure("Unsupported supplementary view kind.")
+            preconditionFailure("Unsupported supplementary view kind: \(elementKind).")
         }
     }
 
     /// Returns: `true` if this `ItemKind` is equal to `ItemKind.header` or `ItemKind.footer`
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     public var isSupplementaryItem: Bool {
         switch self {
         case .cell:
@@ -47,6 +51,7 @@ public enum ItemKind: CaseIterable, Hashable, Sendable {
     }
 
     @MainActor
+    @available(*, deprecated, message: "Support for supplementary views is deprecated and will be discontinued in future versions.")
     var supplementaryElementStringType: String {
         switch self {
         case .cell:
@@ -57,4 +62,7 @@ public enum ItemKind: CaseIterable, Hashable, Sendable {
             UICollectionView.elementKindSectionFooter
         }
     }
+
+    /// A collection of all values of this type.
+    public static var allCases: [ItemKind] { [.header, .cell, .footer] }
 }

Example/ChatLayout/AppDelegate.swift

@@ -20,17 +20,6 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         guard !ProcessInfo.isRunningTests else {
             return false
         }
-        if #available(iOS 13.0, *) {
-        } else {
-            let window = UIWindow()
-
-            let chatViewController = ChatViewControllerBuilder().build()
-            let viewController = UINavigationController(rootViewController: chatViewController)
-
-            self.window = window
-            window.rootViewController = viewController
-            window.makeKeyAndVisible()
-        }
         return true
     }
 

Example/ChatLayout/Chat/View/ChatViewController.swift

@@ -105,11 +105,7 @@ final class ChatViewController: UIViewController {
         super.viewDidLoad()
         fpsCounter.delegate = self
         fpsCounter.startTracking()
-        if #available(iOS 13.0, *) {
-            view.backgroundColor = .systemBackground
-        } else {
-            view.backgroundColor = .white
-        }
+        view.backgroundColor = .systemBackground
 
         inputBarView.delegate = self
 
@@ -118,13 +114,8 @@ final class ChatViewController: UIViewController {
         fpsView.layoutMargins = UIEdgeInsets(top: 8, left: 16, bottom: 0, right: 16)
         fpsView.customView.font = .preferredFont(forTextStyle: .caption2)
         fpsView.customView.text = "FPS: unknown"
-        if #available(iOS 13.0, *) {
-            fpsView.backgroundColor = .systemBackground
-            fpsView.customView.textColor = .systemGray3
-        } else {
-            fpsView.backgroundColor = .white
-            fpsView.customView.textColor = .lightGray
-        }
+        fpsView.backgroundColor = .systemBackground
+        fpsView.customView.textColor = .systemGray3
         inputBarView.topStackView.addArrangedSubview(fpsView)
         inputBarView.shouldAnimateTextDidChangeLayout = true
         navigationItem.leftBarButtonItem = UIBarButtonItem(title: "Show Keyboard", style: .plain, target: self, action: #selector(ChatViewController.showHideKeyboard))
@@ -353,7 +344,11 @@ extension ChatViewController: UIScrollViewDelegate {
                 collectionView.contentOffset = CGPoint(x: collectionView.contentOffset.x, y: initialOffset + (delta * percentage))
                 if percentage == 1.0 {
                     animator = nil
-                    let positionSnapshot = ChatLayoutPositionSnapshot(indexPath: IndexPath(item: 0, section: 0), kind: .footer, edge: .bottom)
+                    guard let lastSection = dataSource.sections.last else {
+                        collectionView.reloadData()
+                        return
+                    }
+                    let positionSnapshot = ChatLayoutPositionSnapshot(indexPath: IndexPath(item: lastSection.cells.count - 1, section: dataSource.sections.count - 1), edge: .bottom)
                     chatLayout.restoreContentOffset(with: positionSnapshot)
                     currentInterfaceActions.options.remove(.scrollingToBottom)
                     completion?()
@@ -516,7 +511,11 @@ extension ChatViewController: ChatControllerDelegate {
                     return false
                 },
                 onInterruptedReload: {
-                    let positionSnapshot = ChatLayoutPositionSnapshot(indexPath: IndexPath(item: 0, section: sections.count - 1), kind: .footer, edge: .bottom)
+                    guard let lastSection = sections.last else {
+                        self.collectionView.reloadData()
+                        return
+                    }
+                    let positionSnapshot = ChatLayoutPositionSnapshot(indexPath: IndexPath(item: lastSection.cells.count - 1, section: sections.count - 1), edge: .bottom)
                     self.collectionView.reloadData()
                     // We want so that user on reload appeared at the very bottom of the layout
                     self.chatLayout.restoreContentOffset(with: positionSnapshot)