Updated documentation

ekazaev · ekazaev · commit 6b4ec0615fea · 2023-04-07T15:43:35.000+01:00
diff --git a/ChatLayout/Classes/Core/CollectionViewChatLayout.swift b/ChatLayout/Classes/Core/CollectionViewChatLayout.swift
@@ -13,9 +13,11 @@
 import Foundation
 import UIKit
 
-/// A collection view layout that can display items in a grid similar to `UITableView` but aligning them
-/// to the leading or trailing edge of the `UICollectionView`. Helps to maintain chat like behavior by keeping
-/// content offset from the bottom constant. Can deal with autosizing cells and supplementary views.
+/// A collection view layout designed to display items in a grid similar to `UITableView`, while aligning them to the
+/// leading or trailing edge of the `UICollectionView`. This layout facilitates chat-like behavior by maintaining
+/// a constant content offset from the bottom. Additionally, it is capable of handling autosizing cells and
+/// supplementary views.
+///
 /// ### Custom Properties:
 /// `CollectionViewChatLayout.delegate`
 ///
@@ -433,7 +435,8 @@ public final class CollectionViewChatLayout: UICollectionViewLayout {
     }
 
     /// Retrieves the layout attributes for the specified supplementary view.
-    public override func layoutAttributesForSupplementaryView(ofKind elementKind: String, at indexPath: IndexPath) -> UICollectionViewLayoutAttributes? {
+    public override func layoutAttributesForSupplementaryView(ofKind elementKind: String,
+                                                              at indexPath: IndexPath) -> UICollectionViewLayoutAttributes? {
         guard !dontReturnAttributes else {
             return nil
         }
@@ -479,7 +482,8 @@ public final class CollectionViewChatLayout: UICollectionViewLayout {
     // MARK: Context Invalidation
 
     /// Asks the layout object if changes to a self-sizing cell require a layout update.
-    public override func shouldInvalidateLayout(forPreferredLayoutAttributes preferredAttributes: UICollectionViewLayoutAttributes, withOriginalAttributes originalAttributes: UICollectionViewLayoutAttributes) -> Bool {
+    public override func shouldInvalidateLayout(forPreferredLayoutAttributes preferredAttributes: UICollectionViewLayoutAttributes,
+                                                withOriginalAttributes originalAttributes: UICollectionViewLayoutAttributes) -> Bool {
         let preferredAttributesItemPath = preferredAttributes.indexPath.itemPath
         guard let preferredMessageAttributes = preferredAttributes as? ChatLayoutAttributes,
               let item = controller.item(for: preferredAttributesItemPath, kind: preferredMessageAttributes.kind, at: state) else {
@@ -492,7 +496,8 @@ public final class CollectionViewChatLayout: UICollectionViewLayout {
     }
 
     /// Retrieves a context object that identifies the portions of the layout that should change in response to dynamic cell changes.
-    public override func invalidationContext(forPreferredLayoutAttributes preferredAttributes: UICollectionViewLayoutAttributes, withOriginalAttributes originalAttributes: UICollectionViewLayoutAttributes) -> UICollectionViewLayoutInvalidationContext {
+    public override func invalidationContext(forPreferredLayoutAttributes preferredAttributes: UICollectionViewLayoutAttributes,
+                                             withOriginalAttributes originalAttributes: UICollectionViewLayoutAttributes) -> UICollectionViewLayoutInvalidationContext {
         guard let preferredMessageAttributes = preferredAttributes as? ChatLayoutAttributes else {
             return super.invalidationContext(forPreferredLayoutAttributes: preferredAttributes, withOriginalAttributes: originalAttributes)
         }
@@ -789,7 +794,8 @@ public final class CollectionViewChatLayout: UICollectionViewLayout {
     // MARK: - Supplementary View Appearance Animation
 
     /// Retrieves the starting layout information for a supplementary view being inserted into the collection view.
-    public override func initialLayoutAttributesForAppearingSupplementaryElement(ofKind elementKind: String, at elementIndexPath: IndexPath) -> UICollectionViewLayoutAttributes? {
+    public override func initialLayoutAttributesForAppearingSupplementaryElement(ofKind elementKind: String,
+                                                                                 at elementIndexPath: IndexPath) -> UICollectionViewLayoutAttributes? {
         var attributes: ChatLayoutAttributes?
 
         let kind = ItemKind(elementKind)
@@ -828,7 +834,8 @@ public final class CollectionViewChatLayout: UICollectionViewLayout {
     }
 
     /// Retrieves the final layout information for a supplementary view that is about to be removed from the collection view.
-    public override func finalLayoutAttributesForDisappearingSupplementaryElement(ofKind elementKind: String, at elementIndexPath: IndexPath) -> UICollectionViewLayoutAttributes? {
+    public override func finalLayoutAttributesForDisappearingSupplementaryElement(ofKind elementKind: String,
+                                                                                  at elementIndexPath: IndexPath) -> UICollectionViewLayoutAttributes? {
         var attributes: ChatLayoutAttributes?
 
         let kind = ItemKind(elementKind)
diff --git a/ChatLayout/Classes/Core/Model/ItemModel.swift b/ChatLayout/Classes/Core/Model/ItemModel.swift
@@ -57,7 +57,8 @@ struct ItemModel {
         calculatedOnce = configuration.calculatedSize != nil
     }
 
-    // We are just resetting `calculatedSize` if needed as the actual size will be found in invalidationContext(forPreferredLayoutAttributes:, withOriginalAttributes:)
+    // We are just resetting `calculatedSize` if needed as the actual size will be found in
+    // `invalidationContext(forPreferredLayoutAttributes:, withOriginalAttributes:)`.
     // It is important for the rotation to keep previous frame size.
     mutating func resetSize() {
         guard let calculatedSize else {
diff --git a/ChatLayout/Classes/Core/Model/ItemSize.swift b/ChatLayout/Classes/Core/Model/ItemSize.swift
@@ -16,10 +16,12 @@ import UIKit
 /// Represents desired item size.
 public enum ItemSize: Hashable {
 
-    /// Item size should be fully calculated by the `CollectionViewChatLayout`. Initial estimated size will be taken from `ChatLayoutSettings`.
+    /// Item size should be fully calculated by the `CollectionViewChatLayout`.
+    /// Initial estimated size will be taken from `ChatLayoutSettings`.
     case auto
 
-    /// Item size should be fully calculated by the `CollectionViewChatLayout`. Initial estimated size should be taken from the value provided.
+    /// Item size should be fully calculated by the `CollectionViewChatLayout`.
+    /// Initial estimated size should be taken from the value provided.
     case estimated(CGSize)
 
     /// Item size should be exactly equal to the value provided.
diff --git a/ChatLayout/Classes/Core/Model/StateController.swift b/ChatLayout/Classes/Core/Model/StateController.swift
@@ -396,7 +396,11 @@ final class StateController<Layout: ChatLayoutRepresentation> {
         }
     }
 
-    func update(preferredSize: CGSize, alignment: ChatItemAlignment, for itemPath: ItemPath, kind: ItemKind, at state: ModelState) {
+    func update(preferredSize: CGSize,
+                alignment: ChatItemAlignment,
+                for itemPath: ItemPath,
+                kind: ItemKind,
+                at state: ModelState) {
         guard var item = item(for: itemPath, kind: kind, at: state) else {
             assertionFailure("Item at index path (\(itemPath.section) - \(itemPath.item)) does not exist.")
             return
@@ -840,7 +844,10 @@ final class StateController<Layout: ChatLayoutRepresentation> {
         }
     }
 
-    private func compensateOffsetIfNeeded(for itemPath: ItemPath, kind: ItemKind, action: CompensatingAction, visibleBounds: CGRect? = nil) {
+    private func compensateOffsetIfNeeded(for itemPath: ItemPath,
+                                          kind: ItemKind,
+                                          action: CompensatingAction,
+                                          visibleBounds: CGRect? = nil) {
         guard layoutRepresentation.keepContentOffsetAtBottomOnBatchUpdates else {
             return
         }
@@ -879,7 +886,9 @@ final class StateController<Layout: ChatLayoutRepresentation> {
 
     }
 
-    private func compensateOffsetOfSectionIfNeeded(for sectionIndex: Int, action: CompensatingAction, visibleBounds: CGRect? = nil) {
+    private func compensateOffsetOfSectionIfNeeded(for sectionIndex: Int,
+                                                   action: CompensatingAction,
+                                                   visibleBounds: CGRect? = nil) {
         guard layoutRepresentation.keepContentOffsetAtBottomOnBatchUpdates else {
             return
         }
diff --git a/ChatLayout/Classes/Extras/Extensions/NSLayoutAnchor+Extension.swift b/ChatLayout/Classes/Extras/Extensions/NSLayoutAnchor+Extension.swift
@@ -14,19 +14,25 @@ import Foundation
 import UIKit
 
 extension NSLayoutAnchor {
-    @objc func constraint(equalTo anchor: NSLayoutAnchor<AnchorType>, constant c: CGFloat = 0, priority: UILayoutPriority) -> NSLayoutConstraint {
+    @objc func constraint(equalTo anchor: NSLayoutAnchor<AnchorType>,
+                          constant c: CGFloat = 0,
+                          priority: UILayoutPriority) -> NSLayoutConstraint {
         let constraint = constraint(equalTo: anchor, constant: c)
         constraint.priority = priority
         return constraint
     }
 
-    @objc func constraint(greaterThanOrEqualTo anchor: NSLayoutAnchor<AnchorType>, constant c: CGFloat = 0, priority: UILayoutPriority) -> NSLayoutConstraint {
+    @objc func constraint(greaterThanOrEqualTo anchor: NSLayoutAnchor<AnchorType>,
+                          constant c: CGFloat = 0,
+                          priority: UILayoutPriority) -> NSLayoutConstraint {
         let constraint = constraint(greaterThanOrEqualTo: anchor, constant: c)
         constraint.priority = priority
         return constraint
     }
 
-    @objc func constraint(lessThanOrEqualTo anchor: NSLayoutAnchor<AnchorType>, constant c: CGFloat = 0, priority: UILayoutPriority) -> NSLayoutConstraint {
+    @objc func constraint(lessThanOrEqualTo anchor: NSLayoutAnchor<AnchorType>,
+                          constant c: CGFloat = 0,
+                          priority: UILayoutPriority) -> NSLayoutConstraint {
         let constraint = constraint(lessThanOrEqualTo: anchor, constant: c)
         constraint.priority = priority
         return constraint
diff --git a/ChatLayout/Classes/Extras/Extensions/NSLayoutDimension+Extension.swift b/ChatLayout/Classes/Extras/Extensions/NSLayoutDimension+Extension.swift
@@ -14,37 +14,49 @@ import Foundation
 import UIKit
 
 extension NSLayoutDimension {
-    @objc func constraint(equalTo anchor: NSLayoutDimension, multiplier m: CGFloat = 1, constant c: CGFloat = 0, priority: UILayoutPriority) -> NSLayoutConstraint {
+    @objc func constraint(equalTo anchor: NSLayoutDimension,
+                          multiplier m: CGFloat = 1,
+                          constant c: CGFloat = 0,
+                          priority: UILayoutPriority) -> NSLayoutConstraint {
         let constraint = constraint(equalTo: anchor, multiplier: m, constant: c)
         constraint.priority = priority
         return constraint
     }
 
-    @objc func constraint(greaterThanOrEqualTo anchor: NSLayoutDimension, multiplier m: CGFloat = 1, constant c: CGFloat = 0, priority: UILayoutPriority) -> NSLayoutConstraint {
+    @objc func constraint(greaterThanOrEqualTo anchor: NSLayoutDimension,
+                          multiplier m: CGFloat = 1,
+                          constant c: CGFloat = 0,
+                          priority: UILayoutPriority) -> NSLayoutConstraint {
         let constraint = constraint(greaterThanOrEqualTo: anchor, multiplier: m, constant: c)
         constraint.priority = priority
         return constraint
     }
 
-    @objc func constraint(lessThanOrEqualTo anchor: NSLayoutDimension, multiplier m: CGFloat = 1, constant c: CGFloat = 0, priority: UILayoutPriority) -> NSLayoutConstraint {
+    @objc func constraint(lessThanOrEqualTo anchor: NSLayoutDimension,
+                          multiplier m: CGFloat = 1,
+                          constant c: CGFloat = 0,
+                          priority: UILayoutPriority) -> NSLayoutConstraint {
         let constraint = constraint(lessThanOrEqualTo: anchor, multiplier: m, constant: c)
         constraint.priority = priority
         return constraint
     }
 
-    @objc func constraint(equalToConstant c: CGFloat, priority: UILayoutPriority) -> NSLayoutConstraint {
+    @objc func constraint(equalToConstant c: CGFloat,
+                          priority: UILayoutPriority) -> NSLayoutConstraint {
         let constraint = constraint(equalToConstant: c)
         constraint.priority = priority
         return constraint
     }
 
-    @objc func constraint(greaterThanOrEqualToConstant c: CGFloat, priority: UILayoutPriority) -> NSLayoutConstraint {
+    @objc func constraint(greaterThanOrEqualToConstant c: CGFloat,
+                          priority: UILayoutPriority) -> NSLayoutConstraint {
         let constraint = constraint(greaterThanOrEqualToConstant: c)
         constraint.priority = priority
         return constraint
     }
 
-    @objc func constraint(lessThanOrEqualToConstant c: CGFloat, priority: UILayoutPriority) -> NSLayoutConstraint {
+    @objc func constraint(lessThanOrEqualToConstant c: CGFloat,
+                          priority: UILayoutPriority) -> NSLayoutConstraint {
         let constraint = constraint(lessThanOrEqualToConstant: c)
         constraint.priority = priority
         return constraint
diff --git a/docs/Classes/CollectionViewChatLayout.html b/docs/Classes/CollectionViewChatLayout.html
@@ -154,9 +154,10 @@ <h1>CollectionViewChatLayout</h1>
 
                 </div>
               </div>
-            <p>A collection view layout that can display items in a grid similar to <code>UITableView</code> but aligning them
-to the leading or trailing edge of the <code>UICollectionView</code>. Helps to maintain chat like behavior by keeping
-content offset from the bottom constant. Can deal with autosizing cells and supplementary views.</p>
+            <p>A collection view layout designed to display items in a grid similar to <code>UITableView</code>, while aligning them to the
+leading or trailing edge of the <code>UICollectionView</code>. This layout facilitates chat-like behavior by maintaining
+a constant content offset from the bottom. Additionally, it is capable of handling autosizing cells and
+supplementary views.</p>
 <h3 id='custom-properties' class='heading'>Custom Properties:</h3>
 
 <p><code><a href="../Classes/CollectionViewChatLayout.html#/s:10ChatLayout014CollectionViewaB0C8delegateAA0aB8Delegate_pSgvp">CollectionViewChatLayout.delegate</a></code></p>
diff --git a/docs/Core.html b/docs/Core.html
@@ -168,9 +168,10 @@ <h1>Core</h1>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>A collection view layout that can display items in a grid similar to <code>UITableView</code> but aligning them
-to the leading or trailing edge of the <code>UICollectionView</code>. Helps to maintain chat like behavior by keeping
-content offset from the bottom constant. Can deal with autosizing cells and supplementary views.</p>
+                        <p>A collection view layout designed to display items in a grid similar to <code>UITableView</code>, while aligning them to the
+leading or trailing edge of the <code>UICollectionView</code>. This layout facilitates chat-like behavior by maintaining
+a constant content offset from the bottom. Additionally, it is capable of handling autosizing cells and
+supplementary views.</p>
 <h3 id='custom-properties' class='heading'>Custom Properties:</h3>
 
 <p><code><a href="Classes/CollectionViewChatLayout.html#/s:10ChatLayout014CollectionViewaB0C8delegateAA0aB8Delegate_pSgvp">CollectionViewChatLayout.delegate</a></code></p>
diff --git a/docs/docsets/ChatLayout.docset/Contents/Resources/Documents/Classes/CollectionViewChatLayout.html b/docs/docsets/ChatLayout.docset/Contents/Resources/Documents/Classes/CollectionViewChatLayout.html
@@ -154,9 +154,10 @@ <h1>CollectionViewChatLayout</h1>
 
                 </div>
               </div>
-            <p>A collection view layout that can display items in a grid similar to <code>UITableView</code> but aligning them
-to the leading or trailing edge of the <code>UICollectionView</code>. Helps to maintain chat like behavior by keeping
-content offset from the bottom constant. Can deal with autosizing cells and supplementary views.</p>
+            <p>A collection view layout designed to display items in a grid similar to <code>UITableView</code>, while aligning them to the
+leading or trailing edge of the <code>UICollectionView</code>. This layout facilitates chat-like behavior by maintaining
+a constant content offset from the bottom. Additionally, it is capable of handling autosizing cells and
+supplementary views.</p>
 <h3 id='custom-properties' class='heading'>Custom Properties:</h3>
 
 <p><code><a href="../Classes/CollectionViewChatLayout.html#/s:10ChatLayout014CollectionViewaB0C8delegateAA0aB8Delegate_pSgvp">CollectionViewChatLayout.delegate</a></code></p>
diff --git a/docs/docsets/ChatLayout.docset/Contents/Resources/Documents/Core.html b/docs/docsets/ChatLayout.docset/Contents/Resources/Documents/Core.html
@@ -168,9 +168,10 @@ <h1>Core</h1>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>A collection view layout that can display items in a grid similar to <code>UITableView</code> but aligning them
-to the leading or trailing edge of the <code>UICollectionView</code>. Helps to maintain chat like behavior by keeping
-content offset from the bottom constant. Can deal with autosizing cells and supplementary views.</p>
+                        <p>A collection view layout designed to display items in a grid similar to <code>UITableView</code>, while aligning them to the
+leading or trailing edge of the <code>UICollectionView</code>. This layout facilitates chat-like behavior by maintaining
+a constant content offset from the bottom. Additionally, it is capable of handling autosizing cells and
+supplementary views.</p>
 <h3 id='custom-properties' class='heading'>Custom Properties:</h3>
 
 <p><code><a href="Classes/CollectionViewChatLayout.html#/s:10ChatLayout014CollectionViewaB0C8delegateAA0aB8Delegate_pSgvp">CollectionViewChatLayout.delegate</a></code></p>
diff --git a/docs/docsets/ChatLayout.docset/Contents/Resources/Documents/search.json b/docs/docsets/ChatLayout.docset/Contents/Resources/Documents/search.json
diff --git a/docs/docsets/ChatLayout.tgz b/docs/docsets/ChatLayout.tgz
diff --git a/docs/search.json b/docs/search.json

Original file line number	Diff line number	Diff line change
`@@ -57,7 +57,8 @@ struct ItemModel {`
`57`	`57`	`calculatedOnce = configuration.calculatedSize != nil`
`58`	`58`	`}`
`59`	`59`
`60`		- // We are just resetting `calculatedSize` if needed as the actual size will be found in invalidationContext(forPreferredLayoutAttributes:, withOriginalAttributes:)
	`60`	+ // We are just resetting `calculatedSize` if needed as the actual size will be found in
	`61`	+ // `invalidationContext(forPreferredLayoutAttributes:, withOriginalAttributes:)`.
`61`	`62`	`// It is important for the rotation to keep previous frame size.`
`62`	`63`	`mutating func resetSize() {`
`63`	`64`	`guard let calculatedSize else {`
Original file line number	Diff line number	Diff line change
`@@ -396,7 +396,11 @@ final class StateController<Layout: ChatLayoutRepresentation> {`
`396`	`396`	`}`
`397`	`397`	`}`
`398`	`398`
`399`		`- func update(preferredSize: CGSize, alignment: ChatItemAlignment, for itemPath: ItemPath, kind: ItemKind, at state: ModelState) {`
	`399`	`+ func update(preferredSize: CGSize,`
	`400`	`+ alignment: ChatItemAlignment,`
	`401`	`+ for itemPath: ItemPath,`
	`402`	`+ kind: ItemKind,`
	`403`	`+ at state: ModelState) {`
`400`	`404`	`guard var item = item(for: itemPath, kind: kind, at: state) else {`
`401`	`405`	`assertionFailure("Item at index path (\(itemPath.section) - \(itemPath.item)) does not exist.")`
`402`	`406`	`return`
`@@ -840,7 +844,10 @@ final class StateController<Layout: ChatLayoutRepresentation> {`
`840`	`844`	`}`
`841`	`845`	`}`
`842`	`846`
`843`		`- private func compensateOffsetIfNeeded(for itemPath: ItemPath, kind: ItemKind, action: CompensatingAction, visibleBounds: CGRect? = nil) {`
	`847`	`+ private func compensateOffsetIfNeeded(for itemPath: ItemPath,`
	`848`	`+ kind: ItemKind,`
	`849`	`+ action: CompensatingAction,`
	`850`	`+ visibleBounds: CGRect? = nil) {`
`844`	`851`	`guard layoutRepresentation.keepContentOffsetAtBottomOnBatchUpdates else {`
`845`	`852`	`return`
`846`	`853`	`}`
`@@ -879,7 +886,9 @@ final class StateController<Layout: ChatLayoutRepresentation> {`
`879`	`886`
`880`	`887`	`}`
`881`	`888`
`882`		`- private func compensateOffsetOfSectionIfNeeded(for sectionIndex: Int, action: CompensatingAction, visibleBounds: CGRect? = nil) {`
	`889`	`+ private func compensateOffsetOfSectionIfNeeded(for sectionIndex: Int,`
	`890`	`+ action: CompensatingAction,`
	`891`	`+ visibleBounds: CGRect? = nil) {`
`883`	`892`	`guard layoutRepresentation.keepContentOffsetAtBottomOnBatchUpdates else {`
`884`	`893`	`return`
`885`	`894`	`}`